minor #12774 Docblock Fixes (GrahamCampbell)

This PR was merged into the 2.3 branch.

Discussion
----------

Docblock Fixes

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

##### This pull request fixes the docblock alignment as requested in #12760.

It was also necessary for me to ensure the `@return` annotations were correctly separated in order to accurately align the `@param` annotations.

Commits
-------

443307e Docblock fixes
This commit is contained in:
Fabien Potencier 2014-11-30 17:59:09 +01:00
commit c68ff54aac
356 changed files with 1546 additions and 1467 deletions

View File

@ -40,10 +40,11 @@ class ContainerAwareEventManager extends EventManager
/**
* Dispatches an event to all registered listeners.
*
* @param string $eventName The name of the event to dispatch. The name of the event is
* the name of the method that is invoked on listeners.
* @param string $eventName The name of the event to dispatch. The name of the event is
* the name of the method that is invoked on listeners.
* @param EventArgs $eventArgs The event arguments to pass to the event handlers/listeners.
* If not supplied, the single empty EventArgs instance is used.
*
* @return bool
*/
public function dispatchEvent($eventName, EventArgs $eventArgs = null)
@ -81,7 +82,7 @@ class ContainerAwareEventManager extends EventManager
*
* @param string $event
*
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
* @return bool TRUE if the specified event has any listeners, FALSE otherwise.
*/
public function hasListeners($event)
{

View File

@ -35,7 +35,7 @@ class RegisterEventListenersAndSubscribersPass implements CompilerPassInterface
* @param string $connections Parameter ID for connections
* @param string $managerTemplate sprintf() template for generating the event
* manager's service ID for a connection name
* @param string $tagPrefix Tag prefix for listeners and subscribers
* @param string $tagPrefix Tag prefix for listeners and subscribers
*/
public function __construct($connections, $managerTemplate, $tagPrefix)
{

View File

@ -118,7 +118,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* @return string a service definition name
*
* @throws ParameterNotFoundException if non of the managerParameters has a
* non-empty value.
* non-empty value.
*/
protected function getChainDriverServiceName(ContainerBuilder $container)
{
@ -138,7 +138,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* Create the service definition for the metadata driver.
*
* @param ContainerBuilder $container passed on in case an extending class
* needs access to the container.
* needs access to the container.
*
* @return Definition|Reference the metadata driver to add to all chain drivers
*/
@ -156,7 +156,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
*
* @param ContainerBuilder $container
*
* @return bool whether this compiler pass really should register the mappings
* @return bool whether this compiler pass really should register the mappings
*/
protected function enabled(ContainerBuilder $container)
{

View File

@ -365,8 +365,8 @@ class EntityChoiceList extends ObjectChoiceList
*
* @param mixed $entity The choice to create an index for
*
* @return int|string A unique index containing only ASCII letters,
* digits and underscores.
* @return int|string A unique index containing only ASCII letters,
* digits and underscores.
*/
protected function createIndex($entity)
{
@ -386,7 +386,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @param mixed $entity The choice to create a value for
*
* @return int|string A unique value without character limitations.
* @return int|string A unique value without character limitations.
*/
protected function createValue($entity)
{
@ -444,7 +444,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @param object $entity The entity for which to get the identifier
*
* @return array The identifier values
* @return array The identifier values
*
* @throws RuntimeException If the entity does not exist in Doctrine's identity map
*/

View File

@ -31,7 +31,7 @@ interface EntityLoaderInterface
* @param string $identifier The identifier field of the object. This method
* is not applicable for fields with multiple
* identifiers.
* @param array $values The values of the identifiers.
* @param array $values The values of the identifiers.
*
* @return array The entities.
*/

View File

@ -54,7 +54,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
*
* @param mixed $array An array of entities
*
* @return Collection A collection of entities
* @return Collection A collection of entities
*/
public function reverseTransform($array)
{

View File

@ -22,6 +22,7 @@ class EntityType extends DoctrineType
* @param ObjectManager $manager
* @param mixed $queryBuilder
* @param string $class
*
* @return ORMQueryBuilderLoader
*/
public function getLoader(ObjectManager $manager, $queryBuilder, $class)

View File

@ -60,8 +60,8 @@ class WebProcessorTest extends \PHPUnit_Framework_TestCase
}
/**
* @param int $level
* @param string $message
* @param int $level
* @param string $message
*
* @return array Record
*/

View File

@ -70,12 +70,12 @@ class ModelChoiceList extends ObjectChoiceList
*
* @see \Symfony\Bridge\Propel1\Form\Type\ModelType How to use the preferred choices.
*
* @param string $class The FQCN of the model class to be loaded.
* @param string $labelPath A property path pointing to the property used for the choice labels.
* @param array $choices An optional array to use, rather than fetching the models.
* @param ModelCriteria $queryObject The query to use retrieving model data from database.
* @param string $groupPath A property path pointing to the property used to group the choices.
* @param array|ModelCriteria $preferred The preferred items of this choice.
* @param string $class The FQCN of the model class to be loaded.
* @param string $labelPath A property path pointing to the property used for the choice labels.
* @param array $choices An optional array to use, rather than fetching the models.
* @param ModelCriteria $queryObject The query to use retrieving model data from database.
* @param string $groupPath A property path pointing to the property used to group the choices.
* @param array|ModelCriteria $preferred The preferred items of this choice.
* Either an array if $choices is given,
* or a ModelCriteria to be merged with the $queryObject.
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths.
@ -358,8 +358,8 @@ class ModelChoiceList extends ObjectChoiceList
*
* @param mixed $model The choice to create an index for
*
* @return int|string A unique index containing only ASCII letters,
* digits and underscores.
* @return int|string A unique index containing only ASCII letters,
* digits and underscores.
*/
protected function createIndex($model)
{
@ -379,7 +379,7 @@ class ModelChoiceList extends ObjectChoiceList
*
* @param mixed $model The choice to create a value for
*
* @return int|string A unique value without character limitations.
* @return int|string A unique value without character limitations.
*/
protected function createValue($model)
{

View File

@ -47,8 +47,8 @@ class PropelUserProvider implements UserProviderInterface
/**
* Default constructor
*
* @param string $class The User model class.
* @param string|null $property The property to use to retrieve a user.
* @param string $class The User model class.
* @param string|null $property The property to use to retrieve a user.
*/
public function __construct($class, $property = null)
{

View File

@ -39,7 +39,7 @@ class LazyServiceProjectServiceContainer extends Container
* This service is shared.
* This method always returns the same instance of the service.
*
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy
*
* @return stdClass A stdClass instance.
*/
@ -97,7 +97,7 @@ class stdClass_c1d194250ee2e2b7d2eab8b8212368a8 extends \stdClass implements \Pr
/**
* @param string $name
* @param mixed $value
* @param mixed $value
*/
public function __set($name, $value)
{

View File

@ -152,9 +152,9 @@ class CodeExtension extends \Twig_Extension
/**
* Formats a file path.
*
* @param string $file An absolute file path
* @param int $line The line number
* @param string $text Use this text for the link rather than the file path
* @param string $file An absolute file path
* @param int $line The line number
* @param string $text Use this text for the link rather than the file path
*
* @return string
*/
@ -187,8 +187,8 @@ class CodeExtension extends \Twig_Extension
/**
* Returns the link for a given file/line pair.
*
* @param string $file An absolute file path
* @param int $line The line number
* @param string $file An absolute file path
* @param int $line The line number
*
* @return string A link of false
*/

View File

@ -137,7 +137,7 @@ class FormExtension extends \Twig_Extension
* @param ChoiceView $choice The choice to check.
* @param string|array $selectedValue The selected value to compare.
*
* @return bool Whether the choice is selected.
* @return bool Whether the choice is selected.
*
* @see ChoiceView::isSelected()
*/

View File

@ -45,8 +45,8 @@ class HttpKernelExtension extends \Twig_Extension
/**
* Renders a fragment.
*
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
* @param array $options An array of options
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
* @param array $options An array of options
*
* @return string The fragment content
*

View File

@ -74,7 +74,7 @@ class TwigRendererEngine extends AbstractRendererEngine implements TwigRendererE
* @param FormView $view The form view for finding the applying themes.
* @param string $blockName The name of the block to load.
*
* @return bool True if the resource could be loaded, false otherwise.
* @return bool True if the resource could be loaded, false otherwise.
*/
protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName)
{

View File

@ -71,7 +71,7 @@ class TwigEngine implements EngineInterface, StreamingEngineInterface
*
* @param mixed $name A template name
*
* @return bool true if the template exists, false otherwise
* @return bool true if the template exists, false otherwise
*/
public function exists($name)
{
@ -99,7 +99,7 @@ class TwigEngine implements EngineInterface, StreamingEngineInterface
*
* @param string $name A template name
*
* @return bool True if this class supports the given resource, false otherwise
* @return bool True if this class supports the given resource, false otherwise
*/
public function supports($name)
{

View File

@ -49,7 +49,7 @@ class RouterCacheWarmer implements CacheWarmerInterface
/**
* Checks whether this warmer is optional or not.
*
* @return bool always true
* @return bool always true
*/
public function isOptional()
{

View File

@ -55,7 +55,7 @@ class TemplatePathsCacheWarmer extends CacheWarmer
/**
* Checks whether this warmer is optional or not.
*
* @return bool always true
* @return bool always true
*/
public function isOptional()
{

View File

@ -63,7 +63,7 @@ class Application extends BaseApplication
* @param InputInterface $input An Input instance
* @param OutputInterface $output An Output instance
*
* @return int 0 if everything went fine, or an error code
* @return int 0 if everything went fine, or an error code
*/
public function doRun(InputInterface $input, OutputInterface $output)
{

View File

@ -36,9 +36,9 @@ class Controller extends ContainerAware
/**
* Generates a URL from the given parameters.
*
* @param string $route The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
* @param string $route The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
*
* @return string The generated URL
*
@ -69,8 +69,8 @@ class Controller extends ContainerAware
/**
* Returns a RedirectResponse to the given URL.
*
* @param string $url The URL to redirect to
* @param int $status The status code to use for the Response
* @param string $url The URL to redirect to
* @param int $status The status code to use for the Response
*
* @return RedirectResponse
*/
@ -139,7 +139,7 @@ class Controller extends ContainerAware
*
* throw $this->createNotFoundException('Page not found!');
*
* @param string $message A message
* @param string $message A message
* @param \Exception $previous The previous exception
*
* @return NotFoundHttpException
@ -233,7 +233,7 @@ class Controller extends ContainerAware
*
* @param string $id The service id
*
* @return bool true if the service id is defined, false otherwise
* @return bool true if the service id is defined, false otherwise
*/
public function has($id)
{

View File

@ -48,7 +48,7 @@ class ControllerResolver extends BaseControllerResolver
*
* @return mixed A PHP callable
*
* @throws \LogicException When the name could not be parsed
* @throws \LogicException When the name could not be parsed
* @throws \InvalidArgumentException When the controller class does not exist
*/
protected function createController($controller)

View File

@ -34,10 +34,10 @@ class RedirectController extends ContainerAware
* In case the route name is empty, the status code will be 404 when permanent is false
* and 410 otherwise.
*
* @param Request $request The request instance
* @param string $route The route name to redirect to
* @param bool $permanent Whether the redirection is permanent
* @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
* @param Request $request The request instance
* @param string $route The route name to redirect to
* @param bool $permanent Whether the redirection is permanent
* @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
*
* @return Response A Response instance
*
@ -70,12 +70,12 @@ class RedirectController extends ContainerAware
* In case the path is empty, the status code will be 404 when permanent is false
* and 410 otherwise.
*
* @param Request $request The request instance
* @param string $path The absolute path or URL to redirect to
* @param bool $permanent Whether the redirect is permanent or not
* @param string|null $scheme The URL scheme (null to keep the current one)
* @param int|null $httpPort The HTTP port (null to keep the current one for the same scheme or the configured port in the container)
* @param int|null $httpsPort The HTTPS port (null to keep the current one for the same scheme or the configured port in the container)
* @param Request $request The request instance
* @param string $path The absolute path or URL to redirect to
* @param bool $permanent Whether the redirect is permanent or not
* @param string|null $scheme The URL scheme (null to keep the current one)
* @param int|null $httpPort The HTTP port (null to keep the current one for the same scheme or the configured port in the container)
* @param int|null $httpsPort The HTTPS port (null to keep the current one for the same scheme or the configured port in the container)
*
* @return Response A Response instance
*

View File

@ -24,10 +24,10 @@ class TemplateController extends ContainerAware
/**
* Renders a template.
*
* @param string $template The template name
* @param int|null $maxAge Max age for client caching
* @param int|null $sharedAge Max age for shared (proxy) caching
* @param bool|null $private Whether or not caching should apply for client caches only
* @param string $template The template name
* @param int|null $maxAge Max age for client caching
* @param int|null $sharedAge Max age for shared (proxy) caching
* @param bool|null $private Whether or not caching should apply for client caches only
*
* @return Response A Response instance
*/

View File

@ -108,7 +108,7 @@ class GlobalVariables
/**
* Returns the current app debug mode.
*
* @return bool The current debug mode
* @return bool The current debug mode
*/
public function getDebug()
{

View File

@ -146,9 +146,9 @@ class CodeHelper extends Helper
/**
* Formats a file path.
*
* @param string $file An absolute file path
* @param int $line The line number
* @param string $text Use this text for the link rather than the file path
* @param string $file An absolute file path
* @param int $line The line number
* @param string $text Use this text for the link rather than the file path
*
* @return string
*/
@ -181,8 +181,8 @@ class CodeHelper extends Helper
/**
* Returns the link for a given file/line pair.
*
* @param string $file An absolute file path
* @param int $line The line number
* @param string $file An absolute file path
* @param int $line The line number
*
* @return string A link of false
*/

View File

@ -36,9 +36,9 @@ class RouterHelper extends Helper
/**
* Generates a URL from the given parameters.
*
* @param string $name The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
* @param string $name The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
*
* @return string The generated URL
*

View File

@ -40,7 +40,7 @@ class FilesystemLoader implements LoaderInterface
*
* @param TemplateReferenceInterface $template A template
*
* @return FileStorage|bool false if the template cannot be loaded, a Storage instance otherwise
* @return FileStorage|bool false if the template cannot be loaded, a Storage instance otherwise
*/
public function load(TemplateReferenceInterface $template)
{

View File

@ -28,11 +28,11 @@ class TimedPhpEngine extends PhpEngine
/**
* Constructor.
*
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param ContainerInterface $container A ContainerInterface instance
* @param LoaderInterface $loader A LoaderInterface instance
* @param Stopwatch $stopwatch A Stopwatch instance
* @param GlobalVariables $globals A GlobalVariables instance
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param ContainerInterface $container A ContainerInterface instance
* @param LoaderInterface $loader A LoaderInterface instance
* @param Stopwatch $stopwatch A Stopwatch instance
* @param GlobalVariables $globals A GlobalVariables instance
*/
public function __construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, Stopwatch $stopwatch, GlobalVariables $globals = null)
{

View File

@ -65,7 +65,7 @@ class SecurityDataCollector extends DataCollector
/**
* Checks if security is enabled.
*
* @return bool true if security is enabled, false otherwise
* @return bool true if security is enabled, false otherwise
*/
public function isEnabled()
{
@ -95,7 +95,7 @@ class SecurityDataCollector extends DataCollector
/**
* Checks if the user is authenticated or not.
*
* @return bool true if the user is authenticated, false otherwise
* @return bool true if the user is authenticated, false otherwise
*/
public function isAuthenticated()
{

View File

@ -146,7 +146,7 @@ abstract class AbstractFactory implements SecurityFactoryInterface
*
* @param array $config
*
* @return bool Whether a possibly configured RememberMeServices should be set for this listener
* @return bool Whether a possibly configured RememberMeServices should be set for this listener
*/
protected function isRememberMeAware($config)
{

View File

@ -81,8 +81,8 @@ class LogoutUrlHelper extends Helper
/**
* Generates the logout URL for the firewall.
*
* @param string $key The firewall key
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
* @param string $key The firewall key
* @param bool|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
*
* @return string The logout URL
*

View File

@ -47,6 +47,7 @@ class LogoutUrlExtension extends \Twig_Extension
* Generate the relative logout URL for the firewall.
*
* @param string $key The firewall key
*
* @return string The relative logout URL
*/
public function getLogoutPath($key)
@ -58,6 +59,7 @@ class LogoutUrlExtension extends \Twig_Extension
* Generate the absolute logout URL for the firewall.
*
* @param string $key The firewall key
*
* @return string The absolute logout URL
*/
public function getLogoutUrl($key)

View File

@ -69,7 +69,7 @@ class TemplateCacheCacheWarmer implements CacheWarmerInterface
/**
* Checks whether this warmer is optional or not.
*
* @return bool always true
* @return bool always true
*/
public function isOptional()
{

View File

@ -64,7 +64,7 @@ class ExceptionController
}
/**
* @param int $startObLevel
* @param int $startObLevel
*
* @return string
*/
@ -86,7 +86,7 @@ class ExceptionController
/**
* @param Request $request
* @param string $format
* @param int $code An HTTP response status code
* @param int $code An HTTP response status code
* @param bool $debug
*
* @return TemplateReferenceInterface

View File

@ -155,8 +155,8 @@ class ProfilerController
/**
* Renders the Web Debug Toolbar.
*
* @param Request $request The current HTTP Request
* @param string $token The profiler token
* @param Request $request The current HTTP Request
* @param string $token The profiler token
*
* @return Response A Response instance
*

View File

@ -115,7 +115,7 @@
/**
* Query an element with a CSS selector.
*
* @param string selector a CSS-selector-compatible query string.
* @param string selector a CSS-selector-compatible query string.
*
* @return DOMElement|null
*/

View File

@ -70,7 +70,7 @@ abstract class Client
/**
* Sets whether to automatically follow redirects or not.
*
* @param bool $followRedirect Whether to follow redirects
* @param bool $followRedirect Whether to follow redirects
*
* @api
*/
@ -82,7 +82,7 @@ abstract class Client
/**
* Sets the maximum number of requests that crawler can follow.
*
* @param int $maxRedirects
* @param int $maxRedirects
*/
public function setMaxRedirects($maxRedirects)
{
@ -93,7 +93,7 @@ abstract class Client
/**
* Sets the insulated flag.
*
* @param bool $insulated Whether to insulate the requests or not
* @param bool $insulated Whether to insulate the requests or not
*
* @throws \RuntimeException When Symfony Process Component is not installed
*
@ -281,13 +281,13 @@ abstract class Client
/**
* Calls a URI.
*
* @param string $method The request method
* @param string $uri The URI to fetch
* @param array $parameters The Request parameters
* @param array $files The files
* @param array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
* @param string $content The raw body data
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
* @param string $method The request method
* @param string $uri The URI to fetch
* @param array $parameters The Request parameters
* @param array $files The files
* @param array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
* @param string $content The raw body data
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Crawler
*

View File

@ -48,14 +48,14 @@ class Cookie
/**
* Sets a cookie.
*
* @param string $name The cookie name
* @param string $value The value of the cookie
* @param string $expires The time the cookie expires
* @param string $path The path on the server in which the cookie will be available on
* @param string $domain The domain that the cookie is available
* @param bool $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
* @param bool $httponly The cookie httponly flag
* @param bool $encodedValue Whether the value is encoded or not
* @param string $name The cookie name
* @param string $value The value of the cookie
* @param string $expires The time the cookie expires
* @param string $path The path on the server in which the cookie will be available on
* @param string $domain The domain that the cookie is available
* @param bool $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
* @param bool $httponly The cookie httponly flag
* @param bool $encodedValue Whether the value is encoded or not
*
* @api
*/
@ -297,7 +297,7 @@ class Cookie
/**
* Returns the secure flag of the cookie.
*
* @return bool The cookie secure flag
* @return bool The cookie secure flag
*
* @api
*/
@ -309,7 +309,7 @@ class Cookie
/**
* Returns the httponly flag of the cookie.
*
* @return bool The cookie httponly flag
* @return bool The cookie httponly flag
*
* @api
*/
@ -321,7 +321,7 @@ class Cookie
/**
* Returns true if the cookie has expired.
*
* @return bool true if the cookie has expired, false otherwise
* @return bool true if the cookie has expired, false otherwise
*
* @api
*/

View File

@ -198,8 +198,8 @@ class CookieJar
/**
* Returns not yet expired cookie values for the given URI.
*
* @param string $uri A URI
* @param bool $returnsRawValue Returns raw value or urldecoded value
* @param string $uri A URI
* @param bool $returnsRawValue Returns raw value or urldecoded value
*
* @return array An array of cookie values
*/

View File

@ -53,7 +53,7 @@ class History
/**
* Returns true if the history is empty.
*
* @return bool true if the history is empty, false otherwise
* @return bool true if the history is empty, false otherwise
*/
public function isEmpty()
{

View File

@ -30,9 +30,9 @@ class Response
* The headers array is a set of key/value pairs. If a header is present multiple times
* then the value is an array of all the values.
*
* @param string $content The content of the response
* @param int $status The response status code
* @param array $headers An array of headers
* @param string $content The content of the response
* @param int $status The response status code
* @param array $headers An array of headers
*
* @api
*/
@ -92,7 +92,7 @@ class Response
/**
* Gets the response status code.
*
* @return int The response status code
* @return int The response status code
*
* @api
*/
@ -116,8 +116,8 @@ class Response
/**
* Gets a response header.
*
* @param string $header The header name
* @param bool $first Whether to return the first value or all header values
* @param string $header The header name
* @param bool $first Whether to return the first value or all header values
*
* @return string|array The first header value if $first is true, an array of values otherwise
*/

View File

@ -54,8 +54,8 @@ class ApcClassLoader
/**
* Constructor.
*
* @param string $prefix The APC namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
* @param string $prefix The APC namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
*
* @throws \RuntimeException
* @throws \InvalidArgumentException
@ -79,7 +79,7 @@ class ApcClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{
@ -99,7 +99,7 @@ class ApcClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*/
public function loadClass($class)
{

View File

@ -25,12 +25,12 @@ class ClassCollectionLoader
/**
* Loads a list of classes and caches them in one big file.
*
* @param array $classes An array of classes to load
* @param string $cacheDir A cache directory
* @param string $name The cache name prefix
* @param bool $autoReload Whether to flush the cache when the cache is stale or not
* @param bool $adaptive Whether to remove already declared classes or not
* @param string $extension File extension of the resulting file
* @param array $classes An array of classes to load
* @param string $cacheDir A cache directory
* @param string $name The cache name prefix
* @param bool $autoReload Whether to flush the cache when the cache is stale or not
* @param bool $adaptive Whether to remove already declared classes or not
* @param string $extension File extension of the resulting file
*
* @throws \InvalidArgumentException When class can't be loaded
*/
@ -335,10 +335,10 @@ class ClassCollectionLoader
* This function does not check for circular dependencies as it should never
* occur with PHP traits.
*
* @param array $tree The dependency tree
* @param \ReflectionClass $node The node
* @param \ArrayObject $resolved An array of already resolved dependencies
* @param \ArrayObject $unresolved An array of dependencies to be resolved
* @param array $tree The dependency tree
* @param \ReflectionClass $node The node
* @param \ArrayObject $resolved An array of already resolved dependencies
* @param \ArrayObject $unresolved An array of dependencies to be resolved
*
* @return \ArrayObject The dependencies for the given node
*

View File

@ -103,7 +103,7 @@ class ClassLoader
/**
* Turns on searching the include for class files.
*
* @param bool $useIncludePath
* @param bool $useIncludePath
*/
public function setUseIncludePath($useIncludePath)
{
@ -124,7 +124,7 @@ class ClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{
@ -144,7 +144,7 @@ class ClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*/
public function loadClass($class)
{

View File

@ -86,7 +86,7 @@ class DebugClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*
* @throws \RuntimeException
*/

View File

@ -33,7 +33,7 @@ class MapClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{

View File

@ -70,7 +70,7 @@ class UniversalClassLoader
* Turns on searching the include for class files. Allows easy loading
* of installed PEAR packages
*
* @param bool $useIncludePath
* @param bool $useIncludePath
*/
public function useIncludePath($useIncludePath)
{
@ -229,7 +229,7 @@ class UniversalClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*
* @api
*/
@ -243,7 +243,7 @@ class UniversalClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*/
public function loadClass($class)
{

View File

@ -53,8 +53,8 @@ class WinCacheClassLoader
/**
* Constructor.
*
* @param string $prefix The WinCache namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
* @param string $prefix The WinCache namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
*
* @throws \RuntimeException
* @throws \InvalidArgumentException
@ -76,7 +76,7 @@ class WinCacheClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{
@ -96,7 +96,7 @@ class WinCacheClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*/
public function loadClass($class)
{

View File

@ -52,8 +52,8 @@ class XcacheClassLoader
/**
* Constructor.
*
* @param string $prefix The XCache namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
* @param string $prefix The XCache namespace prefix to use.
* @param object $decorated A class loader object that implements the findFile() method.
*
* @throws \RuntimeException
* @throws \InvalidArgumentException
@ -77,7 +77,7 @@ class XcacheClassLoader
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{
@ -97,7 +97,7 @@ class XcacheClassLoader
*
* @param string $class The name of the class
*
* @return bool|null True, if loaded
* @return bool|null True, if loaded
*/
public function loadClass($class)
{

View File

@ -31,8 +31,8 @@ class ConfigCache
/**
* Constructor.
*
* @param string $file The absolute cache path
* @param bool $debug Whether debugging is enabled or not
* @param string $file The absolute cache path
* @param bool $debug Whether debugging is enabled or not
*/
public function __construct($file, $debug)
{
@ -56,7 +56,7 @@ class ConfigCache
* This method always returns true when debug is off and the
* cache file exists.
*
* @return bool true if the cache is fresh, false otherwise
* @return bool true if the cache is fresh, false otherwise
*/
public function isFresh()
{

View File

@ -109,7 +109,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
* Sets whether to add default values for this array if it has not been
* defined in any of the configuration files.
*
* @param bool $boolean
* @param bool $boolean
*/
public function setAddIfNotSet($boolean)
{
@ -119,7 +119,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/**
* Sets whether false is allowed as value indicating that the array should be unset.
*
* @param bool $allow
* @param bool $allow
*/
public function setAllowFalse($allow)
{
@ -129,7 +129,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/**
* Sets whether new keys can be defined in subsequent configurations.
*
* @param bool $allow
* @param bool $allow
*/
public function setAllowNewKeys($allow)
{
@ -139,7 +139,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/**
* Sets if deep merging should occur.
*
* @param bool $boolean
* @param bool $boolean
*/
public function setPerformDeepMerging($boolean)
{
@ -149,7 +149,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/**
* Whether extra keys should just be ignore without an exception.
*
* @param bool $boolean To allow extra keys
* @param bool $boolean To allow extra keys
*/
public function setIgnoreExtraKeys($boolean)
{

View File

@ -138,7 +138,7 @@ abstract class BaseNode implements NodeInterface
/**
* Set this node as required.
*
* @param bool $boolean Required node
* @param bool $boolean Required node
*/
public function setRequired($boolean)
{
@ -148,7 +148,7 @@ abstract class BaseNode implements NodeInterface
/**
* Sets if this node can be overridden.
*
* @param bool $allow
* @param bool $allow
*/
public function setAllowOverwrite($allow)
{

View File

@ -105,7 +105,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Adds children with a default value when none are defined.
*
* @param int|string|array|null $children The number of children|The child name|The children names to be added
* @param int|string|array|null $children The number of children|The child name|The children names to be added
*
* This method is applicable to prototype nodes only.
*
@ -184,8 +184,8 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
*
* This method is applicable to prototype nodes only.
*
* @param string $name The name of the key
* @param bool $removeKeyItem Whether or not the key item should be removed.
* @param string $name The name of the key
* @param bool $removeKeyItem Whether or not the key item should be removed.
*
* @return ArrayNodeDefinition
*/
@ -200,7 +200,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Sets whether the node can be unset.
*
* @param bool $allow
* @param bool $allow
*
* @return ArrayNodeDefinition
*/
@ -303,7 +303,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Sets key normalization.
*
* @param bool $bool Whether to enable key normalization
* @param bool $bool Whether to enable key normalization
*
* @return ArrayNodeDefinition
*/

View File

@ -37,7 +37,7 @@ class MergeBuilder
/**
* Sets whether the node can be unset.
*
* @param bool $allow
* @param bool $allow
*
* @return MergeBuilder
*/
@ -51,7 +51,7 @@ class MergeBuilder
/**
* Sets whether the node can be overwritten.
*
* @param bool $deny Whether the overwriting is forbidden or not
* @param bool $deny Whether the overwriting is forbidden or not
*
* @return MergeBuilder
*/

View File

@ -96,7 +96,7 @@ abstract class NodeDefinition implements NodeParentInterface
* Sets an attribute on the node.
*
* @param string $key
* @param mixed $value
* @param mixed $value
*
* @return NodeDefinition
*/
@ -120,7 +120,7 @@ abstract class NodeDefinition implements NodeParentInterface
/**
* Creates the node.
*
* @param bool $forceRootNode Whether to force this node as the root node
* @param bool $forceRootNode Whether to force this node as the root node
*
* @return NodeInterface
*/
@ -282,7 +282,7 @@ abstract class NodeDefinition implements NodeParentInterface
/**
* Sets whether the node can be overwritten.
*
* @param bool $deny Whether the overwriting is forbidden or not
* @param bool $deny Whether the overwriting is forbidden or not
*
* @return NodeDefinition
*/

View File

@ -38,21 +38,21 @@ interface NodeInterface
/**
* Returns true when the node is required.
*
* @return bool If the node is required
* @return bool If the node is required
*/
public function isRequired();
/**
* Returns true when the node has a default value.
*
* @return bool If the node has a default value
* @return bool If the node has a default value
*/
public function hasDefaultValue();
/**
* Returns the default value of the node.
*
* @return mixed The default value
* @return mixed The default value
* @throws \RuntimeException if the node has no default value
*/
public function getDefaultValue();

View File

@ -48,7 +48,7 @@ class PrototypedArrayNode extends ArrayNode
* Sets the minimum number of elements that a prototype based node must
* contain. By default this is zero, meaning no elements.
*
* @param int $number
* @param int $number
*/
public function setMinNumberOfElements($number)
{
@ -76,8 +76,8 @@ class PrototypedArrayNode extends ArrayNode
* If you'd like "'id' => 'my_name'" to still be present in the resulting
* array, then you can set the second argument of this method to false.
*
* @param string $attribute The name of the attribute which value is to be used as a key
* @param bool $remove Whether or not to remove the key
* @param string $attribute The name of the attribute which value is to be used as a key
* @param bool $remove Whether or not to remove the key
*/
public function setKeyAttribute($attribute, $remove = true)
{
@ -124,7 +124,7 @@ class PrototypedArrayNode extends ArrayNode
/**
* Adds default children when none are set.
*
* @param int|string|array|null $children The number of children|The child name|The children names to be added
* @param int|string|array|null $children The number of children|The child name|The children names to be added
*/
public function setAddChildrenIfNoneSet($children = array('defaults'))
{

View File

@ -55,7 +55,7 @@ class VariableNode extends BaseNode implements PrototypeNodeInterface
/**
* Sets if this node is allowed to have an empty value.
*
* @param bool $boolean True if this entity will accept empty values.
* @param bool $boolean True if this entity will accept empty values.
*/
public function setAllowEmptyValue($boolean)
{

View File

@ -151,7 +151,8 @@ class ExprBuilderTest extends \PHPUnit_Framework_TestCase
}
/**
* Create a test treebuilder with a variable node, and init the validation
* Create a test treebuilder with a variable node, and init the validation.
*
* @return TreeBuilder
*/
protected function getTestBuilder()
@ -167,10 +168,12 @@ class ExprBuilderTest extends \PHPUnit_Framework_TestCase
}
/**
* Close the validation process and finalize with the given config
* Close the validation process and finalize with the given config.
*
* @param TreeBuilder $testBuilder The tree builder to finalize
* @param array $config The config you want to use for the finalization, if nothing provided
* a simple array('key'=>'value') will be used
* a simple array('key'=>'value') will be used
*
* @return array The finalized config values
*/
protected function finalizeTestBuilder($testBuilder, $config = null)
@ -185,8 +188,10 @@ class ExprBuilderTest extends \PHPUnit_Framework_TestCase
}
/**
* Return a closure that will return the given value
* @param $val The value that the closure must return
* Return a closure that will return the given value.
*
* @param mixed $val The value that the closure must return
*
* @return Closure
*/
protected function returnClosure($val)
@ -201,7 +206,8 @@ class ExprBuilderTest extends \PHPUnit_Framework_TestCase
*
* @param mixed $value The value to test
* @param TreeBuilder $treeBuilder The tree builder to finalize
* @param mixed $config The config values that new to be finalized
*
* @param mixed $config The config values that new to be finalized
*/
protected function assertFinalizedValueIs($value, $treeBuilder, $config = null)
{

View File

@ -161,7 +161,7 @@ class Command
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null|int null or 0 if everything went fine, or an error code
* @return null|int null or 0 if everything went fine, or an error code
*
* @throws \LogicException When this abstract method is not implemented
* @see setCode()
@ -204,7 +204,7 @@ class Command
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return int The command exit code
* @return int The command exit code
*
* @throws \Exception
*
@ -279,7 +279,7 @@ class Command
*
* This method is not part of public API and should not be used directly.
*
* @param bool $mergeArgs Whether to merge or not the Application definition arguments to Command definition arguments
* @param bool $mergeArgs Whether to merge or not the Application definition arguments to Command definition arguments
*/
public function mergeApplicationDefinition($mergeArgs = true)
{
@ -353,10 +353,10 @@ class Command
/**
* Adds an argument.
*
* @param string $name The argument name
* @param int $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
* @param string $description A description text
* @param mixed $default The default value (for InputArgument::OPTIONAL mode only)
* @param string $name The argument name
* @param int $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
* @param string $description A description text
* @param mixed $default The default value (for InputArgument::OPTIONAL mode only)
*
* @return Command The current instance
*
@ -372,11 +372,11 @@ class Command
/**
* Adds an option.
*
* @param string $name The option name
* @param string $shortcut The shortcut (can be null)
* @param int $mode The option mode: One of the InputOption::VALUE_* constants
* @param string $description A description text
* @param mixed $default The default value (must be null for InputOption::VALUE_REQUIRED or InputOption::VALUE_NONE)
* @param string $name The option name
* @param string $shortcut The shortcut (can be null)
* @param int $mode The option mode: One of the InputOption::VALUE_* constants
* @param string $description A description text
* @param mixed $default The default value (must be null for InputOption::VALUE_REQUIRED or InputOption::VALUE_NONE)
*
* @return Command The current instance
*
@ -486,7 +486,7 @@ class Command
* Returns the processed help for the command replacing the %command.name% and
* %command.full_name% patterns with the real values dynamically.
*
* @return string The processed help for the command
* @return string The processed help for the command
*/
public function getProcessedHelp()
{
@ -587,7 +587,7 @@ class Command
/**
* Returns an XML representation of the command.
*
* @param bool $asDom Whether to return a DOM or an XML string
* @param bool $asDom Whether to return a DOM or an XML string
*
* @return string|\DOMDocument An XML string representing the command
*

View File

@ -58,7 +58,7 @@ class ConsoleExceptionEvent extends ConsoleEvent
/**
* Gets the exit code.
*
* @return int The command exit code
* @return int The command exit code
*/
public function getExitCode()
{

View File

@ -39,7 +39,7 @@ class ConsoleTerminateEvent extends ConsoleEvent
/**
* Sets the exit code.
*
* @param int $exitCode The command exit code
* @param int $exitCode The command exit code
*/
public function setExitCode($exitCode)
{
@ -49,7 +49,7 @@ class ConsoleTerminateEvent extends ConsoleEvent
/**
* Gets the exit code.
*
* @return int The command exit code
* @return int The command exit code
*/
public function getExitCode()
{

View File

@ -39,7 +39,7 @@ class OutputFormatter implements OutputFormatterInterface
/**
* Initializes console output formatter.
*
* @param bool $decorated Whether this formatter should actually decorate strings
* @param bool $decorated Whether this formatter should actually decorate strings
* @param OutputFormatterStyleInterface[] $styles Array of "name => FormatterStyle" instances
*
* @api
@ -63,7 +63,7 @@ class OutputFormatter implements OutputFormatterInterface
/**
* Sets the decorated flag.
*
* @param bool $decorated Whether to decorate the messages or not
* @param bool $decorated Whether to decorate the messages or not
*
* @api
*/
@ -75,7 +75,7 @@ class OutputFormatter implements OutputFormatterInterface
/**
* Gets the decorated flag.
*
* @return bool true if the output will decorate messages, false otherwise
* @return bool true if the output will decorate messages, false otherwise
*
* @api
*/
@ -194,7 +194,7 @@ class OutputFormatter implements OutputFormatterInterface
*
* @param string $string
*
* @return OutputFormatterStyle|bool false if string is not format string
* @return OutputFormatterStyle|bool false if string is not format string
*/
private function createStyleFromString($string)
{

View File

@ -23,7 +23,7 @@ interface OutputFormatterInterface
/**
* Sets the decorated flag.
*
* @param bool $decorated Whether to decorate the messages or not
* @param bool $decorated Whether to decorate the messages or not
*
* @api
*/
@ -32,7 +32,7 @@ interface OutputFormatterInterface
/**
* Gets the decorated flag.
*
* @return bool true if the output will decorate messages, false otherwise
* @return bool true if the output will decorate messages, false otherwise
*
* @api
*/

View File

@ -62,7 +62,7 @@ class OutputFormatterStyleStack
*
* @return OutputFormatterStyleInterface
*
* @throws \InvalidArgumentException When style tags incorrectly nested
* @throws \InvalidArgumentException When style tags incorrectly nested
*/
public function pop(OutputFormatterStyleInterface $style = null)
{

View File

@ -32,11 +32,11 @@ class DialogHelper extends Helper
* @param string|array $question The question to ask
* @param array $choices List of choices to pick from
* @param bool|string $default The default answer if the user enters nothing
* @param bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $errorMessage Message which will be shown if invalid value from choice list would be picked
* @param bool $multiselect Select more than one value separated by comma
*
* @return int|string|array The selected value or values (the key of the choices array)
* @return int|string|array The selected value or values (the key of the choices array)
*
* @throws \InvalidArgumentException
*/
@ -226,7 +226,7 @@ class DialogHelper extends Helper
* @param string|array $question The question to ask
* @param bool $default The default answer if the user enters nothing
*
* @return bool true if the user has confirmed, false otherwise
* @return bool true if the user has confirmed, false otherwise
*/
public function askConfirmation(OutputInterface $output, $question, $default = true)
{
@ -249,7 +249,7 @@ class DialogHelper extends Helper
* @param string|array $question The question
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
*
* @return string The answer
* @return string The answer
*
* @throws \RuntimeException In case the fallback is deactivated and the response can not be hidden
*/
@ -354,7 +354,7 @@ class DialogHelper extends Helper
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
*
* @return string The response
* @return string The response
*
* @throws \Exception When any of the validators return an error
* @throws \RuntimeException In case the fallback is deactivated and the response can not be hidden
@ -404,7 +404,7 @@ class DialogHelper extends Helper
/**
* Return a valid Unix shell
*
* @return string|bool The valid shell name, false in case no valid shell is found
* @return string|bool The valid shell name, false in case no valid shell is found
*/
private function getShell()
{
@ -442,12 +442,12 @@ class DialogHelper extends Helper
/**
* Validate an attempt
*
* @param callable $interviewer A callable that will ask for a question and return the result
* @param OutputInterface $output An Output instance
* @param callable $validator A PHP callback
* @param int|false $attempts Max number of times to ask before giving up ; false will ask infinitely
* @param callable $interviewer A callable that will ask for a question and return the result
* @param OutputInterface $output An Output instance
* @param callable $validator A PHP callback
* @param int|false $attempts Max number of times to ask before giving up ; false will ask infinitely
*
* @return string The validated response
* @return string The validated response
*
* @throws \Exception In case the max number of attempts has been reached and no valid response has been given
*/

View File

@ -45,7 +45,7 @@ abstract class Helper implements HelperInterface
*
* @param string $string The string to check its length
*
* @return int The length of the string
* @return int The length of the string
*/
protected function strlen($string)
{

View File

@ -57,7 +57,7 @@ class HelperSet
*
* @param string $name The helper name
*
* @return bool true if the helper is defined, false otherwise
* @return bool true if the helper is defined, false otherwise
*/
public function has($name)
{

View File

@ -220,8 +220,8 @@ class ProgressHelper extends Helper
/**
* Advances the progress output X steps.
*
* @param int $step Number of steps to advance
* @param bool $redraw Whether to redraw or not
* @param int $step Number of steps to advance
* @param bool $redraw Whether to redraw or not
*
* @throws \LogicException
*/
@ -248,8 +248,8 @@ class ProgressHelper extends Helper
/**
* Sets the current progress.
*
* @param int $current The current progress
* @param bool $redraw Whether to redraw or not
* @param int $current The current progress
* @param bool $redraw Whether to redraw or not
*
* @throws \LogicException
*/
@ -282,7 +282,7 @@ class ProgressHelper extends Helper
/**
* Outputs the current progress string.
*
* @param bool $finish Forces the end result
* @param bool $finish Forces the end result
*
* @throws \LogicException
*/
@ -343,7 +343,7 @@ class ProgressHelper extends Helper
/**
* Generates the array map of format variables to values.
*
* @param bool $finish Forces the end result
* @param bool $finish Forces the end result
*
* @return array Array of format vars and values
*/
@ -401,7 +401,7 @@ class ProgressHelper extends Helper
/**
* Converts seconds into human-readable format.
*
* @param int $secs Number of seconds
* @param int $secs Number of seconds
*
* @return string Time in readable format
*/
@ -426,8 +426,8 @@ class ProgressHelper extends Helper
/**
* Overwrites a previous message to the output.
*
* @param OutputInterface $output An Output instance
* @param string $message The message
* @param OutputInterface $output An Output instance
* @param string $message The message
*/
private function overwrite(OutputInterface $output, $message)
{

View File

@ -279,7 +279,7 @@ class TableHelper extends Helper
/**
* Sets cell padding type.
*
* @param int $padType STR_PAD_*
* @param int $padType STR_PAD_*
*
* @return TableHelper
*/
@ -377,9 +377,9 @@ class TableHelper extends Helper
/**
* Renders table cell with padding.
*
* @param array $row
* @param int $column
* @param string $cellFormat
* @param array $row
* @param int $column
* @param string $cellFormat
*/
private function renderCell(array $row, $column, $cellFormat)
{
@ -427,7 +427,7 @@ class TableHelper extends Helper
/**
* Gets column width.
*
* @param int $column
* @param int $column
*
* @return int
*/
@ -449,8 +449,8 @@ class TableHelper extends Helper
/**
* Gets cell width.
*
* @param array $row
* @param int $column
* @param array $row
* @param int $column
*
* @return int
*/

View File

@ -278,7 +278,7 @@ class ArgvInput extends Input
*
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
*
* @return bool true if the value is contained in the raw parameters
* @return bool true if the value is contained in the raw parameters
*/
public function hasParameterOption($values)
{

View File

@ -65,7 +65,7 @@ class ArrayInput extends Input
*
* @param string|array $values The values to look for in the raw parameters (can be an array)
*
* @return bool true if the value is contained in the raw parameters
* @return bool true if the value is contained in the raw parameters
*/
public function hasParameterOption($values)
{

View File

@ -80,7 +80,7 @@ abstract class Input implements InputInterface
/**
* Checks if the input is interactive.
*
* @return bool Returns true if the input is interactive
* @return bool Returns true if the input is interactive
*/
public function isInteractive()
{
@ -90,7 +90,7 @@ abstract class Input implements InputInterface
/**
* Sets the input interactivity.
*
* @param bool $interactive If the input should be interactive
* @param bool $interactive If the input should be interactive
*/
public function setInteractive($interactive)
{
@ -145,9 +145,9 @@ abstract class Input implements InputInterface
/**
* Returns true if an InputArgument object exists by name or position.
*
* @param string|int $name The InputArgument name or position
* @param string|int $name The InputArgument name or position
*
* @return bool true if the InputArgument object exists, false otherwise
* @return bool true if the InputArgument object exists, false otherwise
*/
public function hasArgument($name)
{
@ -185,8 +185,8 @@ abstract class Input implements InputInterface
/**
* Sets an option value by name.
*
* @param string $name The option name
* @param string|bool $value The option value
* @param string $name The option name
* @param string|bool $value The option value
*
* @throws \InvalidArgumentException When option given doesn't exist
*/
@ -204,7 +204,7 @@ abstract class Input implements InputInterface
*
* @param string $name The InputOption name
*
* @return bool true if the InputOption object exists, false otherwise
* @return bool true if the InputOption object exists, false otherwise
*/
public function hasOption($name)
{

View File

@ -32,10 +32,10 @@ class InputArgument
/**
* Constructor.
*
* @param string $name The argument name
* @param int $mode The argument mode: self::REQUIRED or self::OPTIONAL
* @param string $description A description text
* @param mixed $default The default value (for self::OPTIONAL mode only)
* @param string $name The argument name
* @param int $mode The argument mode: self::REQUIRED or self::OPTIONAL
* @param string $description A description text
* @param mixed $default The default value (for self::OPTIONAL mode only)
*
* @throws \InvalidArgumentException When argument mode is not valid
*
@ -69,7 +69,7 @@ class InputArgument
/**
* Returns true if the argument is required.
*
* @return bool true if parameter mode is self::REQUIRED, false otherwise
* @return bool true if parameter mode is self::REQUIRED, false otherwise
*/
public function isRequired()
{
@ -79,7 +79,7 @@ class InputArgument
/**
* Returns true if the argument can take multiple values.
*
* @return bool true if mode is self::IS_ARRAY, false otherwise
* @return bool true if mode is self::IS_ARRAY, false otherwise
*/
public function isArray()
{

View File

@ -143,7 +143,7 @@ class InputDefinition
/**
* Returns an InputArgument by name or by position.
*
* @param string|int $name The InputArgument name or position
* @param string|int $name The InputArgument name or position
*
* @return InputArgument An InputArgument object
*
@ -165,9 +165,9 @@ class InputDefinition
/**
* Returns true if an InputArgument object exists by name or position.
*
* @param string|int $name The InputArgument name or position
* @param string|int $name The InputArgument name or position
*
* @return bool true if the InputArgument object exists, false otherwise
* @return bool true if the InputArgument object exists, false otherwise
*
* @api
*/
@ -193,7 +193,7 @@ class InputDefinition
/**
* Returns the number of InputArguments.
*
* @return int The number of InputArguments
* @return int The number of InputArguments
*/
public function getArgumentCount()
{
@ -203,7 +203,7 @@ class InputDefinition
/**
* Returns the number of required InputArguments.
*
* @return int The number of required InputArguments
* @return int The number of required InputArguments
*/
public function getArgumentRequiredCount()
{
@ -309,7 +309,7 @@ class InputDefinition
*
* @param string $name The InputOption name
*
* @return bool true if the InputOption object exists, false otherwise
* @return bool true if the InputOption object exists, false otherwise
*
* @api
*/
@ -335,7 +335,7 @@ class InputDefinition
*
* @param string $name The InputOption shortcut
*
* @return bool true if the InputOption object exists, false otherwise
* @return bool true if the InputOption object exists, false otherwise
*/
public function hasShortcut($name)
{
@ -428,7 +428,7 @@ class InputDefinition
/**
* Returns an XML representation of the InputDefinition.
*
* @param bool $asDom Whether to return a DOM or an XML string
* @param bool $asDom Whether to return a DOM or an XML string
*
* @return string|\DOMDocument An XML string representing the InputDefinition
*

View File

@ -33,7 +33,7 @@ interface InputInterface
*
* @param string|array $values The values to look for in the raw parameters (can be an array)
*
* @return bool true if the value is contained in the raw parameters
* @return bool true if the value is contained in the raw parameters
*/
public function hasParameterOption($values);
@ -95,9 +95,9 @@ interface InputInterface
/**
* Returns true if an InputArgument object exists by name or position.
*
* @param string|int $name The InputArgument name or position
* @param string|int $name The InputArgument name or position
*
* @return bool true if the InputArgument object exists, false otherwise
* @return bool true if the InputArgument object exists, false otherwise
*/
public function hasArgument($name);
@ -120,8 +120,8 @@ interface InputInterface
/**
* Sets an option value by name.
*
* @param string $name The option name
* @param string|bool $value The option value
* @param string $name The option name
* @param string|bool $value The option value
*
* @throws \InvalidArgumentException When option given doesn't exist
*/
@ -132,7 +132,7 @@ interface InputInterface
*
* @param string $name The InputOption name
*
* @return bool true if the InputOption object exists, false otherwise
* @return bool true if the InputOption object exists, false otherwise
*/
public function hasOption($name);
@ -146,7 +146,7 @@ interface InputInterface
/**
* Sets the input interactivity.
*
* @param bool $interactive If the input should be interactive
* @param bool $interactive If the input should be interactive
*/
public function setInteractive($interactive);
}

View File

@ -112,7 +112,7 @@ class InputOption
/**
* Returns true if the option accepts a value.
*
* @return bool true if value mode is not self::VALUE_NONE, false otherwise
* @return bool true if value mode is not self::VALUE_NONE, false otherwise
*/
public function acceptValue()
{
@ -122,7 +122,7 @@ class InputOption
/**
* Returns true if the option requires a value.
*
* @return bool true if value mode is self::VALUE_REQUIRED, false otherwise
* @return bool true if value mode is self::VALUE_REQUIRED, false otherwise
*/
public function isValueRequired()
{
@ -132,7 +132,7 @@ class InputOption
/**
* Returns true if the option takes an optional value.
*
* @return bool true if value mode is self::VALUE_OPTIONAL, false otherwise
* @return bool true if value mode is self::VALUE_OPTIONAL, false otherwise
*/
public function isValueOptional()
{
@ -142,7 +142,7 @@ class InputOption
/**
* Returns true if the option can take multiple values.
*
* @return bool true if mode is self::VALUE_IS_ARRAY, false otherwise
* @return bool true if mode is self::VALUE_IS_ARRAY, false otherwise
*/
public function isArray()
{
@ -194,9 +194,10 @@ class InputOption
}
/**
* Checks whether the given option equals this one
* Checks whether the given option equals this one.
*
* @param InputOption $option option to compare
*
* @return bool
*/
public function equals(InputOption $option)

View File

@ -138,8 +138,8 @@ abstract class Output implements OutputInterface
/**
* Writes a message to the output.
*
* @param string $message A message to write to the output
* @param bool $newline Whether to add a newline or not
* @param string $message A message to write to the output
* @param bool $newline Whether to add a newline or not
*/
abstract protected function doWrite($message, $newline);
}

View File

@ -60,7 +60,7 @@ interface OutputInterface
/**
* Sets the verbosity of the output.
*
* @param int $level The level of verbosity (one of the VERBOSITY constants)
* @param int $level The level of verbosity (one of the VERBOSITY constants)
*
* @api
*/
@ -69,7 +69,7 @@ interface OutputInterface
/**
* Gets the current verbosity of the output.
*
* @return int The current level of verbosity (one of the VERBOSITY constants)
* @return int The current level of verbosity (one of the VERBOSITY constants)
*
* @api
*/
@ -78,7 +78,7 @@ interface OutputInterface
/**
* Sets the decorated flag.
*
* @param bool $decorated Whether to decorate the messages
* @param bool $decorated Whether to decorate the messages
*
* @api
*/
@ -87,7 +87,7 @@ interface OutputInterface
/**
* Gets the decorated flag.
*
* @return bool true if the output will decorate messages, false otherwise
* @return bool true if the output will decorate messages, false otherwise
*
* @api
*/
@ -105,7 +105,7 @@ interface OutputInterface
/**
* Returns current output formatter instance.
*
* @return OutputFormatterInterface
* @return OutputFormatterInterface
*
* @api
*/

View File

@ -92,7 +92,7 @@ class StreamOutput extends Output
* - Windows without Ansicon and ConEmu
* - non tty consoles
*
* @return bool true if the stream supports colorization, false otherwise
* @return bool true if the stream supports colorization, false otherwise
*/
protected function hasColorSupport()
{

View File

@ -164,7 +164,7 @@ EOF;
*
* @param string $text The last segment of the entered text
*
* @return bool|array A list of guessed strings or true
* @return bool|array A list of guessed strings or true
*/
private function autocompleter($text)
{

View File

@ -55,7 +55,7 @@ class ApplicationTester
* @param array $input An array of arguments and options
* @param array $options An array of options
*
* @return int The command exit code
* @return int The command exit code
*/
public function run(array $input, $options = array())
{
@ -78,7 +78,7 @@ class ApplicationTester
/**
* Gets the display returned by the last execution of the application.
*
* @param bool $normalize Whether to normalize end of lines to \n or not
* @param bool $normalize Whether to normalize end of lines to \n or not
*
* @return string The display
*/

View File

@ -50,7 +50,7 @@ class CommandTester
* @param array $input An array of arguments and options
* @param array $options An array of options
*
* @return int The command exit code
* @return int The command exit code
*/
public function execute(array $input, array $options = array())
{
@ -73,7 +73,7 @@ class CommandTester
/**
* Gets the display returned by the last execution of the command.
*
* @param bool $normalize Whether to normalize end of lines to \n or not
* @param bool $normalize Whether to normalize end of lines to \n or not
*
* @return string The display
*/

View File

@ -40,8 +40,8 @@ class CssSelector
* Optionally, a prefix can be added to the resulting XPath
* expression with the $prefix parameter.
*
* @param mixed $cssExpr The CSS expression.
* @param string $prefix An optional prefix for the XPath expression.
* @param mixed $cssExpr The CSS expression.
* @param string $prefix An optional prefix for the XPath expression.
*
* @return string
*

View File

@ -45,8 +45,8 @@ class NodeExtension extends AbstractExtension
}
/**
* @param int $flag
* @param bool $on
* @param int $flag
* @param bool $on
*
* @return NodeExtension
*/

View File

@ -227,7 +227,7 @@ class Translator implements TranslatorInterface
}
/**
* @param XPathExpr $xpath
* @param XPathExpr $xpath
* @param FunctionNode $function
*
* @return XPathExpr

View File

@ -37,10 +37,10 @@ class XPathExpr
private $condition;
/**
* @param string $path
* @param string $element
* @param string $condition
* @param bool $starPrefix
* @param string $path
* @param string $element
* @param string $condition
* @param bool $starPrefix
*/
public function __construct($path = '', $element = '*', $condition = '', $starPrefix = false)
{

View File

@ -30,8 +30,8 @@ class Debug
* If the Symfony ClassLoader component is available, a special
* class loader is also registered.
*
* @param int $errorReportingLevel The level of error reporting you want
* @param bool $displayErrors Whether to display errors (for development) or just log them (for production)
* @param int $errorReportingLevel The level of error reporting you want
* @param bool $displayErrors Whether to display errors (for development) or just log them (for production)
*/
public static function enable($errorReportingLevel = null, $displayErrors = true)
{

View File

@ -56,8 +56,8 @@ class ErrorHandler
/**
* Registers the error handler.
*
* @param int $level The level at which the conversion to Exception is done (null to use the error_reporting() value and 0 to disable)
* @param bool $displayErrors Display errors (for dev environment) or just log they (production usage)
* @param int $level The level at which the conversion to Exception is done (null to use the error_reporting() value and 0 to disable)
* @param bool $displayErrors Display errors (for dev environment) or just log they (production usage)
*
* @return ErrorHandler The registered error handler
*/

View File

@ -39,7 +39,7 @@ class ExceptionHandler
/**
* Registers the exception handler.
*
* @param bool $debug
* @param bool $debug
*
* @return ExceptionHandler The registered exception handler
*/

View File

@ -22,8 +22,8 @@ class Alias
/**
* Constructor.
*
* @param string $id Alias identifier
* @param bool $public If this alias is public
* @param string $id Alias identifier
* @param bool $public If this alias is public
*
* @api
*/
@ -48,7 +48,7 @@ class Alias
/**
* Sets if this Alias is public.
*
* @param bool $boolean If this Alias should be public
* @param bool $boolean If this Alias should be public
*
* @api
*/

View File

@ -36,7 +36,7 @@ class AnalyzeServiceReferencesPass implements RepeatablePassInterface
/**
* Constructor.
*
* @param bool $onlyConstructorArguments Sets this Service Reference pass to ignore method calls
* @param bool $onlyConstructorArguments Sets this Service Reference pass to ignore method calls
*/
public function __construct($onlyConstructorArguments = false)
{

View File

@ -109,7 +109,7 @@ class InlineServiceDefinitionsPass implements RepeatablePassInterface
* @param string $id
* @param Definition $definition
*
* @return bool If the definition is inlineable
* @return bool If the definition is inlineable
*/
private function isInlineableDefinition(ContainerBuilder $container, $id, Definition $definition)
{

View File

@ -69,8 +69,8 @@ class ResolveInvalidReferencesPass implements CompilerPassInterface
/**
* Processes arguments to determine invalid references.
*
* @param array $arguments An array of Reference objects
* @param bool $inMethodCall
* @param array $arguments An array of Reference objects
* @param bool $inMethodCall
*
* @return array
*

View File

@ -65,7 +65,7 @@ class ServiceReferenceGraphNode
/**
* Checks if the value of this node is an Alias.
*
* @return bool True if the value is an Alias instance
* @return bool True if the value is an Alias instance
*/
public function isAlias()
{
@ -75,7 +75,7 @@ class ServiceReferenceGraphNode
/**
* Checks if the value of this node is a Definition.
*
* @return bool True if the value is a Definition instance
* @return bool True if the value is a Definition instance
*/
public function isDefinition()
{

View File

@ -115,7 +115,7 @@ class Container implements IntrospectableContainerInterface
/**
* Returns true if the container parameter bag are frozen.
*
* @return bool true if the container parameter bag are frozen, false otherwise
* @return bool true if the container parameter bag are frozen, false otherwise
*
* @api
*/
@ -141,7 +141,7 @@ class Container implements IntrospectableContainerInterface
*
* @param string $name The parameter name
*
* @return mixed The parameter value
* @return mixed The parameter value
*
* @throws InvalidArgumentException if the parameter is not defined
*
@ -157,7 +157,7 @@ class Container implements IntrospectableContainerInterface
*
* @param string $name The parameter name
*
* @return bool The presence of parameter in container
* @return bool The presence of parameter in container
*
* @api
*/
@ -189,7 +189,7 @@ class Container implements IntrospectableContainerInterface
* @param object $service The service instance
* @param string $scope The scope of the service
*
* @throws RuntimeException When trying to set a service in an inactive scope
* @throws RuntimeException When trying to set a service in an inactive scope
* @throws InvalidArgumentException When trying to set a service in the prototype scope
*
* @api
@ -236,7 +236,7 @@ class Container implements IntrospectableContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if the service is defined, false otherwise
* @return bool true if the service is defined, false otherwise
*
* @api
*/
@ -261,8 +261,8 @@ class Container implements IntrospectableContainerInterface
* If a service is defined both through a set() method and
* with a get{$id}Service() method, the former has always precedence.
*
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*
@ -353,7 +353,7 @@ class Container implements IntrospectableContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if service has already been initialized, false otherwise
* @return bool true if service has already been initialized, false otherwise
*/
public function initialized($id)
{

View File

@ -84,7 +84,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* If you are not using the loaders and therefore don't want
* to depend on the Config component, set this flag to false.
*
* @param bool $track true if you want to track resources, false otherwise
* @param bool $track true if you want to track resources, false otherwise
*/
public function setResourceTracking($track)
{
@ -94,7 +94,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Checks if resources are tracked.
*
* @return bool true if resources are tracked, false otherwise
* @return bool true if resources are tracked, false otherwise
*/
public function isTrackingResources()
{
@ -168,7 +168,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
*
* @param string $name The name of the extension
*
* @return bool If the extension exists
* @return bool If the extension exists
*
* @api
*/
@ -273,7 +273,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* @param string $extension The extension alias or namespace
* @param array $values An array of values that customizes the extension
*
* @return ContainerBuilder The current instance
* @return ContainerBuilder The current instance
* @throws BadMethodCallException When this ContainerBuilder is frozen
*
* @throws \LogicException if the container is frozen
@ -430,7 +430,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if the service is defined, false otherwise
* @return bool true if the service is defined, false otherwise
*
* @api
*/
@ -444,8 +444,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Gets a service.
*
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*
@ -574,8 +574,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Prepends a config array to the configs of the given extension.
*
* @param string $name The name of the extension
* @param array $config The config to set
* @param string $name The name of the extension
* @param array $config The config to set
*/
public function prependExtensionConfig($name, array $config)
{
@ -669,8 +669,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Sets an alias for an existing service.
*
* @param string $alias The alias to create
* @param string|Alias $id The service to alias
* @param string $alias The alias to create
* @param string|Alias $id The service to alias
*
* @throws InvalidArgumentException if the id is not a string or an Alias
* @throws InvalidArgumentException if the alias is for itself
@ -713,7 +713,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if the alias exists, false otherwise
* @return bool true if the alias exists, false otherwise
*
* @api
*/
@ -843,7 +843,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if the service definition exists, false otherwise
* @return bool true if the service definition exists, false otherwise
*
* @api
*/
@ -905,9 +905,9 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
*
* @return object The service described by the service definition
*
* @throws RuntimeException When the scope is inactive
* @throws RuntimeException When the factory definition is incomplete
* @throws RuntimeException When the service is a synthetic service
* @throws RuntimeException When the scope is inactive
* @throws RuntimeException When the factory definition is incomplete
* @throws RuntimeException When the service is a synthetic service
* @throws InvalidArgumentException When configure callable is not callable
*
* @internal this method is public because of PHP 5.3 limitations, do not use it explicitly in your code

View File

@ -50,9 +50,9 @@ interface ContainerInterface
*
* @return object The associated service
*
* @throws InvalidArgumentException if the service is not defined
* @throws InvalidArgumentException if the service is not defined
* @throws ServiceCircularReferenceException When a circular reference is detected
* @throws ServiceNotFoundException When the service is not defined
* @throws ServiceNotFoundException When the service is not defined
*
* @see Reference
*
@ -65,7 +65,7 @@ interface ContainerInterface
*
* @param string $id The service identifier
*
* @return bool true if the service is defined, false otherwise
* @return bool true if the service is defined, false otherwise
*
* @api
*/
@ -76,7 +76,7 @@ interface ContainerInterface
*
* @param string $name The parameter name
*
* @return mixed The parameter value
* @return mixed The parameter value
*
* @throws InvalidArgumentException if the parameter is not defined
*
@ -89,7 +89,7 @@ interface ContainerInterface
*
* @param string $name The parameter name
*
* @return bool The presence of parameter in container
* @return bool The presence of parameter in container
*
* @api
*/

View File

@ -240,8 +240,8 @@ class Definition
/**
* Sets a specific argument
*
* @param int $index
* @param mixed $argument
* @param int $index
* @param mixed $argument
*
* @return Definition The current instance
*
@ -275,7 +275,7 @@ class Definition
/**
* Gets an argument to pass to the service constructor/factory method.
*
* @param int $index
* @param int $index
*
* @return mixed The argument value
*
@ -548,7 +548,7 @@ class Definition
/**
* Sets the visibility of this service.
*
* @param bool $boolean
* @param bool $boolean
*
* @return Definition The current instance
*
@ -576,7 +576,7 @@ class Definition
/**
* Sets the synchronized flag of this service.
*
* @param bool $boolean
* @param bool $boolean
*
* @return Definition The current instance
*
@ -604,7 +604,7 @@ class Definition
/**
* Sets the lazy flag of this service.
*
* @param bool $lazy
* @param bool $lazy
*
* @return Definition The current instance
*/
@ -629,7 +629,7 @@ class Definition
* Sets whether this definition is synthetic, that is not constructed by the
* container, but dynamically injected.
*
* @param bool $boolean
* @param bool $boolean
*
* @return Definition the current instance
*
@ -659,7 +659,7 @@ class Definition
* Whether this definition is abstract, that means it merely serves as a
* template for other definitions.
*
* @param bool $boolean
* @param bool $boolean
*
* @return Definition the current instance
*

View File

@ -167,7 +167,7 @@ class DefinitionDecorator extends Definition
* If replaceArgument() has been used to replace an argument, this method
* will return the replacement value.
*
* @param int $index
* @param int $index
*
* @return mixed The argument value
*
@ -198,10 +198,10 @@ class DefinitionDecorator extends Definition
* certain conventions when you want to overwrite the arguments of the
* parent definition, otherwise your arguments will only be appended.
*
* @param int $index
* @param mixed $value
* @param int $index
* @param mixed $value
*
* @return DefinitionDecorator the current instance
* @return DefinitionDecorator the current instance
* @throws InvalidArgumentException when $index isn't an integer
*
* @api

Some files were not shown because too many files have changed in this diff Show More