forked from symfony/symfony
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature symfony#30541 [BrowserKit] Rename Client to Browser (fabpot)
This PR was merged into the 4.3-dev branch. Discussion ---------- [BrowserKit] Rename Client to Browser | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | yes | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | n/a | License | MIT | Doc PR | n/a `Client` is very generic and used in 3 places: BrowserKit, HttpKernel, and FramewrokBundle. Each Client extends another one. So, to make things clearer, I'd like to rename Client to Browser like this: Symfony\Component\BrowerKit\Client -> AbstractBrowser Symfony\Component\HttpKernel\Client -> HttpKernelBrowser Symfony\Bundle\FrameworkBundle\Client -> KernelBrowser The next PR will introduce an `HttpBrowser` based on the new HttpClient component :) Commits ------- dbe4f86 renamed Client to Browser
- Loading branch information
Showing
20 changed files
with
1,201 additions
and
1,131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,196 +11,8 @@ | |
|
|
||
| namespace Symfony\Bundle\FrameworkBundle; | ||
|
|
||
| use Symfony\Component\BrowserKit\CookieJar; | ||
| use Symfony\Component\BrowserKit\History; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
| use Symfony\Component\HttpKernel\Client as BaseClient; | ||
| use Symfony\Component\HttpKernel\KernelInterface; | ||
| use Symfony\Component\HttpKernel\Profiler\Profile as HttpProfile; | ||
| @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.3, use "%s" instead.', Client::class, KernelBrowser::class), E_USER_DEPRECATED); | ||
|
|
||
| /** | ||
| * Client simulates a browser and makes requests to a Kernel object. | ||
| * | ||
| * @author Fabien Potencier <[email protected]> | ||
| */ | ||
| class Client extends BaseClient | ||
| class Client extends KernelBrowser | ||
| { | ||
| private $hasPerformedRequest = false; | ||
| private $profiler = false; | ||
| private $reboot = true; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function __construct(KernelInterface $kernel, array $server = [], History $history = null, CookieJar $cookieJar = null) | ||
| { | ||
| parent::__construct($kernel, $server, $history, $cookieJar); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the container. | ||
| * | ||
| * @return ContainerInterface|null Returns null when the Kernel has been shutdown or not started yet | ||
| */ | ||
| public function getContainer() | ||
| { | ||
| return $this->kernel->getContainer(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the kernel. | ||
| * | ||
| * @return KernelInterface | ||
| */ | ||
| public function getKernel() | ||
| { | ||
| return $this->kernel; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the profile associated with the current Response. | ||
| * | ||
| * @return HttpProfile|false A Profile instance | ||
| */ | ||
| public function getProfile() | ||
| { | ||
| if (!$this->kernel->getContainer()->has('profiler')) { | ||
| return false; | ||
| } | ||
|
|
||
| return $this->kernel->getContainer()->get('profiler')->loadProfileFromResponse($this->response); | ||
| } | ||
|
|
||
| /** | ||
| * Enables the profiler for the very next request. | ||
| * | ||
| * If the profiler is not enabled, the call to this method does nothing. | ||
| */ | ||
| public function enableProfiler() | ||
| { | ||
| if ($this->kernel->getContainer()->has('profiler')) { | ||
| $this->profiler = true; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Disables kernel reboot between requests. | ||
| * | ||
| * By default, the Client reboots the Kernel for each request. This method | ||
| * allows to keep the same kernel across requests. | ||
| */ | ||
| public function disableReboot() | ||
| { | ||
| $this->reboot = false; | ||
| } | ||
|
|
||
| /** | ||
| * Enables kernel reboot between requests. | ||
| */ | ||
| public function enableReboot() | ||
| { | ||
| $this->reboot = true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @param Request $request A Request instance | ||
| * | ||
| * @return Response A Response instance | ||
| */ | ||
| protected function doRequest($request) | ||
| { | ||
| // avoid shutting down the Kernel if no request has been performed yet | ||
| // WebTestCase::createClient() boots the Kernel but do not handle a request | ||
| if ($this->hasPerformedRequest && $this->reboot) { | ||
| $this->kernel->shutdown(); | ||
| } else { | ||
| $this->hasPerformedRequest = true; | ||
| } | ||
|
|
||
| if ($this->profiler) { | ||
| $this->profiler = false; | ||
|
|
||
| $this->kernel->boot(); | ||
| $this->kernel->getContainer()->get('profiler')->enable(); | ||
| } | ||
|
|
||
| return parent::doRequest($request); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @param Request $request A Request instance | ||
| * | ||
| * @return Response A Response instance | ||
| */ | ||
| protected function doRequestInProcess($request) | ||
| { | ||
| $response = parent::doRequestInProcess($request); | ||
|
|
||
| $this->profiler = false; | ||
|
|
||
| return $response; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the script to execute when the request must be insulated. | ||
| * | ||
| * It assumes that the autoloader is named 'autoload.php' and that it is | ||
| * stored in the same directory as the kernel (this is the case for the | ||
| * Symfony Standard Edition). If this is not your case, create your own | ||
| * client and override this method. | ||
| * | ||
| * @param Request $request A Request instance | ||
| * | ||
| * @return string The script content | ||
| */ | ||
| protected function getScript($request) | ||
| { | ||
| $kernel = var_export(serialize($this->kernel), true); | ||
| $request = var_export(serialize($request), true); | ||
| $errorReporting = error_reporting(); | ||
|
|
||
| $requires = ''; | ||
| foreach (get_declared_classes() as $class) { | ||
| if (0 === strpos($class, 'ComposerAutoloaderInit')) { | ||
| $r = new \ReflectionClass($class); | ||
| $file = \dirname(\dirname($r->getFileName())).'/autoload.php'; | ||
| if (file_exists($file)) { | ||
| $requires .= 'require_once '.var_export($file, true).";\n"; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (!$requires) { | ||
| throw new \RuntimeException('Composer autoloader not found.'); | ||
| } | ||
|
|
||
| $requires .= 'require_once '.var_export((new \ReflectionObject($this->kernel))->getFileName(), true).";\n"; | ||
|
|
||
| $profilerCode = ''; | ||
| if ($this->profiler) { | ||
| $profilerCode = '$kernel->getContainer()->get(\'profiler\')->enable();'; | ||
| } | ||
|
|
||
| $code = <<<EOF | ||
| <?php | ||
| error_reporting($errorReporting); | ||
| $requires | ||
| \$kernel = unserialize($kernel); | ||
| \$kernel->boot(); | ||
| $profilerCode | ||
| \$request = unserialize($request); | ||
| EOF; | ||
|
|
||
| return $code.$this->getHandleScript(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.