fixed phpdoc @param alignment
This commit is contained in:
parent
f27f5969b6
commit
41621e42e9
@ -89,7 +89,7 @@ class ContainerAwareEventManager extends EventManager
|
||||
/**
|
||||
* Adds an event listener that listens on the specified events.
|
||||
*
|
||||
* @param string|array $events The event(s) to listen on.
|
||||
* @param string|array $events The event(s) to listen on.
|
||||
* @param object|string $listener The listener object.
|
||||
*/
|
||||
public function addEventListener($events, $listener)
|
||||
|
@ -136,7 +136,7 @@ abstract class AbstractDoctrineExtension extends Extension
|
||||
*
|
||||
* @param array $bundleConfig
|
||||
* @param \ReflectionClass $bundle
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
*
|
||||
* @return array|false
|
||||
*/
|
||||
@ -174,7 +174,7 @@ abstract class AbstractDoctrineExtension extends Extension
|
||||
* Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
|
||||
*
|
||||
* @param array $objectManager
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
*/
|
||||
protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
|
||||
{
|
||||
|
@ -29,7 +29,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)
|
||||
{
|
||||
|
@ -375,7 +375,7 @@ class EntityChoiceList extends ObjectChoiceList
|
||||
* be persisted or added to the identity map before. Otherwise an
|
||||
* exception is thrown.
|
||||
*
|
||||
* @param object $entity The entity for which to get the identifier
|
||||
* @param object $entity The entity for which to get the identifier
|
||||
*
|
||||
* @return array The identifier values
|
||||
*
|
||||
|
@ -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.
|
||||
*/
|
||||
|
@ -24,7 +24,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Transforms a collection into an array.
|
||||
*
|
||||
* @param Collection $collection A collection of entities
|
||||
* @param Collection $collection A collection of entities
|
||||
*
|
||||
* @return mixed An array of entities
|
||||
*/
|
||||
@ -44,7 +44,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Transforms choice keys into entities.
|
||||
*
|
||||
* @param mixed $array An array of entities
|
||||
* @param mixed $array An array of entities
|
||||
*
|
||||
* @return Collection A collection of entities
|
||||
*/
|
||||
|
@ -35,8 +35,8 @@ class DbalSessionHandler implements \SessionHandlerInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param Connection $con An instance of Connection.
|
||||
* @param string $tableName Table name.
|
||||
* @param Connection $con An instance of Connection.
|
||||
* @param string $tableName Table name.
|
||||
*/
|
||||
public function __construct(Connection $con, $tableName = 'sessions')
|
||||
{
|
||||
|
@ -38,8 +38,8 @@ class PropelDataCollector extends DataCollector
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param \Symfony\Bridge\Propel1\Logger\PropelLogger $logger A Propel logger.
|
||||
* @param \PropelConfiguration $propelConfiguration The Propel configuration object.
|
||||
* @param \Symfony\Bridge\Propel1\Logger\PropelLogger $logger A Propel logger.
|
||||
* @param \PropelConfiguration $propelConfiguration The Propel configuration object.
|
||||
*/
|
||||
public function __construct(PropelLogger $logger, \PropelConfiguration $propelConfiguration)
|
||||
{
|
||||
|
@ -335,7 +335,7 @@ class ModelChoiceList extends ObjectChoiceList
|
||||
* be persisted or added to the idmodel map before. Otherwise an
|
||||
* exception is thrown.
|
||||
*
|
||||
* @param object $model The model for which to get the identifier
|
||||
* @param object $model The model for which to get the identifier
|
||||
* @throws FormException If the model does not exist
|
||||
*/
|
||||
private function getIdentifierValues($model)
|
||||
|
@ -42,7 +42,7 @@ class PropelLogger
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param LoggerInterface $logger A LoggerInterface instance
|
||||
* @param LoggerInterface $logger A LoggerInterface instance
|
||||
* @param Stopwatch $stopwatch A Stopwatch instance
|
||||
*/
|
||||
public function __construct(LoggerInterface $logger = null, Stopwatch $stopwatch = null)
|
||||
|
@ -108,7 +108,7 @@ class FormExtension extends \Twig_Extension
|
||||
*
|
||||
* <form action="..." method="post" {{ form_enctype(form) }}>
|
||||
*
|
||||
* @param FormView $view The view for which to render the encoding type
|
||||
* @param FormView $view The view for which to render the encoding type
|
||||
*
|
||||
* @return string The html markup
|
||||
*/
|
||||
@ -156,8 +156,8 @@ class FormExtension extends \Twig_Extension
|
||||
*
|
||||
* {{ form_widget(view, {'separator': '+++++'}) }}
|
||||
*
|
||||
* @param FormView $view The view to render
|
||||
* @param array $variables Additional variables passed to the template
|
||||
* @param FormView $view The view to render
|
||||
* @param array $variables Additional variables passed to the template
|
||||
*
|
||||
* @return string The html markup
|
||||
*/
|
||||
@ -181,8 +181,8 @@ class FormExtension extends \Twig_Extension
|
||||
/**
|
||||
* Renders the label of the given view
|
||||
*
|
||||
* @param FormView $view The view to render the label for
|
||||
* @param string $label Label name
|
||||
* @param FormView $view The view to render the label for
|
||||
* @param string $label Label name
|
||||
* @param array $variables Additional variables passed to the template
|
||||
*
|
||||
* @return string The html markup
|
||||
@ -205,9 +205,9 @@ class FormExtension extends \Twig_Extension
|
||||
* 3. the type name is recursively replaced by the parent type name until a
|
||||
* corresponding block is found
|
||||
*
|
||||
* @param FormView $view The form view
|
||||
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
|
||||
* @param array $variables Additional variables
|
||||
* @param FormView $view The form view
|
||||
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
|
||||
* @param array $variables Additional variables
|
||||
*
|
||||
* @return string The html markup
|
||||
*
|
||||
|
@ -23,7 +23,7 @@ class FormThemeTokenParser extends \Twig_TokenParser
|
||||
/**
|
||||
* Parses a token and returns a node.
|
||||
*
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
*
|
||||
* @return \Twig_NodeInterface A Twig_NodeInterface instance
|
||||
*/
|
||||
|
@ -23,7 +23,7 @@ class TransChoiceTokenParser extends TransTokenParser
|
||||
/**
|
||||
* Parses a token and returns a node.
|
||||
*
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
*
|
||||
* @return \Twig_NodeInterface A Twig_NodeInterface instance
|
||||
*/
|
||||
|
@ -23,7 +23,7 @@ class TransDefaultDomainTokenParser extends \Twig_TokenParser
|
||||
/**
|
||||
* Parses a token and returns a node.
|
||||
*
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
*
|
||||
* @return \Twig_NodeInterface A Twig_NodeInterface instance
|
||||
*/
|
||||
|
@ -23,7 +23,7 @@ class TransTokenParser extends \Twig_TokenParser
|
||||
/**
|
||||
* Parses a token and returns a node.
|
||||
*
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
* @param \Twig_Token $token A Twig_Token instance
|
||||
*
|
||||
* @return \Twig_NodeInterface A Twig_NodeInterface instance
|
||||
*/
|
||||
|
@ -31,9 +31,9 @@ class TemplateFinder implements TemplateFinderInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param KernelInterface $kernel A KernelInterface instance
|
||||
* @param TemplateNameParser $parser A TemplateNameParser instance
|
||||
* @param string $rootDir The directory where global templates can be stored
|
||||
* @param KernelInterface $kernel A KernelInterface instance
|
||||
* @param TemplateNameParser $parser A TemplateNameParser instance
|
||||
* @param string $rootDir The directory where global templates can be stored
|
||||
*/
|
||||
public function __construct(KernelInterface $kernel, TemplateNameParser $parser, $rootDir)
|
||||
{
|
||||
|
@ -27,8 +27,8 @@ class TemplatePathsCacheWarmer extends CacheWarmer
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param TemplateFinderInterface $finder A template finder
|
||||
* @param TemplateLocator $locator The template locator
|
||||
* @param TemplateFinderInterface $finder A template finder
|
||||
* @param TemplateLocator $locator The template locator
|
||||
*/
|
||||
public function __construct(TemplateFinderInterface $finder, TemplateLocator $locator)
|
||||
{
|
||||
|
@ -102,9 +102,9 @@ class Controller extends ContainerAware
|
||||
/**
|
||||
* Streams a view.
|
||||
*
|
||||
* @param string $view The view name
|
||||
* @param string $view The view name
|
||||
* @param array $parameters An array of parameters to pass to the view
|
||||
* @param StreamedResponse $response A response instance
|
||||
* @param StreamedResponse $response A response instance
|
||||
*
|
||||
* @return StreamedResponse A StreamedResponse instance
|
||||
*/
|
||||
|
@ -336,7 +336,7 @@ class FrameworkExtension extends Extension
|
||||
/**
|
||||
* Loads the templating configuration.
|
||||
*
|
||||
* @param array $config A templating configuration array
|
||||
* @param array $config A templating configuration array
|
||||
* @param string $ide
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
* @param XmlFileLoader $loader An XmlFileLoader instance
|
||||
|
@ -62,9 +62,9 @@ class HttpKernel extends BaseHttpKernel
|
||||
/**
|
||||
* Forwards the request to another controller.
|
||||
*
|
||||
* @param string $controller The controller name (a string like BlogBundle:Post:index)
|
||||
* @param array $attributes An array of request attributes
|
||||
* @param array $query An array of request query parameters
|
||||
* @param string $controller The controller name (a string like BlogBundle:Post:index)
|
||||
* @param array $attributes An array of request attributes
|
||||
* @param array $query An array of request query parameters
|
||||
*
|
||||
* @return Response A Response instance
|
||||
*/
|
||||
|
@ -21,9 +21,9 @@ class RedirectableUrlMatcher extends BaseMatcher
|
||||
/**
|
||||
* Redirects the user to another URL.
|
||||
*
|
||||
* @param string $path The path info to redirect to.
|
||||
* @param string $route The route that matched
|
||||
* @param string $scheme The URL scheme (null to keep the current one)
|
||||
* @param string $path The path info to redirect to.
|
||||
* @param string $route The route that matched
|
||||
* @param string $scheme The URL scheme (null to keep the current one)
|
||||
*
|
||||
* @return array An array of parameters
|
||||
*/
|
||||
|
@ -114,8 +114,8 @@ class CodeHelper extends Helper
|
||||
/**
|
||||
* Returns an excerpt of a code file around the given line number.
|
||||
*
|
||||
* @param string $file A file path
|
||||
* @param int $line The selected line number
|
||||
* @param string $file A file path
|
||||
* @param int $line The selected line number
|
||||
*
|
||||
* @return string An HTML string
|
||||
*/
|
||||
@ -139,9 +139,9 @@ class CodeHelper extends Helper
|
||||
/**
|
||||
* Formats a file path.
|
||||
*
|
||||
* @param string $file An absolute file path
|
||||
* @param integer $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 integer $line The line number
|
||||
* @param string $text Use this text for the link rather than the file path
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
@ -168,8 +168,8 @@ class CodeHelper extends Helper
|
||||
/**
|
||||
* Returns the link for a given file/line pair.
|
||||
*
|
||||
* @param string $file An absolute file path
|
||||
* @param integer $line The line number
|
||||
* @param string $file An absolute file path
|
||||
* @param integer $line The line number
|
||||
*
|
||||
* @return string A link of false
|
||||
*/
|
||||
|
@ -90,7 +90,7 @@ class FormHelper extends Helper
|
||||
*
|
||||
* <form action="..." method="post" <?php echo $view['form']->enctype() ?>>
|
||||
*
|
||||
* @param FormView $view The view for which to render the encoding type
|
||||
* @param FormView $view The view for which to render the encoding type
|
||||
*
|
||||
* @return string The html markup
|
||||
*/
|
||||
@ -219,9 +219,9 @@ class FormHelper extends Helper
|
||||
* 3. the type name is recursively replaced by the parent type name until a
|
||||
* corresponding block is found
|
||||
*
|
||||
* @param FormView $view The form view
|
||||
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
|
||||
* @param array $variables Additional variables
|
||||
* @param FormView $view The form view
|
||||
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
|
||||
* @param array $variables Additional variables
|
||||
*
|
||||
* @return string The html markup
|
||||
*
|
||||
@ -290,7 +290,7 @@ class FormHelper extends Helper
|
||||
* Render a block from a form element.
|
||||
*
|
||||
* @param string $name
|
||||
* @param array $variables Additional variables (those would override the current context)
|
||||
* @param array $variables Additional variables (those would override the current context)
|
||||
*
|
||||
* @throws FormException if the block is not found
|
||||
* @throws FormException if the method is called out of a form element (no context)
|
||||
|
@ -42,7 +42,7 @@ class TemplateLocator implements FileLocatorInterface
|
||||
/**
|
||||
* Returns a full path for a given file.
|
||||
*
|
||||
* @param TemplateReferenceInterface $template A template
|
||||
* @param TemplateReferenceInterface $template A template
|
||||
*
|
||||
* @return string The full path for the file
|
||||
*/
|
||||
@ -54,9 +54,9 @@ class TemplateLocator implements FileLocatorInterface
|
||||
/**
|
||||
* Returns a full path for a given file.
|
||||
*
|
||||
* @param TemplateReferenceInterface $template A template
|
||||
* @param string $currentPath Unused
|
||||
* @param Boolean $first Unused
|
||||
* @param TemplateReferenceInterface $template A template
|
||||
* @param string $currentPath Unused
|
||||
* @param Boolean $first Unused
|
||||
*
|
||||
* @return string The full path for the file
|
||||
*
|
||||
|
@ -28,8 +28,8 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
|
||||
/**
|
||||
* Creates a Client.
|
||||
*
|
||||
* @param array $options An array of options to pass to the createKernel class
|
||||
* @param array $server An array of server parameters
|
||||
* @param array $options An array of options to pass to the createKernel class
|
||||
* @param array $server An array of server parameters
|
||||
*
|
||||
* @return Client A Client instance
|
||||
*/
|
||||
|
@ -42,7 +42,7 @@ class TranslationLoader
|
||||
/**
|
||||
* Loads translation messages from a directory to the catalogue.
|
||||
*
|
||||
* @param string $directory the directory to look into
|
||||
* @param string $directory the directory to look into
|
||||
* @param MessageCatalogue $catalogue the catalogue
|
||||
*/
|
||||
public function loadMessages($directory, MessageCatalogue $catalogue)
|
||||
|
@ -90,9 +90,9 @@ abstract class AbstractFactory implements SecurityFactoryInterface
|
||||
* AuthenticationProviderInterface.
|
||||
*
|
||||
* @param ContainerBuilder $container
|
||||
* @param string $id The unique id of the firewall
|
||||
* @param array $config The options array for this listener
|
||||
* @param string $userProviderId The id of the user provider
|
||||
* @param string $id The unique id of the firewall
|
||||
* @param array $config The options array for this listener
|
||||
* @param string $userProviderId The id of the user provider
|
||||
*
|
||||
* @return string never null, the id of the authentication provider
|
||||
*/
|
||||
|
@ -85,7 +85,7 @@ class ExceptionController extends ContainerAware
|
||||
/**
|
||||
* @param EngineInterface $templating
|
||||
* @param string $format
|
||||
* @param integer $code An HTTP response status code
|
||||
* @param integer $code An HTTP response status code
|
||||
* @param Boolean $debug
|
||||
*
|
||||
* @return TemplateReference
|
||||
|
@ -63,7 +63,7 @@ class ProfilerController extends ContainerAware
|
||||
/**
|
||||
* Exports data for a given token.
|
||||
*
|
||||
* @param string $token The profiler token
|
||||
* @param string $token The profiler token
|
||||
*
|
||||
* @return Response A Response instance
|
||||
*/
|
||||
|
@ -45,14 +45,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 Boolean $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
|
||||
* @param Boolean $httponly The cookie httponly flag
|
||||
* @param Boolean $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 Boolean $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
|
||||
* @param Boolean $httponly The cookie httponly flag
|
||||
* @param Boolean $encodedValue Whether the value is encoded or not
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
|
@ -91,8 +91,8 @@ class CookieJar
|
||||
/**
|
||||
* Updates the cookie jar from a response Set-Cookie headers.
|
||||
*
|
||||
* @param array $setCookies Set-Cookie headers from an HTTP response
|
||||
* @param string $uri The base URL
|
||||
* @param array $setCookies Set-Cookie headers from an HTTP response
|
||||
* @param string $uri The base URL
|
||||
*/
|
||||
public function updateFromSetCookie(array $setCookies, $uri = null)
|
||||
{
|
||||
@ -117,7 +117,7 @@ class CookieJar
|
||||
* Updates the cookie jar from a Response object.
|
||||
*
|
||||
* @param Response $response A Response object
|
||||
* @param string $uri The base URL
|
||||
* @param string $uri The base URL
|
||||
*/
|
||||
public function updateFromResponse(Response $response, $uri = null)
|
||||
{
|
||||
|
@ -27,8 +27,8 @@ class ConfigCache
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $file The absolute cache path
|
||||
* @param Boolean $debug Whether debugging is enabled or not
|
||||
* @param string $file The absolute cache path
|
||||
* @param Boolean $debug Whether debugging is enabled or not
|
||||
*/
|
||||
public function __construct($file, $debug)
|
||||
{
|
||||
|
@ -34,7 +34,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The Node's name
|
||||
* @param string $name The Node's name
|
||||
* @param NodeInterface $parent The node parent
|
||||
*/
|
||||
public function __construct($name, NodeInterface $parent = null)
|
||||
@ -311,7 +311,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
|
||||
/**
|
||||
* Merges values together.
|
||||
*
|
||||
* @param mixed $leftSide The left side to merge.
|
||||
* @param mixed $leftSide The left side to merge.
|
||||
* @param mixed $rightSide The right side to merge.
|
||||
*
|
||||
* @return mixed The merged values
|
||||
|
@ -35,7 +35,7 @@ abstract class BaseNode implements NodeInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The name of the node
|
||||
* @param string $name The name of the node
|
||||
* @param NodeInterface $parent The parent of this node
|
||||
*
|
||||
* @throws \InvalidArgumentException if the name contains a period.
|
||||
|
@ -164,7 +164,7 @@ class NodeBuilder implements NodeParentInterface
|
||||
/**
|
||||
* Adds or overrides a node Type.
|
||||
*
|
||||
* @param string $type The name of the type
|
||||
* @param string $type The name of the type
|
||||
* @param string $class The fully qualified name the node definition class
|
||||
*
|
||||
* @return NodeBuilder This node builder
|
||||
|
@ -38,8 +38,8 @@ abstract class NodeDefinition implements NodeParentInterface
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $name The name of the node
|
||||
* @param NodeParentInterface $parent The parent
|
||||
* @param string $name The name of the node
|
||||
* @param NodeParentInterface $parent The parent
|
||||
*/
|
||||
public function __construct($name, NodeParentInterface $parent = null)
|
||||
{
|
||||
|
@ -25,9 +25,9 @@ class TreeBuilder implements NodeParentInterface
|
||||
/**
|
||||
* Creates the root node.
|
||||
*
|
||||
* @param string $name The name of the root node
|
||||
* @param string $type The type of the root node
|
||||
* @param NodeBuilder $builder A custom node builder instance
|
||||
* @param string $name The name of the root node
|
||||
* @param string $type The type of the root node
|
||||
* @param NodeBuilder $builder A custom node builder instance
|
||||
*
|
||||
* @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
|
||||
*
|
||||
|
@ -42,8 +42,8 @@ class Processor
|
||||
/**
|
||||
* Processes an array of configurations.
|
||||
*
|
||||
* @param ConfigurationInterface $configuration The configuration class
|
||||
* @param array $configs An array of configuration items to process
|
||||
* @param ConfigurationInterface $configuration The configuration class
|
||||
* @param array $configs An array of configuration items to process
|
||||
*
|
||||
* @return array The processed configuration
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@ class PrototypedArrayNode extends ArrayNode
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The Node's name
|
||||
* @param string $name The Node's name
|
||||
* @param NodeInterface $parent The node parent
|
||||
*/
|
||||
public function __construct($name, NodeInterface $parent = null)
|
||||
@ -77,7 +77,7 @@ class PrototypedArrayNode extends ArrayNode
|
||||
* 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 Boolean $remove Whether or not to remove the key
|
||||
* @param Boolean $remove Whether or not to remove the key
|
||||
*/
|
||||
public function setKeyAttribute($attribute, $remove = true)
|
||||
{
|
||||
@ -288,7 +288,7 @@ class PrototypedArrayNode extends ArrayNode
|
||||
/**
|
||||
* Merges values together.
|
||||
*
|
||||
* @param mixed $leftSide The left side to merge.
|
||||
* @param mixed $leftSide The left side to merge.
|
||||
* @param mixed $rightSide The right side to merge.
|
||||
*
|
||||
* @return mixed The merged values
|
||||
|
@ -19,10 +19,10 @@ namespace Symfony\Component\Config\Exception;
|
||||
class FileLoaderLoadException extends \Exception
|
||||
{
|
||||
/**
|
||||
* @param string $resource The resource that could not be imported
|
||||
* @param string $sourceResource The original resource importing the new resource
|
||||
* @param integer $code The error code
|
||||
* @param Exception $previous A previous exception
|
||||
* @param string $resource The resource that could not be imported
|
||||
* @param string $sourceResource The original resource importing the new resource
|
||||
* @param integer $code The error code
|
||||
* @param Exception $previous A previous exception
|
||||
*/
|
||||
public function __construct($resource, $sourceResource = null, $code = null, $previous = null)
|
||||
{
|
||||
|
@ -60,8 +60,8 @@ class Application
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The name of the application
|
||||
* @param string $version The version of the application
|
||||
* @param string $name The name of the application
|
||||
* @param string $version The version of the application
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -519,7 +519,7 @@ class Application
|
||||
* Contrary to get, this command tries to find the best
|
||||
* match if you give it an abbreviation of a name or alias.
|
||||
*
|
||||
* @param string $name A command name or a command alias
|
||||
* @param string $name A command name or a command alias
|
||||
*
|
||||
* @return Command A Command instance
|
||||
*
|
||||
@ -590,7 +590,7 @@ class Application
|
||||
*
|
||||
* The array keys are the full names and the values the command instances.
|
||||
*
|
||||
* @param string $namespace A namespace name
|
||||
* @param string $namespace A namespace name
|
||||
*
|
||||
* @return array An array of Command instances
|
||||
*
|
||||
@ -991,8 +991,8 @@ class Application
|
||||
/**
|
||||
* Finds alternative commands of $name
|
||||
*
|
||||
* @param string $name The full name of the command
|
||||
* @param array $abbrevs The abbreviations
|
||||
* @param string $name The full name of the command
|
||||
* @param array $abbrevs The abbreviations
|
||||
*
|
||||
* @return array A sorted array of similar commands
|
||||
*/
|
||||
@ -1008,8 +1008,8 @@ class Application
|
||||
/**
|
||||
* Finds alternative namespace of $name
|
||||
*
|
||||
* @param string $name The full name of the namespace
|
||||
* @param array $abbrevs The abbreviations
|
||||
* @param string $name The full name of the namespace
|
||||
* @param array $abbrevs The abbreviations
|
||||
*
|
||||
* @return array A sorted array of similar namespace
|
||||
*/
|
||||
@ -1022,10 +1022,10 @@ class Application
|
||||
* Finds alternative of $name among $collection,
|
||||
* if nothing is found in $collection, try in $abbrevs
|
||||
*
|
||||
* @param string $name The string
|
||||
* @param array|Traversable $collection The collecion
|
||||
* @param array $abbrevs The abbreviations
|
||||
* @param Closure|string|array $callback The callable to transform collection item before comparison
|
||||
* @param string $name The string
|
||||
* @param array|Traversable $collection The collecion
|
||||
* @param array $abbrevs The abbreviations
|
||||
* @param Closure|string|array $callback The callable to transform collection item before comparison
|
||||
*
|
||||
* @return array A sorted array of similar string
|
||||
*/
|
||||
|
@ -32,8 +32,8 @@ class OutputFormatter implements OutputFormatterInterface
|
||||
/**
|
||||
* Initializes console output formatter.
|
||||
*
|
||||
* @param Boolean $decorated Whether this formatter should actually decorate strings
|
||||
* @param array $styles Array of "name => FormatterStyle" instances
|
||||
* @param Boolean $decorated Whether this formatter should actually decorate strings
|
||||
* @param array $styles Array of "name => FormatterStyle" instances
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -127,7 +127,7 @@ class OutputFormatter implements OutputFormatterInterface
|
||||
/**
|
||||
* Formats a message according to the given styles.
|
||||
*
|
||||
* @param string $message The message to style
|
||||
* @param string $message The message to style
|
||||
*
|
||||
* @return string The styled message
|
||||
*
|
||||
@ -211,7 +211,7 @@ class OutputFormatter implements OutputFormatterInterface
|
||||
* Applies style to text if must be applied.
|
||||
*
|
||||
* @param OutputFormatterStyleInterface $style Style to apply
|
||||
* @param string $text Input text
|
||||
* @param string $text Input text
|
||||
*
|
||||
* @return string string Styled text
|
||||
*/
|
||||
|
@ -73,7 +73,7 @@ interface OutputFormatterInterface
|
||||
/**
|
||||
* Formats a message according to the given styles.
|
||||
*
|
||||
* @param string $message The message to style
|
||||
* @param string $message The message to style
|
||||
*
|
||||
* @return string The styled message
|
||||
*
|
||||
|
@ -55,9 +55,9 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
|
||||
/**
|
||||
* Initializes output formatter style.
|
||||
*
|
||||
* @param string $foreground style foreground color name
|
||||
* @param string $background style background color name
|
||||
* @param array $options style options
|
||||
* @param string $foreground style foreground color name
|
||||
* @param string $background style background color name
|
||||
* @param array $options style options
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -77,7 +77,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets style foreground color.
|
||||
*
|
||||
* @param string $color color name
|
||||
* @param string $color color name
|
||||
*
|
||||
* @throws \InvalidArgumentException When the color name isn't defined
|
||||
*
|
||||
@ -105,7 +105,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets style background color.
|
||||
*
|
||||
* @param string $color color name
|
||||
* @param string $color color name
|
||||
*
|
||||
* @throws \InvalidArgumentException When the color name isn't defined
|
||||
*
|
||||
@ -133,7 +133,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets some specific style option.
|
||||
*
|
||||
* @param string $option option name
|
||||
* @param string $option option name
|
||||
*
|
||||
* @throws \InvalidArgumentException When the option name isn't defined
|
||||
*
|
||||
@ -157,7 +157,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
|
||||
/**
|
||||
* Unsets some specific style option.
|
||||
*
|
||||
* @param string $option option name
|
||||
* @param string $option option name
|
||||
*
|
||||
* @throws \InvalidArgumentException When the option name isn't defined
|
||||
*
|
||||
|
@ -23,7 +23,7 @@ interface OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets style foreground color.
|
||||
*
|
||||
* @param string $color color name
|
||||
* @param string $color color name
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -32,7 +32,7 @@ interface OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets style background color.
|
||||
*
|
||||
* @param string $color color name
|
||||
* @param string $color color name
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -41,7 +41,7 @@ interface OutputFormatterStyleInterface
|
||||
/**
|
||||
* Sets some specific style option.
|
||||
*
|
||||
* @param string $option option name
|
||||
* @param string $option option name
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
@ -50,7 +50,7 @@ interface OutputFormatterStyleInterface
|
||||
/**
|
||||
* Unsets some specific style option.
|
||||
*
|
||||
* @param string $option option name
|
||||
* @param string $option option name
|
||||
*/
|
||||
function unsetOption($option);
|
||||
|
||||
|
@ -82,7 +82,7 @@ class DialogHelper extends Helper
|
||||
* @param string|array $question The question to ask
|
||||
* @param callback $validator A PHP callback
|
||||
* @param integer $attempts Max number of times to ask before giving up (false by default, which means infinite)
|
||||
* @param string $default The default answer if none is given by the user
|
||||
* @param string $default The default answer if none is given by the user
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
@ -21,9 +21,9 @@ class FormatterHelper extends Helper
|
||||
/**
|
||||
* Formats a message within a section.
|
||||
*
|
||||
* @param string $section The section name
|
||||
* @param string $message The message
|
||||
* @param string $style The style to apply to the section
|
||||
* @param string $section The section name
|
||||
* @param string $message The message
|
||||
* @param string $style The style to apply to the section
|
||||
*/
|
||||
public function formatSection($section, $message, $style = 'info')
|
||||
{
|
||||
|
@ -55,7 +55,7 @@ class HelperSet
|
||||
/**
|
||||
* Returns true if the helper if defined.
|
||||
*
|
||||
* @param string $name The helper name
|
||||
* @param string $name The helper name
|
||||
*
|
||||
* @return Boolean true if the helper is defined, false otherwise
|
||||
*/
|
||||
|
@ -46,7 +46,7 @@ class ArgvInput extends Input
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param array $argv An array of parameters from the CLI (in the argv format)
|
||||
* @param array $argv An array of parameters from the CLI (in the argv format)
|
||||
* @param InputDefinition $definition A InputDefinition instance
|
||||
*
|
||||
* @api
|
||||
@ -286,8 +286,8 @@ class ArgvInput extends Input
|
||||
* This method is to be used to introspect the input parameters
|
||||
* before they have been validated. It must be used carefully.
|
||||
*
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
*
|
||||
* @return mixed The option value
|
||||
*/
|
||||
|
@ -90,8 +90,8 @@ class ArrayInput extends Input
|
||||
* This method is to be used to introspect the input parameters
|
||||
* before they have been validated. It must be used carefully.
|
||||
*
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
*
|
||||
* @return mixed The option value
|
||||
*/
|
||||
|
@ -43,8 +43,8 @@ interface InputInterface
|
||||
* This method is to be used to introspect the input parameters
|
||||
* before they have been validated. It must be used carefully.
|
||||
*
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
* @param string|array $values The value(s) to look for in the raw parameters (can be an array)
|
||||
* @param mixed $default The default value to return if no result is found
|
||||
*
|
||||
* @return mixed The option value
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@ class StringInput extends ArgvInput
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $input An array of parameters from the CLI (in the argv format)
|
||||
* @param string $input An array of parameters from the CLI (in the argv format)
|
||||
* @param InputDefinition $definition A InputDefinition instance
|
||||
*
|
||||
* @api
|
||||
|
@ -37,7 +37,7 @@ class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
||||
* self::VERBOSITY_VERBOSE)
|
||||
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
|
||||
* @param OutputFormatter $formatter Output formatter instance
|
||||
|
@ -25,7 +25,7 @@ class NullOutput extends Output
|
||||
/**
|
||||
* Writes a message to the output.
|
||||
*
|
||||
* @param string $message A message to write to the output
|
||||
* @param string $message A message to write to the output
|
||||
* @param Boolean $newline Whether to add a newline or not
|
||||
*/
|
||||
public function doWrite($message, $newline)
|
||||
|
@ -35,8 +35,8 @@ class StreamOutput extends Output
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param mixed $stream A stream resource
|
||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
||||
* @param mixed $stream A stream resource
|
||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
||||
* self::VERBOSITY_VERBOSE)
|
||||
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
|
||||
* @param OutputFormatter $formatter Output formatter instance
|
||||
|
@ -33,8 +33,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
|
||||
*
|
||||
@ -86,7 +86,7 @@ class CssSelector
|
||||
*
|
||||
* @throws \Exception When tokenizer throws it while parsing
|
||||
*
|
||||
* @param string $string The expression to parse
|
||||
* @param string $string The expression to parse
|
||||
*
|
||||
* @return Node\NodeInterface
|
||||
*/
|
||||
@ -109,7 +109,7 @@ class CssSelector
|
||||
* Parses a selector group contained in $stream and returns
|
||||
* the Node object that represents the expression.
|
||||
*
|
||||
* @param TokenStream $stream The stream to parse.
|
||||
* @param TokenStream $stream The stream to parse.
|
||||
*
|
||||
* @return Node\NodeInterface
|
||||
*/
|
||||
@ -138,7 +138,7 @@ class CssSelector
|
||||
*
|
||||
* @throws ParseException When expected selector but got something else
|
||||
*
|
||||
* @param TokenStream $stream The stream containing the selector.
|
||||
* @param TokenStream $stream The stream containing the selector.
|
||||
*
|
||||
* @return Node\NodeInterface
|
||||
*/
|
||||
@ -179,7 +179,7 @@ class CssSelector
|
||||
*
|
||||
* @throws ParseException When expected symbol but got something else
|
||||
*
|
||||
* @param TokenStream $stream The stream containing the selector.
|
||||
* @param TokenStream $stream The stream containing the selector.
|
||||
*
|
||||
* @return Node\NodeInterface
|
||||
*/
|
||||
@ -286,9 +286,9 @@ class CssSelector
|
||||
*
|
||||
* @throws ParseException When encountered unexpected selector
|
||||
*
|
||||
* @param Node\NodeInterface $selector The selector object whose attribute
|
||||
* @param Node\NodeInterface $selector The selector object whose attribute
|
||||
* is to be parsed.
|
||||
* @param TokenStream $stream The container token stream.
|
||||
* @param TokenStream $stream The container token stream.
|
||||
*
|
||||
* @return Node\AttribNode
|
||||
*/
|
||||
|
@ -33,11 +33,11 @@ class AttribNode implements NodeInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param NodeInterface $selector The XPath selector
|
||||
* @param string $namespace The namespace
|
||||
* @param string $attrib The attribute
|
||||
* @param string $operator The operator
|
||||
* @param string $value The value
|
||||
* @param NodeInterface $selector The XPath selector
|
||||
* @param string $namespace The namespace
|
||||
* @param string $attrib The attribute
|
||||
* @param string $operator The operator
|
||||
* @param string $value The value
|
||||
*/
|
||||
public function __construct($selector, $namespace, $attrib, $operator, $value)
|
||||
{
|
||||
|
@ -29,8 +29,8 @@ class ClassNode implements NodeInterface
|
||||
/**
|
||||
* The constructor.
|
||||
*
|
||||
* @param NodeInterface $selector The XPath Selector
|
||||
* @param string $className The class name
|
||||
* @param NodeInterface $selector The XPath Selector
|
||||
* @param string $className The class name
|
||||
*/
|
||||
public function __construct($selector, $className)
|
||||
{
|
||||
|
@ -37,8 +37,8 @@ class CombinedSelectorNode implements NodeInterface
|
||||
/**
|
||||
* The constructor.
|
||||
*
|
||||
* @param NodeInterface $selector The XPath selector
|
||||
* @param string $combinator The combinator
|
||||
* @param NodeInterface $selector The XPath selector
|
||||
* @param string $combinator The combinator
|
||||
* @param NodeInterface $subselector The sub XPath selector
|
||||
*/
|
||||
public function __construct($selector, $combinator, $subselector)
|
||||
@ -77,8 +77,8 @@ class CombinedSelectorNode implements NodeInterface
|
||||
/**
|
||||
* Joins a NodeInterface into the XPath of this object.
|
||||
*
|
||||
* @param XPathExpr $xpath The XPath expression for this object
|
||||
* @param NodeInterface $sub The NodeInterface object to add
|
||||
* @param XPathExpr $xpath The XPath expression for this object
|
||||
* @param NodeInterface $sub The NodeInterface object to add
|
||||
*/
|
||||
protected function _xpath_descendant($xpath, $sub)
|
||||
{
|
||||
@ -91,8 +91,8 @@ class CombinedSelectorNode implements NodeInterface
|
||||
/**
|
||||
* Joins a NodeInterface as a child of this object.
|
||||
*
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The NodeInterface object to add
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The NodeInterface object to add
|
||||
*/
|
||||
protected function _xpath_child($xpath, $sub)
|
||||
{
|
||||
@ -105,8 +105,8 @@ class CombinedSelectorNode implements NodeInterface
|
||||
/**
|
||||
* Joins an XPath expression as an adjacent of another.
|
||||
*
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The adjacent XPath expression
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The adjacent XPath expression
|
||||
*/
|
||||
protected function _xpath_direct_adjacent($xpath, $sub)
|
||||
{
|
||||
@ -121,8 +121,8 @@ class CombinedSelectorNode implements NodeInterface
|
||||
/**
|
||||
* Joins an XPath expression as an indirect adjacent of another.
|
||||
*
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The indirect adjacent NodeInterface object
|
||||
* @param XPathExpr $xpath The parent XPath expression
|
||||
* @param NodeInterface $sub The indirect adjacent NodeInterface object
|
||||
*/
|
||||
protected function _xpath_indirect_adjacent($xpath, $sub)
|
||||
{
|
||||
|
@ -30,7 +30,7 @@ class ElementNode implements NodeInterface
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $namespace Namespace
|
||||
* @param string $element Element
|
||||
* @param string $element Element
|
||||
*/
|
||||
public function __construct($namespace, $element)
|
||||
{
|
||||
|
@ -30,7 +30,7 @@ class HashNode implements NodeInterface
|
||||
* Constructor.
|
||||
*
|
||||
* @param NodeInterface $selector The NodeInterface object
|
||||
* @param string $id The ID
|
||||
* @param string $id The ID
|
||||
*/
|
||||
public function __construct($selector, $id)
|
||||
{
|
||||
|
@ -37,8 +37,8 @@ class PseudoNode implements NodeInterface
|
||||
* Constructor.
|
||||
*
|
||||
* @param NodeInterface $element The NodeInterface element
|
||||
* @param string $type Node type
|
||||
* @param string $ident The ident
|
||||
* @param string $type Node type
|
||||
* @param string $ident The ident
|
||||
*
|
||||
* @throws ParseException When incorrect PseudoNode type is given
|
||||
*/
|
||||
|
@ -52,7 +52,7 @@ class Token
|
||||
/**
|
||||
* Answers whether this token's type equals to $type.
|
||||
*
|
||||
* @param string $type The type to test against this token's one.
|
||||
* @param string $type The type to test against this token's one.
|
||||
*
|
||||
* @return Boolean
|
||||
*/
|
||||
|
@ -27,7 +27,7 @@ class Tokenizer
|
||||
* Takes a CSS selector and returns an array holding the Tokens
|
||||
* it contains.
|
||||
*
|
||||
* @param string $s The selector to lex.
|
||||
* @param string $s The selector to lex.
|
||||
*
|
||||
* @return array Token[]
|
||||
*/
|
||||
@ -111,8 +111,8 @@ class Tokenizer
|
||||
*
|
||||
* @throws ParseException When expected closing is not found
|
||||
*
|
||||
* @param string $s The selector string containing the quoted string.
|
||||
* @param integer $pos The starting position for the quoted string.
|
||||
* @param string $s The selector string containing the quoted string.
|
||||
* @param integer $pos The starting position for the quoted string.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
@ -148,7 +148,7 @@ class Tokenizer
|
||||
*
|
||||
* @throws ParseException When invalid escape sequence is found
|
||||
*
|
||||
* @param string $literal The string literal to unescape.
|
||||
* @param string $literal The string literal to unescape.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
@ -174,8 +174,8 @@ class Tokenizer
|
||||
*
|
||||
* @throws ParseException When Unexpected symbol is found
|
||||
*
|
||||
* @param string $s The selector string.
|
||||
* @param integer $pos The position in $s at which the symbol starts.
|
||||
* @param string $s The selector string.
|
||||
* @param integer $pos The position in $s at which the symbol starts.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
@ -139,7 +139,7 @@ class XPathExpr
|
||||
* Adds a prefix to this XPath expression.
|
||||
* It will be prepended to any pre-existent prefixes.
|
||||
*
|
||||
* @param string $prefix The prefix to add.
|
||||
* @param string $prefix The prefix to add.
|
||||
*/
|
||||
public function addPrefix($prefix)
|
||||
{
|
||||
@ -215,7 +215,7 @@ class XPathExpr
|
||||
/**
|
||||
* Gets an XPath literal for $s.
|
||||
*
|
||||
* @param mixed $s Can either be a Node\ElementNode or a string.
|
||||
* @param mixed $s Can either be a Node\ElementNode or a string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
|
@ -22,7 +22,7 @@ class Alias
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $id Alias identifier
|
||||
* @param string $id Alias identifier
|
||||
* @param Boolean $public If this alias is public
|
||||
*
|
||||
* @api
|
||||
|
@ -96,7 +96,7 @@ class PassConfig
|
||||
* Adds a pass.
|
||||
*
|
||||
* @param CompilerPassInterface $pass A Compiler pass
|
||||
* @param string $type The pass type
|
||||
* @param string $type The pass type
|
||||
*
|
||||
* @throws InvalidArgumentException when a pass type doesn't exist
|
||||
*
|
||||
|
@ -63,8 +63,8 @@ class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface
|
||||
* Updates references to remove aliases.
|
||||
*
|
||||
* @param ContainerBuilder $container The container
|
||||
* @param string $currentId The alias identifier being replaced
|
||||
* @param string $newId The id of the service the alias points to
|
||||
* @param string $currentId The alias identifier being replaced
|
||||
* @param string $newId The id of the service the alias points to
|
||||
*/
|
||||
private function updateReferences($container, $currentId, $newId)
|
||||
{
|
||||
@ -94,9 +94,9 @@ class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface
|
||||
/**
|
||||
* Updates argument references.
|
||||
*
|
||||
* @param array $arguments An array of Arguments
|
||||
* @param array $arguments An array of Arguments
|
||||
* @param string $currentId The alias identifier
|
||||
* @param string $newId The identifier the alias points to
|
||||
* @param string $newId The identifier the alias points to
|
||||
*/
|
||||
private function updateArgumentReferences(array $arguments, $currentId, $newId)
|
||||
{
|
||||
|
@ -54,7 +54,7 @@ class ResolveDefinitionTemplatesPass implements CompilerPassInterface
|
||||
/**
|
||||
* Resolves the definition
|
||||
*
|
||||
* @param string $id The definition identifier
|
||||
* @param string $id The definition identifier
|
||||
* @param DefinitionDecorator $definition
|
||||
*
|
||||
* @return Definition
|
||||
|
@ -69,7 +69,7 @@ class ResolveInvalidReferencesPass implements CompilerPassInterface
|
||||
/**
|
||||
* Processes arguments to determine invalid references.
|
||||
*
|
||||
* @param array $arguments An array of Reference objects
|
||||
* @param array $arguments An array of Reference objects
|
||||
* @param Boolean $inMethodCall
|
||||
*/
|
||||
private function processArguments(array $arguments, $inMethodCall = false)
|
||||
|
@ -31,8 +31,8 @@ class ServiceReferenceGraphNode
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $id The node identifier
|
||||
* @param mixed $value The node value
|
||||
* @param string $id The node identifier
|
||||
* @param mixed $value The node value
|
||||
*/
|
||||
public function __construct($id, $value)
|
||||
{
|
||||
|
@ -133,7 +133,7 @@ class Container implements IntrospectableContainerInterface
|
||||
/**
|
||||
* Gets a parameter.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return mixed The parameter value
|
||||
*
|
||||
@ -149,7 +149,7 @@ class Container implements IntrospectableContainerInterface
|
||||
/**
|
||||
* Checks if a parameter exists.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return Boolean The presence of parameter in container
|
||||
*
|
||||
@ -204,7 +204,7 @@ class Container implements IntrospectableContainerInterface
|
||||
/**
|
||||
* Returns true if the given service is defined.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if the service is defined, false otherwise
|
||||
*
|
||||
@ -223,8 +223,8 @@ class Container implements IntrospectableContainerInterface
|
||||
* If a service is both defined through a set() method and
|
||||
* with a set*Service() method, the former has always precedence.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param integer $invalidBehavior The behavior when the service does not exist
|
||||
* @param string $id The service identifier
|
||||
* @param integer $invalidBehavior The behavior when the service does not exist
|
||||
*
|
||||
* @return object The associated service
|
||||
*
|
||||
@ -269,7 +269,7 @@ class Container implements IntrospectableContainerInterface
|
||||
/**
|
||||
* Returns true if the given service has actually been initialized
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if service has already been initialized, false otherwise
|
||||
*/
|
||||
|
@ -291,7 +291,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Returns true if the given service is defined.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if the service is defined, false otherwise
|
||||
*
|
||||
@ -307,8 +307,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Gets a service.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param integer $invalidBehavior The behavior when the service does not exist
|
||||
* @param string $id The service identifier
|
||||
* @param integer $invalidBehavior The behavior when the service does not exist
|
||||
*
|
||||
* @return object The associated service
|
||||
*
|
||||
@ -532,7 +532,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Returns true if an alias exists under the given identifier.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if the alias exists, false otherwise
|
||||
*
|
||||
@ -558,7 +558,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Gets an alias.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return string The aliased service identifier
|
||||
*
|
||||
@ -583,8 +583,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
* This methods allows for simple registration of service definition
|
||||
* with a fluid interface.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $class The service class
|
||||
* @param string $id The service identifier
|
||||
* @param string $class The service class
|
||||
*
|
||||
* @return Definition A Definition instance
|
||||
*
|
||||
@ -637,8 +637,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Sets a service definition.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param Definition $definition A Definition instance
|
||||
* @param string $id The service identifier
|
||||
* @param Definition $definition A Definition instance
|
||||
*
|
||||
* @throws BadMethodCallException When this ContainerBuilder is frozen
|
||||
*
|
||||
@ -660,7 +660,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Returns true if a service definition exists under the given identifier.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if the service definition exists, false otherwise
|
||||
*
|
||||
@ -674,7 +674,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Gets a service definition.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Definition A Definition instance
|
||||
*
|
||||
@ -698,7 +698,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
*
|
||||
* The method "unaliases" recursively to return a Definition instance.
|
||||
*
|
||||
* @param string $id The service identifier or alias
|
||||
* @param string $id The service identifier or alias
|
||||
*
|
||||
* @return Definition A Definition instance
|
||||
*
|
||||
@ -718,8 +718,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Creates a service for a service definition.
|
||||
*
|
||||
* @param Definition $definition A service definition instance
|
||||
* @param string $id The service identifier
|
||||
* @param Definition $definition A service definition instance
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return object The service described by the service definition
|
||||
*
|
||||
@ -803,7 +803,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
|
||||
/**
|
||||
* Replaces service references by the real service instance.
|
||||
*
|
||||
* @param mixed $value A value
|
||||
* @param mixed $value A value
|
||||
*
|
||||
* @return mixed The same value with all service references replaced by the real service instances
|
||||
*/
|
||||
|
@ -43,8 +43,8 @@ interface ContainerInterface
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
@ -59,7 +59,7 @@ interface ContainerInterface
|
||||
/**
|
||||
* Returns true if the given service is defined.
|
||||
*
|
||||
* @param string $id The service identifier
|
||||
* @param string $id The service identifier
|
||||
*
|
||||
* @return Boolean true if the service is defined, false otherwise
|
||||
*
|
||||
@ -70,7 +70,7 @@ interface ContainerInterface
|
||||
/**
|
||||
* Gets a parameter.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return mixed The parameter value
|
||||
*
|
||||
@ -83,7 +83,7 @@ interface ContainerInterface
|
||||
/**
|
||||
* Checks if a parameter exists.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return Boolean The presence of parameter in container
|
||||
*
|
||||
|
@ -64,7 +64,7 @@ class Definition
|
||||
* Sets the name of the class that acts as a factory using the factory method,
|
||||
* which will be invoked statically.
|
||||
*
|
||||
* @param string $factoryClass The factory class name
|
||||
* @param string $factoryClass The factory class name
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -92,7 +92,7 @@ class Definition
|
||||
/**
|
||||
* Sets the factory method able to create an instance of this class.
|
||||
*
|
||||
* @param string $factoryMethod The factory method name
|
||||
* @param string $factoryMethod The factory method name
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -148,7 +148,7 @@ class Definition
|
||||
/**
|
||||
* Sets the service class.
|
||||
*
|
||||
* @param string $class The service class
|
||||
* @param string $class The service class
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -176,7 +176,7 @@ class Definition
|
||||
/**
|
||||
* Sets the arguments to pass to the service constructor/factory method.
|
||||
*
|
||||
* @param array $arguments An array of arguments
|
||||
* @param array $arguments An array of arguments
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -220,7 +220,7 @@ class Definition
|
||||
/**
|
||||
* Adds an argument to pass to the service constructor/factory method.
|
||||
*
|
||||
* @param mixed $argument An argument
|
||||
* @param mixed $argument An argument
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -287,7 +287,7 @@ class Definition
|
||||
/**
|
||||
* Sets the methods to call after service initialization.
|
||||
*
|
||||
* @param array $calls An array of method calls
|
||||
* @param array $calls An array of method calls
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -306,8 +306,8 @@ class Definition
|
||||
/**
|
||||
* Adds a method to call after service initialization.
|
||||
*
|
||||
* @param string $method The method name to call
|
||||
* @param array $arguments An array of arguments to pass to the method call
|
||||
* @param string $method The method name to call
|
||||
* @param array $arguments An array of arguments to pass to the method call
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -328,7 +328,7 @@ class Definition
|
||||
/**
|
||||
* Removes a method to call after service initialization.
|
||||
*
|
||||
* @param string $method The method name to remove
|
||||
* @param string $method The method name to remove
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -349,7 +349,7 @@ class Definition
|
||||
/**
|
||||
* Check if the current definition has a given method to call after service initialization.
|
||||
*
|
||||
* @param string $method The method name to search for
|
||||
* @param string $method The method name to search for
|
||||
*
|
||||
* @return Boolean
|
||||
*
|
||||
@ -409,7 +409,7 @@ class Definition
|
||||
/**
|
||||
* Gets a tag by name.
|
||||
*
|
||||
* @param string $name The tag name
|
||||
* @param string $name The tag name
|
||||
*
|
||||
* @return array An array of attributes
|
||||
*
|
||||
@ -423,8 +423,8 @@ class Definition
|
||||
/**
|
||||
* Adds a tag for this definition.
|
||||
*
|
||||
* @param string $name The tag name
|
||||
* @param array $attributes An array of attributes
|
||||
* @param string $name The tag name
|
||||
* @param array $attributes An array of attributes
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -484,7 +484,7 @@ class Definition
|
||||
/**
|
||||
* Sets a file to require before creating the service.
|
||||
*
|
||||
* @param string $file A full pathname to include
|
||||
* @param string $file A full pathname to include
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -512,7 +512,7 @@ class Definition
|
||||
/**
|
||||
* Sets the scope of the service
|
||||
*
|
||||
* @param string $scope Whether the service must be shared or not
|
||||
* @param string $scope Whether the service must be shared or not
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
@ -628,7 +628,7 @@ class Definition
|
||||
/**
|
||||
* Sets a configurator to call after the service is fully initialized.
|
||||
*
|
||||
* @param mixed $callable A PHP callable
|
||||
* @param mixed $callable A PHP callable
|
||||
*
|
||||
* @return Definition The current instance
|
||||
*
|
||||
|
@ -23,7 +23,7 @@ interface DumperInterface
|
||||
/**
|
||||
* Dumps the service container.
|
||||
*
|
||||
* @param array $options An array of options
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string The representation of the service container
|
||||
*
|
||||
|
@ -50,7 +50,7 @@ class GraphvizDumper extends Dumper
|
||||
* * node.definition: The default options for services that are defined via service definition instances
|
||||
* * node.missing: The default options for missing services
|
||||
*
|
||||
* @param array $options An array of options
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string The dot representation of the service container
|
||||
*/
|
||||
@ -119,8 +119,8 @@ class GraphvizDumper extends Dumper
|
||||
/**
|
||||
* Finds all edges belonging to a specific service id.
|
||||
*
|
||||
* @param string $id The service id used to find edges
|
||||
* @param array $arguments An array of arguments
|
||||
* @param string $id The service id used to find edges
|
||||
* @param array $arguments An array of arguments
|
||||
* @param Boolean $required
|
||||
* @param string $name
|
||||
*
|
||||
|
@ -70,7 +70,7 @@ class PhpDumper extends Dumper
|
||||
* * class: The class name
|
||||
* * base_class: The base class name
|
||||
*
|
||||
* @param array $options An array of options
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string A PHP class representing of the service container
|
||||
*
|
||||
@ -613,7 +613,7 @@ EOF;
|
||||
/**
|
||||
* Adds the class headers.
|
||||
*
|
||||
* @param string $class Class name
|
||||
* @param string $class Class name
|
||||
* @param string $baseClass The name of the base class
|
||||
*
|
||||
* @return string
|
||||
|
@ -35,7 +35,7 @@ class XmlDumper extends Dumper
|
||||
/**
|
||||
* Dumps the service container as an XML string.
|
||||
*
|
||||
* @param array $options An array of options
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string An xml string representing of the service container
|
||||
*
|
||||
|
@ -46,7 +46,7 @@ class YamlDumper extends Dumper
|
||||
/**
|
||||
* Dumps the service container as an YAML string.
|
||||
*
|
||||
* @param array $options An array of options
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string A YAML string representing of the service container
|
||||
*
|
||||
|
@ -23,7 +23,7 @@ interface ConfigurationExtensionInterface
|
||||
/**
|
||||
* Returns extension configuration
|
||||
*
|
||||
* @param array $config $config An array of configuration values
|
||||
* @param array $config $config An array of configuration values
|
||||
* @param ContainerBuilder $container A ContainerBuilder instance
|
||||
*
|
||||
* @return ConfigurationInterface|null The configuration or null
|
||||
|
@ -49,8 +49,8 @@ class ClosureLoader extends Loader
|
||||
/**
|
||||
* Returns true if this class supports the given resource.
|
||||
*
|
||||
* @param mixed $resource A resource
|
||||
* @param string $type The resource type
|
||||
* @param mixed $resource A resource
|
||||
* @param string $type The resource type
|
||||
*
|
||||
* @return Boolean true if this class supports the given resource, false otherwise
|
||||
*/
|
||||
|
@ -24,8 +24,8 @@ class IniFileLoader extends FileLoader
|
||||
/**
|
||||
* Loads a resource.
|
||||
*
|
||||
* @param mixed $file The resource
|
||||
* @param string $type The resource type
|
||||
* @param mixed $file The resource
|
||||
* @param string $type The resource type
|
||||
*
|
||||
* @throws InvalidArgumentException When ini file is not valid
|
||||
*/
|
||||
|
@ -115,7 +115,7 @@ class ParameterBag implements ParameterBagInterface
|
||||
/**
|
||||
* Returns true if a parameter name is defined.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return Boolean true if the parameter name is defined, false otherwise
|
||||
*
|
||||
@ -166,7 +166,7 @@ class ParameterBag implements ParameterBagInterface
|
||||
/**
|
||||
* Replaces parameter placeholders (%name%) by their values.
|
||||
*
|
||||
* @param mixed $value A value
|
||||
* @param mixed $value A value
|
||||
* @param array $resolving An array of keys that are being resolved (used internally to detect circular references)
|
||||
*
|
||||
* @return mixed The resolved value
|
||||
|
@ -73,7 +73,7 @@ interface ParameterBagInterface
|
||||
/**
|
||||
* Returns true if a parameter name is defined.
|
||||
*
|
||||
* @param string $name The parameter name
|
||||
* @param string $name The parameter name
|
||||
*
|
||||
* @return Boolean true if the parameter name is defined, false otherwise
|
||||
*
|
||||
@ -89,7 +89,7 @@ interface ParameterBagInterface
|
||||
/**
|
||||
* Replaces parameter placeholders (%name%) by their values.
|
||||
*
|
||||
* @param mixed $value A value
|
||||
* @param mixed $value A value
|
||||
*
|
||||
* @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
|
||||
*/
|
||||
|
@ -54,10 +54,10 @@ class ContainerAwareEventDispatcher extends EventDispatcher
|
||||
/**
|
||||
* Adds a service as event listener
|
||||
*
|
||||
* @param string $eventName Event for which the listener is added
|
||||
* @param array $callback The service ID of the listener service & the method
|
||||
* @param string $eventName Event for which the listener is added
|
||||
* @param array $callback The service ID of the listener service & the method
|
||||
* name that has to be called
|
||||
* @param integer $priority The higher this value, the earlier an event listener
|
||||
* @param integer $priority The higher this value, the earlier an event listener
|
||||
* will be triggered in the chain.
|
||||
* Defaults to 0.
|
||||
*/
|
||||
|
@ -155,8 +155,8 @@ class EventDispatcher implements EventDispatcherInterface
|
||||
* for each listener.
|
||||
*
|
||||
* @param array[callback] $listeners The event listeners.
|
||||
* @param string $eventName The name of the event to dispatch.
|
||||
* @param Event $event The event object to pass to the event handlers/listeners.
|
||||
* @param string $eventName The name of the event to dispatch.
|
||||
* @param Event $event The event object to pass to the event handlers/listeners.
|
||||
*/
|
||||
protected function doDispatch($listeners, $eventName, Event $event)
|
||||
{
|
||||
|
@ -28,7 +28,7 @@ interface EventDispatcherInterface
|
||||
* @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 Event $event The event to pass to the event handlers/listeners.
|
||||
* @param Event $event The event to pass to the event handlers/listeners.
|
||||
* If not supplied, an empty Event instance is created.
|
||||
*
|
||||
* @return Event
|
||||
|
@ -37,8 +37,8 @@ class GenericEvent extends Event implements \ArrayAccess
|
||||
/**
|
||||
* Encapsulate an event with $subject, $args, and $data.
|
||||
*
|
||||
* @param mixed $subject The subject of the event, usually an object.
|
||||
* @param array $arguments Arguments to store in the event.
|
||||
* @param mixed $subject The subject of the event, usually an object.
|
||||
* @param array $arguments Arguments to store in the event.
|
||||
*/
|
||||
public function __construct($subject = null, array $arguments = array())
|
||||
{
|
||||
|
@ -47,8 +47,8 @@ class Filesystem
|
||||
/**
|
||||
* Creates a directory recursively.
|
||||
*
|
||||
* @param string|array|\Traversable $dirs The directory path
|
||||
* @param int $mode The directory mode
|
||||
* @param string|array|\Traversable $dirs The directory path
|
||||
* @param int $mode The directory mode
|
||||
*
|
||||
* @return Boolean true if the directory has been created, false otherwise
|
||||
*/
|
||||
@ -119,8 +119,8 @@ class Filesystem
|
||||
/**
|
||||
* Renames a file.
|
||||
*
|
||||
* @param string $origin The origin filename
|
||||
* @param string $target The new filename
|
||||
* @param string $origin The origin filename
|
||||
* @param string $target The new filename
|
||||
*
|
||||
* @throws \RuntimeException When target file already exists
|
||||
* @throws \RuntimeException When origin cannot be renamed
|
||||
@ -204,10 +204,10 @@ class Filesystem
|
||||
/**
|
||||
* Mirrors a directory to another.
|
||||
*
|
||||
* @param string $originDir The origin directory
|
||||
* @param string $targetDir The target directory
|
||||
* @param \Traversable $iterator A Traversable instance
|
||||
* @param array $options An array of boolean options
|
||||
* @param string $originDir The origin directory
|
||||
* @param string $targetDir The target directory
|
||||
* @param \Traversable $iterator A Traversable instance
|
||||
* @param array $options An array of boolean options
|
||||
* Valid options are:
|
||||
* - $options['override'] Whether to override an existing file on copy or not (see copy())
|
||||
* - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink())
|
||||
|
@ -105,7 +105,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* $finder->depth('> 1') // the Finder will start matching at level 1.
|
||||
* $finder->depth('< 3') // the Finder will descend at most 3 levels of directories below the starting point.
|
||||
*
|
||||
* @param int $level The depth level expression
|
||||
* @param int $level The depth level expression
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -131,7 +131,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* $finder->date('> now - 2 hours');
|
||||
* $finder->date('>= 2005-10-15');
|
||||
*
|
||||
* @param string $date A date rage string
|
||||
* @param string $date A date rage string
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -157,7 +157,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* $finder->name('/\.php$/') // same as above
|
||||
* $finder->name('test.php')
|
||||
*
|
||||
* @param string $pattern A pattern (a regexp, a glob, or a string)
|
||||
* @param string $pattern A pattern (a regexp, a glob, or a string)
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -175,7 +175,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
/**
|
||||
* Adds rules that files must not match.
|
||||
*
|
||||
* @param string $pattern A pattern (a regexp, a glob, or a string)
|
||||
* @param string $pattern A pattern (a regexp, a glob, or a string)
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -198,7 +198,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* $finder->contains('Lorem ipsum')
|
||||
* $finder->contains('/Lorem ipsum/i')
|
||||
*
|
||||
* @param string $pattern A pattern (string or regexp)
|
||||
* @param string $pattern A pattern (string or regexp)
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -220,7 +220,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* $finder->notContains('/Lorem ipsum/i')
|
||||
|
||||
*
|
||||
* @param string $pattern A pattern (string or regexp)
|
||||
* @param string $pattern A pattern (string or regexp)
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -259,7 +259,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
/**
|
||||
* Excludes directories.
|
||||
*
|
||||
* @param string|array $dirs A directory path or an array of directories
|
||||
* @param string|array $dirs A directory path or an array of directories
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -330,7 +330,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
*
|
||||
* This can be slow as all the matching files and directories must be retrieved for comparison.
|
||||
*
|
||||
* @param Closure $closure An anonymous function
|
||||
* @param Closure $closure An anonymous function
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -449,7 +449,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
* The anonymous function receives a \SplFileInfo and must return false
|
||||
* to remove files.
|
||||
*
|
||||
* @param Closure $closure An anonymous function
|
||||
* @param Closure $closure An anonymous function
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
@ -481,7 +481,7 @@ class Finder implements \IteratorAggregate, \Countable
|
||||
/**
|
||||
* Searches files and directories which match defined rules.
|
||||
*
|
||||
* @param string|array $dirs A directory path or an array of directories
|
||||
* @param string|array $dirs A directory path or an array of directories
|
||||
*
|
||||
* @return Finder The current Finder instance
|
||||
*
|
||||
|
@ -38,7 +38,7 @@ class Glob
|
||||
/**
|
||||
* Returns a regexp which is the equivalent of the glob pattern.
|
||||
*
|
||||
* @param string $glob The glob pattern
|
||||
* @param string $glob The glob pattern
|
||||
* @param Boolean $strictLeadingDot
|
||||
* @param Boolean $strictWildcardSlash
|
||||
*
|
||||
|
@ -30,8 +30,8 @@ abstract class AbstractType implements FormTypeInterface
|
||||
*
|
||||
* @see FormTypeExtensionInterface::buildForm()
|
||||
*
|
||||
* @param FormBuilder $builder The form builder
|
||||
* @param array $options The options
|
||||
* @param FormBuilder $builder The form builder
|
||||
* @param array $options The options
|
||||
*/
|
||||
public function buildForm(FormBuilder $builder, array $options)
|
||||
{
|
||||
@ -78,9 +78,9 @@ abstract class AbstractType implements FormTypeInterface
|
||||
* The builder is retrieved by going up in the type hierarchy when a type does
|
||||
* not provide one.
|
||||
*
|
||||
* @param string $name The name of the builder
|
||||
* @param FormFactoryInterface $factory The form factory
|
||||
* @param array $options The options
|
||||
* @param string $name The name of the builder
|
||||
* @param FormFactoryInterface $factory The form factory
|
||||
* @param array $options The options
|
||||
*
|
||||
* @return FormBuilder|null A form builder or null when the type does not have a builder
|
||||
*/
|
||||
|
@ -21,8 +21,8 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
|
||||
*
|
||||
* @see FormTypeInterface::buildForm()
|
||||
*
|
||||
* @param FormBuilder $builder The form builder
|
||||
* @param array $options The options
|
||||
* @param FormBuilder $builder The form builder
|
||||
* @param array $options The options
|
||||
*/
|
||||
public function buildForm(FormBuilder $builder, array $options)
|
||||
{
|
||||
|
@ -28,8 +28,8 @@ class CallbackTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param \Closure $transform The forward transform callback
|
||||
* @param \Closure $reverseTransform The reverse transform callback
|
||||
* @param \Closure $transform The forward transform callback
|
||||
* @param \Closure $reverseTransform The reverse transform callback
|
||||
*/
|
||||
public function __construct(\Closure $transform, \Closure $reverseTransform)
|
||||
{
|
||||
@ -40,7 +40,7 @@ class CallbackTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Transforms a value from the original representation to a transformed representation.
|
||||
*
|
||||
* @param mixed $data The value in the original representation
|
||||
* @param mixed $data The value in the original representation
|
||||
*
|
||||
* @return mixed The value in the transformed representation
|
||||
*
|
||||
@ -56,7 +56,7 @@ class CallbackTransformer implements DataTransformerInterface
|
||||
* Transforms a value from the transformed representation to its original
|
||||
* representation.
|
||||
*
|
||||
* @param mixed $data The value in the transformed representation
|
||||
* @param mixed $data The value in the transformed representation
|
||||
*
|
||||
* @return mixed The value in the original representation
|
||||
*
|
||||
|
@ -39,7 +39,7 @@ interface DataTransformerInterface
|
||||
* By convention, transform() should return an empty string if NULL is
|
||||
* passed.
|
||||
*
|
||||
* @param mixed $value The value in the original representation
|
||||
* @param mixed $value The value in the original representation
|
||||
*
|
||||
* @return mixed The value in the transformed representation
|
||||
*
|
||||
@ -66,7 +66,7 @@ interface DataTransformerInterface
|
||||
* By convention, reverseTransform() should return NULL if an empty string
|
||||
* is passed.
|
||||
*
|
||||
* @param mixed $value The value in the transformed representation
|
||||
* @param mixed $value The value in the transformed representation
|
||||
*
|
||||
* @return mixed The value in the original representation
|
||||
*
|
||||
|
@ -65,14 +65,14 @@ class ChoiceList implements ChoiceListInterface
|
||||
/**
|
||||
* Creates a new choice list.
|
||||
*
|
||||
* @param array|\Traversable $choices The array of choices. Choices may also be given
|
||||
* @param array|\Traversable $choices The array of choices. Choices may also be given
|
||||
* as hierarchy of unlimited depth. Hierarchies are
|
||||
* created by creating nested arrays. The title of
|
||||
* the sub-hierarchy can be stored in the array
|
||||
* key pointing to the nested array.
|
||||
* @param array $labels The array of labels. The structure of this array
|
||||
* @param array $labels The array of labels. The structure of this array
|
||||
* should match the structure of $choices.
|
||||
* @param array $preferredChoices A flat array of choices that should be
|
||||
* @param array $preferredChoices A flat array of choices that should be
|
||||
* presented to the user with priority.
|
||||
*/
|
||||
public function __construct($choices, array $labels, array $preferredChoices = array())
|
||||
@ -85,9 +85,9 @@ class ChoiceList implements ChoiceListInterface
|
||||
*
|
||||
* Safe to be called multiple times. The list is cleared on every call.
|
||||
*
|
||||
* @param array|\Traversable $choices The choices to write into the list.
|
||||
* @param array $labels The labels belonging to the choices.
|
||||
* @param array $preferredChoices The choices to display with priority.
|
||||
* @param array|\Traversable $choices The choices to write into the list.
|
||||
* @param array $labels The labels belonging to the choices.
|
||||
* @param array $preferredChoices The choices to display with priority.
|
||||
*/
|
||||
protected function initialize($choices, array $labels, array $preferredChoices)
|
||||
{
|
||||
@ -240,8 +240,8 @@ class ChoiceList implements ChoiceListInterface
|
||||
* view objects.
|
||||
* @param array $bucketForRemaining The bucket where to store the
|
||||
* non-preferred view objects.
|
||||
* @param array $choices The list of choices.
|
||||
* @param array $labels The labels corresponding to the choices.
|
||||
* @param array $choices The list of choices.
|
||||
* @param array $labels The labels corresponding to the choices.
|
||||
* @param array $preferredChoices The preferred choices.
|
||||
*
|
||||
* @throws UnexpectedTypeException If the structure of the $labels array
|
||||
@ -287,13 +287,13 @@ class ChoiceList implements ChoiceListInterface
|
||||
/**
|
||||
* Recursively adds a choice group.
|
||||
*
|
||||
* @param string $group The name of the group.
|
||||
* @param array $bucketForPreferred The bucket where to store the preferred
|
||||
* @param string $group The name of the group.
|
||||
* @param array $bucketForPreferred The bucket where to store the preferred
|
||||
* view objects.
|
||||
* @param array $bucketForRemaining The bucket where to store the
|
||||
* non-preferred view objects.
|
||||
* @param array $choices The list of choices in the group.
|
||||
* @param array $labels The labels corresponding to the choices in the group.
|
||||
* @param array $choices The list of choices in the group.
|
||||
* @param array $labels The labels corresponding to the choices in the group.
|
||||
* @param array $preferredChoices The preferred choices.
|
||||
*/
|
||||
protected function addChoiceGroup($group, &$bucketForPreferred, &$bucketForRemaining, $choices, $labels, array $preferredChoices)
|
||||
@ -327,9 +327,9 @@ class ChoiceList implements ChoiceListInterface
|
||||
* view objects.
|
||||
* @param array $bucketForRemaining The bucket where to store the
|
||||
* non-preferred view objects.
|
||||
* @param mixed $choice The choice to add.
|
||||
* @param string $label The label for the choice.
|
||||
* @param array $preferredChoices The preferred choices.
|
||||
* @param mixed $choice The choice to add.
|
||||
* @param string $label The label for the choice.
|
||||
* @param array $preferredChoices The preferred choices.
|
||||
*/
|
||||
protected function addChoice(&$bucketForPreferred, &$bucketForRemaining, $choice, $label, array $preferredChoices)
|
||||
{
|
||||
@ -364,7 +364,7 @@ class ChoiceList implements ChoiceListInterface
|
||||
* Extension point to optimize performance by changing the structure of the
|
||||
* $preferredChoices array.
|
||||
*
|
||||
* @param mixed $choice The choice to test.
|
||||
* @param mixed $choice The choice to test.
|
||||
* @param array $preferredChoices An array of preferred choices.
|
||||
*/
|
||||
protected function isPreferred($choice, $preferredChoices)
|
||||
|
@ -90,9 +90,9 @@ class ObjectChoiceList extends ChoiceList
|
||||
*
|
||||
* Safe to be called multiple times. The list is cleared on every call.
|
||||
*
|
||||
* @param array|\Traversable $choices The choices to write into the list.
|
||||
* @param array $labels Ignored.
|
||||
* @param array $preferredChoices The choices to display with priority.
|
||||
* @param array|\Traversable $choices The choices to write into the list.
|
||||
* @param array $labels Ignored.
|
||||
* @param array $preferredChoices The choices to display with priority.
|
||||
*/
|
||||
protected function initialize($choices, array $labels, array $preferredChoices)
|
||||
{
|
||||
|
@ -35,13 +35,13 @@ class SimpleChoiceList extends ChoiceList
|
||||
/**
|
||||
* Creates a new simple choice list.
|
||||
*
|
||||
* @param array $choices The array of choices with the choices as keys and
|
||||
* @param array $choices The array of choices with the choices as keys and
|
||||
* the labels as values. Choices may also be given
|
||||
* as hierarchy of unlimited depth. Hierarchies are
|
||||
* created by creating nested arrays. The title of
|
||||
* the sub-hierarchy is stored in the array
|
||||
* key pointing to the nested array.
|
||||
* @param array $preferredChoices A flat array of choices that should be
|
||||
* @param array $preferredChoices A flat array of choices that should be
|
||||
* presented to the user with priority.
|
||||
*/
|
||||
public function __construct(array $choices, array $preferredChoices = array())
|
||||
@ -125,7 +125,7 @@ class SimpleChoiceList extends ChoiceList
|
||||
* Optimized for performance by treating the preferred choices as array
|
||||
* where choices are stored in the keys.
|
||||
*
|
||||
* @param mixed $choice The choice to test.
|
||||
* @param mixed $choice The choice to test.
|
||||
* @param array $preferredChoices An array of preferred choices.
|
||||
*/
|
||||
protected function isPreferred($choice, $preferredChoices)
|
||||
|
@ -41,7 +41,7 @@ class BooleanToStringTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Transforms a Boolean into a string.
|
||||
*
|
||||
* @param Boolean $value Boolean value.
|
||||
* @param Boolean $value Boolean value.
|
||||
*
|
||||
* @return string String value.
|
||||
*
|
||||
@ -63,7 +63,7 @@ class BooleanToStringTransformer implements DataTransformerInterface
|
||||
/**
|
||||
* Transforms a string into a Boolean.
|
||||
*
|
||||
* @param string $value String value.
|
||||
* @param string $value String value.
|
||||
*
|
||||
* @return Boolean Boolean value.
|
||||
*
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user