Merge remote branch 'pborreli/phpdoc-fix'

* pborreli/phpdoc-fix:
  [Phpdoc] Cleaning/fixing
  [FrameworkBundle] Fixed typo in css
This commit is contained in:
Fabien Potencier 2011-04-23 21:50:16 +02:00
commit 278223d950
161 changed files with 459 additions and 407 deletions

View File

@ -30,10 +30,9 @@ class EntitiesToArrayTransformer implements DataTransformerInterface
/**
* Transforms entities into choice keys
*
* @param Collection|object A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or
* @param Collection|object $collection A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or NULL
*/
public function transform($collection)
{

View File

@ -28,10 +28,9 @@ class EntityToIdTransformer implements DataTransformerInterface
/**
* Transforms entities into choice keys
*
* @param Collection|object A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or
* @param Collection|object $entity A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or NULL
*/
public function transform($entity)
{

View File

@ -96,6 +96,7 @@ class FormExtension extends \Twig_Extension
* Renders a row for the view.
*
* @param FormView $view The view to render as a row
* @param array $variables An array of variables
*/
public function renderRow(FormView $view, array $variables = array())
{
@ -123,8 +124,7 @@ class FormExtension extends \Twig_Extension
* {{ form_widget(view, {}, {'separator': '+++++'}) }}
*
* @param FormView $view The view to render
* @param array $attributes HTML attributes passed to the template
* @param array $parameters Additional variables passed to the template
* @param array $variables Additional variables passed to the template
* @param array|string $resources A resource or array of resources
*/
public function renderWidget(FormView $view, array $variables = array(), $resources = null)
@ -140,7 +140,6 @@ class FormExtension extends \Twig_Extension
* Renders the errors of the given view
*
* @param FormView $view The view to render the errors for
* @param array $params Additional variables passed to the template
*/
public function renderErrors(FormView $view)
{
@ -151,6 +150,7 @@ 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
*/
public function renderLabel(FormView $view, $label = null)
{

View File

@ -26,7 +26,7 @@ class FormThemeNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -26,7 +26,7 @@ class TransNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -46,7 +46,7 @@ class FormThemeTokenParser extends \Twig_TokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -80,7 +80,7 @@ class TransChoiceTokenParser extends TransTokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -72,7 +72,7 @@ class TransTokenParser extends \Twig_TokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -112,7 +112,7 @@ class DumpCommand extends Command
*
* @param LazyAssetManager $am The asset manager
* @param string $name The asset name
* @param array $previously An array of previous visits
* @param array &$previously An array of previous visits
*
* @return AssetInterface|Boolean The asset if it should be dumped
*/

View File

@ -26,7 +26,8 @@ class ConnectionFactory
private $initialized = false;
/**
* @param ContainerInterface $container
* Construct.
*
* @param array $typesConfig
*/
public function __construct(array $typesConfig)
@ -38,6 +39,9 @@ class ConnectionFactory
* Create a connection by name.
*
* @param string $connectionName
* @param Configuration $config
* @param EventManager $eventManager
*
* @return Doctrine\DBAL\Connection
*/
public function createConnection(array $params, Configuration $config = null, EventManager $eventManager = null)

View File

@ -26,8 +26,7 @@ class ClassMapCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param KernelInterface $kernel A KernelInterface instance
* @param string $rootDir The directory where global templates can be stored
* @param ContainerInterface $container The container
*/
public function __construct(ContainerInterface $container)
{

View File

@ -26,7 +26,7 @@ class RouterCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param router $router A Router instance
* @param Router $router A Router instance
*/
public function __construct(Router $router)
{

View File

@ -29,6 +29,8 @@ class Application extends BaseApplication
/**
* Constructor.
*
* @param KernelInterface $kernel A KernelInterface instance
*/
public function __construct(KernelInterface $kernel)
{

View File

@ -312,6 +312,7 @@ class FrameworkExtension extends Extension
* Loads the templating configuration.
*
* @param array $config A templating configuration array
* @param string $ide
* @param ContainerBuilder $container A ContainerBuilder instance
* @param XmlFileLoader $loader An XmlFileLoader instance
*/

View File

@ -43,7 +43,7 @@ abstract class HttpCache extends BaseHttpCache
*
* @param Request $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Response $response A Response instance (the stale entry if present, null otherwise)
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/

View File

@ -38,7 +38,7 @@ class ProfilerListener
* @param ContainerInterface $container A ContainerInterface instance
* @param RequestMatcherInterface $matcher A RequestMatcher instance
* @param Boolean $onlyException true if the profiler only collects data when an exception occurs, false otherwise
* @param Boolean $onlyMaster true if the profiler only collects data when the request is a master request, false otherwise
* @param Boolean $onlyMasterRequests true if the profiler only collects data when the request is a master request, false otherwise
*/
public function __construct(ContainerInterface $container, RequestMatcherInterface $matcher = null, $onlyException = false, $onlyMasterRequests = false)
{

View File

@ -255,7 +255,7 @@ build: 56
.sf-exceptionreset ol li {
list-style: decimal;
margin-left: 20px;
padding: 2px,
padding: 2px;
padding-bottom: 20px;
}
@ -265,7 +265,7 @@ build: 56
margin-left: 0;
white-space: nowrap;
font-size: 12px;
padding-bottom: 0px;
padding-bottom: 0;
}
.sf-exceptionreset li .selected
{

View File

@ -22,7 +22,7 @@ img
.clear
{
clear:both;
height:0px;
height:0;
font-size:0;
line-height:0;
}
@ -97,7 +97,6 @@ img
{
-webkit-appearance: button-bevel;
float: none;
text-align: left;
padding: 0;
margin: 0;
overflow: visible;
@ -148,7 +147,7 @@ img
.search button span span span
{
padding: 0px 7px;
padding: 0 7px;
font: bold 11px Arial, Helvetica, sans-serif;
color: #6b6b6b;
line-height: 28px;

View File

@ -29,6 +29,7 @@ class DelegatingEngine extends BaseDelegatingEngine implements EngineInterface
* Constructor.
*
* @param ContainerInterface $container The DI container
* @param array $engineIds An array of engine Ids
*/
public function __construct(ContainerInterface $container, array $engineIds)
{

View File

@ -72,7 +72,9 @@ class FormHelper extends Helper
/**
* Renders the entire form field "row".
*
* @param FieldInterface $field
* @param FormView $view
* @param array $variables
*
* @return string
*/
public function row(FormView $view, array $variables = array())

View File

@ -28,7 +28,6 @@ class CachedTemplateLocator extends TemplateLocator
*
* @param string $cacheDir The cache path
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param string $path A global fallback path
*/
public function __construct($cacheDir, FileLocatorInterface $locator)
{

View File

@ -32,6 +32,7 @@ class PhpEngine extends BasePhpEngine implements EngineInterface
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param ContainerInterface $container The DI container
* @param LoaderInterface $loader A loader instance
* @param GlobalVariables $globals A GlobalVariables instance
*/
public function __construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals)
{

View File

@ -40,6 +40,7 @@ class Translator extends BaseTranslator
*
* @param ContainerInterface $container A ContainerInterface instance
* @param MessageSelector $selector The message selector for pluralization
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
* @param Session $session A Session instance
*/

View File

@ -45,6 +45,7 @@ class ConstraintValidatorFactory implements ConstraintValidatorFactoryInterface
* Constructor.
*
* @param ContainerInterface $container The service container
* @param array $validators An array of validators
*/
public function __construct(ContainerInterface $container, array $validators = array())
{

View File

@ -91,7 +91,7 @@ abstract class AbstractFactory implements SecurityFactoryInterface
*
* @param ContainerBuilder $container
* @param string $id The unique id of the firewall
* @param array $options The options array for this listener
* @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

View File

@ -27,7 +27,7 @@ class SecurityHelper extends Helper
/**
* Constructor.
*
* @param SecurityContext $context A SecurityContext instance
* @param SecurityContextInterface $context A SecurityContext instance
*/
public function __construct(SecurityContextInterface $context = null)
{

View File

@ -36,7 +36,7 @@ class SwiftmailerExtension extends Extension
* <swiftmailer:spool path="/path/to/spool/" />
* </swiftmailer:config>
*
* @param array $config An array of configuration settings
* @param array $configs An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function load(array $configs, ContainerBuilder $container)

View File

@ -31,6 +31,7 @@ class FilesystemLoader implements \Twig_LoaderInterface
* Constructor.
*
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
*/
public function __construct(FileLocatorInterface $locator, TemplateNameParserInterface $parser)
{

View File

@ -26,7 +26,7 @@ class RenderNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -200,6 +200,7 @@ class ProfilerController extends ContainerAware
/**
* Search results.
*
* @param string $token The token
* @return Response A Response instance
*/
public function searchResultsAction($token)

View File

@ -34,7 +34,7 @@ class WebProfilerExtension extends Extension
/**
* Loads the web profiler configuration.
*
* @param array $config An array of configuration settings
* @param array $configs An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function load(array $configs, ContainerBuilder $container)

View File

@ -109,7 +109,7 @@ abbr
.clear
{
clear:both;
height:0px;
height:0;
font-size:0;
line-height:0;
}
@ -192,7 +192,7 @@ abbr
{
display: block;
position: absolute;
left: 0px;
left: 0;
top: 12px;
width: 60px;
text-align: center;
@ -394,10 +394,9 @@ td.main, td.menu {
{
-webkit-appearance: button-bevel;
float: none;
display: block;
padding: 0;
margin: 0;
border: 0px solid #000000;
border: 0 solid #000;
text-decoration: none;
cursor: pointer;
background-color: transparent;
@ -405,7 +404,6 @@ td.main, td.menu {
display: inline-block;
text-align: center;
vertical-align: middle;
border: 0;
background: none;
}
@ -439,7 +437,7 @@ td.main, td.menu {
.search button span span span
{
padding: 0px 7px;
padding: 0 7px;
font: bold 11px Arial, Helvetica, sans-serif;
color: #6b6b6b;
line-height: 28px;

View File

@ -76,7 +76,7 @@ class CookieJar
* Updates the cookie jar from a Response object.
*
* @param Response $response A Response object
* @param string $url The base URL
* @param string $uri The base URL
*/
public function updateFromResponse(Response $response, $uri = null)
{

View File

@ -53,7 +53,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Set a custom children builder
*
* @param NodeBuilder $class A custom NodeBuilder
* @param NodeBuilder $builder A custom NodeBuilder
*/
public function setBuilder(NodeBuilder $builder)
{

View File

@ -27,7 +27,7 @@ class ExprBuilder
/**
* Constructor
*
* @param NodeDefinition $parent The related node
* @param NodeDefinition $node The related node
*/
public function __construct(NodeDefinition $node)
{

View File

@ -74,7 +74,7 @@ abstract class NodeDefinition implements NodeParentInterface
/**
* Creates the node.
*
* @param Boolean $forceRootNode Wether to force this node as the root node
* @param Boolean $forceRootNode Whether to force this node as the root node
*
* @return NodeInterface
*/

View File

@ -27,6 +27,8 @@ abstract class FileLoader extends Loader
/**
* Constructor.
*
* @param FileLocatorInterface $locator A FileLocatorInterface instance
*/
public function __construct(FileLocatorInterface $locator)
{

View File

@ -73,7 +73,7 @@ class OutputFormatter implements OutputFormatterInterface
* Sets a new style.
*
* @param string $name The style name
* @param OutputFormatterStyleInterface $options The style instance
* @param OutputFormatterStyleInterface $style The style instance
*
* @api
*/

View File

@ -42,7 +42,7 @@ interface OutputFormatterInterface
* Sets a new style.
*
* @param string $name The style name
* @param OutputFormatterStyleInterface $options The style instance
* @param OutputFormatterStyleInterface $style The style instance
*
* @api
*/

View File

@ -111,7 +111,7 @@ class ArgvInput extends Input
/**
* Parses a short option set.
*
* @param string $token The current token
* @param string $name The current token
*
* @throws \RuntimeException When option given doesn't exist
*/

View File

@ -29,7 +29,7 @@ class ArrayInput extends Input
/**
* Constructor.
*
* @param array $param An array of parameters
* @param array $parameters An array of parameters
* @param InputDefinition $definition A InputDefinition instance
*
* @api
@ -63,7 +63,7 @@ class ArrayInput extends Input
* This method is to be used to introspect the input parameters
* before it has been validated. It must be used carefully.
*
* @param string|array $value The values to look for in the raw parameters (can be an array)
* @param string|array $values The values to look for in the raw parameters (can be an array)
*
* @return Boolean true if the value is contained in the raw parameters
*/

View File

@ -33,7 +33,8 @@ class ConsoleOutput extends StreamOutput
/**
* Constructor.
*
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @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
*

View File

@ -36,7 +36,8 @@ class StreamOutput extends Output
* Constructor.
*
* @param mixed $stream A stream resource
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @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
*

View File

@ -27,7 +27,7 @@ class ApplicationTester
/**
* Constructor.
*
* @param Application $application A Application instance to test.
* @param Application $application An Application instance to test.
*/
public function __construct(Application $application)
{

View File

@ -78,8 +78,8 @@ class FunctionNode implements NodeInterface
*
* @param XPathExpr $xpath
* @param mixed $expr
* @param string $last
* @param string $addNameTest
* @param Boolean $last
* @param Boolean $addNameTest
* @return XPathExpr
*/
protected function _xpath_nth_child($xpath, $expr, $last = false, $addNameTest = true)

View File

@ -168,7 +168,7 @@ class Parser
*
* @throws SyntaxError When expected symbol but got something else
*
* @param TokenStream The stream containing the selector.
* @param TokenStream $stream The stream containing the selector.
*
* @return Node\NodeInterface
*/

View File

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

View File

@ -148,7 +148,7 @@ class Container implements ContainerInterface
* Sets a parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param mixed $value The parameter value
*/
public function setParameter($name, $value)
{
@ -202,7 +202,7 @@ class Container implements ContainerInterface
* with a set*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 integer $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*

View File

@ -267,7 +267,7 @@ 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 integer $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*
@ -427,7 +427,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Sets the service aliases.
*
* @param array $definitions An array of service definitions
* @param array $aliases An array of service definitions
*/
public function setAliases(array $aliases)
{

View File

@ -81,7 +81,7 @@ interface ContainerInterface
* Sets a parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param mixed $value The parameter value
*/
function setParameter($name, $value);

View File

@ -411,7 +411,7 @@ class Definition
/**
* Sets the scope of the service
*
* @param string $string Whether the service must be shared or not
* @param string $scope Whether the service must be shared or not
*
* @return Definition The current instance
*/

View File

@ -38,7 +38,7 @@ class ClosureLoader extends Loader
/**
* Loads a Closure.
*
* @param \Closure $resource The resource
* @param \Closure $closure The resource
* @param string $type The resource type
*/
public function load($closure, $type = null)

View File

@ -26,7 +26,7 @@ class PhpFileLoader extends FileLoader
/**
* Loads a PHP file.
*
* @param mixed $resource The resource
* @param mixed $file The resource
* @param string $type The resource type
*/
public function load($file, $type = null)

View File

@ -32,7 +32,7 @@ class YamlFileLoader extends FileLoader
/**
* Loads a Yaml file.
*
* @param mixed $resource The resource
* @param mixed $file The resource
* @param string $type The resource type
*/
public function load($file, $type = null)

View File

@ -84,7 +84,7 @@ class ParameterBag implements ParameterBagInterface
* Sets a service container parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param mixed $value The parameter value
*/
public function set($name, $value)
{

View File

@ -52,7 +52,7 @@ interface ParameterBagInterface
* Sets a service container parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param mixed $value The parameter value
*/
function set($name, $value);

View File

@ -33,6 +33,8 @@ class SimpleXMLElement extends \SimpleXMLElement
* Returns arguments as valid php types.
*
* @param string $name
* @param Boolean $lowercase
*
* @return mixed
*/
public function getArgumentsAsPhp($name, $lowercase = true)

View File

@ -591,7 +591,7 @@ class Crawler extends \SplObjectStorage
/**
* Returns a Form object for the first node in the list.
*
* @param array $arguments An array of values for the form fields
* @param array $values An array of values for the form fields
* @param string $method The method for the form
*
* @return Form A Form instance

View File

@ -262,7 +262,7 @@ class Form extends Link implements \ArrayAccess
/**
* Sets a named field.
*
* @param string $name The field name
* @param Field\FormField $field The field
*
* @return FormField The field instance
*

View File

@ -39,6 +39,8 @@ class Glob
* Returns a regexp which is the equivalent of the glob pattern.
*
* @param string $glob The glob pattern
* @param Boolean $strictLeadingDot
* @param Boolean $strictWildcardSlash
*
* @return string regex The regexp
*/

View File

@ -24,7 +24,7 @@ class SplFileInfo extends \SplFileInfo
/**
* Constructor
*
* @param string $fileInfo The file name
* @param string $file The file name
* @param string $relativePath The relative path
* @param string $relativePathname The relative path name
*/

View File

@ -27,8 +27,8 @@ class PaddedChoiceList extends ArrayChoiceList
*
* @param array $values The available choices
* @param integer $padLength The length to pad the choices
* @return array An array with the input values as keys and the
* padded values as values
* @param string $padString The padding character
* @param integer $padType The direction of padding
*/
public function __construct($values, $padLength, $padString, $padType = STR_PAD_LEFT)
{

View File

@ -33,7 +33,7 @@ class ArrayToBooleanChoicesTransformer implements DataTransformerInterface
* depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified.
*
* @param mixed $value An array if "multiple" is set to true, a scalar
* @param mixed $array An array if "multiple" is set to true, a scalar
* value otherwise.
* @return mixed An array if "expanded" or "multiple" is set to true,
* a scalar value otherwise.

View File

@ -29,7 +29,9 @@ class DelegatingValidator implements FormValidatorInterface
}
/**
* Validates the form and its domain object
* Validates the form and its domain object.
*
* @param FormInterface $form A FormInterface instance
*/
public function validate(FormInterface $form)
{

View File

@ -387,7 +387,7 @@ class Form implements \IteratorAggregate, FormInterface
/**
* Binds POST data to the field, transforms and validates it.
*
* @param string|array $data The POST data
* @param string|array $clientData The POST data
*/
public function bind($clientData)
{
@ -503,8 +503,6 @@ class Form implements \IteratorAggregate, FormInterface
* constructor.
*
* @param Request $request The request to bind to the form
* @param array|object $data The data from which to read default values
* and where to write bound values
*/
public function bindRequest(Request $request)
{

View File

@ -191,7 +191,7 @@ class FormBuilder
/**
* Prepends a transformer to the client transformer chain
*
* @param DataTransformerInterface $clientTransformer
* @param DataTransformerInterface $normTransformer
*/
public function prependNormTransformer(DataTransformerInterface $normTransformer = null)
{
@ -336,7 +336,9 @@ class FormBuilder
* $form->add($locationGroup);
* </code>
*
* @param FormInterface|string $form
* @param string $name
* @param string|FormTypeInterface $type
* @param array $options
* @return FormInterface
*/
public function add($name, $type = null, array $options = array())

View File

@ -30,7 +30,7 @@ class ReversedTransformer implements DataTransformerInterface
/**
* Reverses this transformer
*
* @param DataTransformerInterface $innerTransformer
* @param DataTransformerInterface $reversedTransformer
*/
public function __construct(DataTransformerInterface $reversedTransformer)
{

View File

@ -51,7 +51,7 @@ class PropertyPath implements \IteratorAggregate
/**
* Parses the given property path
*
* @param string $this
* @param string $propertyPath
*/
public function __construct($propertyPath)
{
@ -125,6 +125,8 @@ class PropertyPath implements \IteratorAggregate
/**
* Returns the element at the given index in the property path
*
* @param $index The index key
*
* @return string A property or index name
*/
public function getElement($index)
@ -208,7 +210,7 @@ class PropertyPath implements \IteratorAggregate
* If neither is found, an exception is thrown.
*
* @param object|array $objectOrArray The object or array to traverse
* @return mixed The value at the end of the
* @param mixed $value The value at the end of the
* property path
* @throws InvalidPropertyException If the property/setter does not
* exist
@ -346,7 +348,7 @@ class PropertyPath implements \IteratorAggregate
/**
* Sets the value of the property at the given index in the path
*
* @param object $object The object or array to traverse
* @param object $objectOrArray The object or array to traverse
* @param integer $currentIndex The index of the modified property in the
* path
* @param mixed $value The value to set

View File

@ -26,7 +26,7 @@ class FileBag extends ParameterBag
/**
* Constructor.
*
* @param array $headers An array of HTTP files
* @param array $parameters An array of HTTP files
*/
public function __construct(array $parameters = array())
{

View File

@ -66,7 +66,7 @@ class RequestMatcher implements RequestMatcherInterface
/**
* Adds a check for the HTTP method.
*
* @param string|array An HTTP method or an array of HTTP methods
* @param string|array $method An HTTP method or an array of HTTP methods
*/
public function matchMethod($method)
{

View File

@ -29,7 +29,7 @@ class Session implements \Serializable
/**
* Constructor.
*
* @param SessionStorageInterface $session A SessionStorageInterface instance
* @param SessionStorageInterface $storage A SessionStorageInterface instance
* @param string $defaultLocale The default locale
*/
public function __construct(SessionStorageInterface $storage, $defaultLocale = 'en')

View File

@ -101,6 +101,7 @@ class NativeSessionStorage implements SessionStorageInterface
* The preferred format for a key is directory style so naming conflicts can be avoided.
*
* @param string $key A unique key identifying your data
* @param string $default Default value
*
* @return mixed Data associated with the key
*/

View File

@ -25,7 +25,7 @@ class PdoSessionStorage extends NativeSessionStorage
/**
* Constructor.
*
* @param \PDO $pdo A PDO instance
* @param \PDO $db A PDO instance
* @param array $options An associative array of session options
* @param array $dbOptions An associative array of DB options
*

View File

@ -91,7 +91,7 @@ EOF;
/**
* Converts the BrowserKit request to a HttpKernel request.
*
* @param Request $request A Request instance
* @param DomRequest $request A Request instance
*
* @return Request A Request instance
*/

View File

@ -201,7 +201,7 @@ class HttpCache implements HttpKernelInterface
* Forwards the Request to the backend without storing the Response in the cache.
*
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
* @param Boolean $catch Whether to process exceptions
*
* @return Response A Response instance
*/
@ -216,7 +216,7 @@ class HttpCache implements HttpKernelInterface
* Invalidates non-safe methods (like POST, PUT, and DELETE).
*
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
* @param Boolean $catch Whether to process exceptions
*
* @return Response A Response instance
*
@ -400,7 +400,7 @@ class HttpCache implements HttpKernelInterface
*
* @param Request $request A Request instance
* @param Boolean $catch Whether to catch exceptions or not
* @param Response $response A Response instance (the stale entry if present, null otherwise)
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/
@ -537,6 +537,7 @@ class HttpCache implements HttpKernelInterface
/**
* Restores the Response body.
*
* @param Request $request A Request instance
* @param Response $response A Response instance
*
* @return Response A Response instance
@ -610,6 +611,7 @@ class HttpCache implements HttpKernelInterface
/**
* Records that an event took place.
*
* @param Request $request A Request instance
* @param string $event The event name
*/
private function record(Request $request, $event)

View File

@ -25,7 +25,6 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
* Creates a Client.
*
* @param array $options An array of options to pass to the createKernel class
* @param Boolean $debug The debug flag
* @param array $server An array of server parameters
*
* @return Client A Client instance

View File

@ -19,7 +19,7 @@ class MethodNotImplementedException extends NotImplementedException
/**
* Constructor
*
* @param string $message The exception message. A note to install the intl extension is appended to this string
* @param string $methodName The name of the method
*/
public function __construct($methodName)
{

View File

@ -135,6 +135,8 @@ class StubLocale
/**
* Returns the currencies data
*
* @param string $locale
*
* @return array The currencies data
*/
static public function getCurrenciesData($locale)
@ -205,6 +207,7 @@ class StubLocale
*
* @param string $langtag The language tag to check
* @param string $locale The language range to check against
* @param Boolean $canonicalize
* @return string The corresponding locale code
* @see http://www.php.net/manual/en/locale.filtermatches.php
* @throws MethodNotImplementedException

View File

@ -29,6 +29,7 @@ class AnnotationFileLoader extends FileLoader
/**
* Constructor.
*
* @param FileLocator $locator A FileLocator instance
* @param AnnotationClassLoader $loader An AnnotationClassLoader instance
* @param string|array $paths A path or an array of paths where to look for resources
*/

View File

@ -26,7 +26,7 @@ class PhpFileLoader extends FileLoader
/**
* Loads a PHP file.
*
* @param mixed $resource A PHP file path
* @param mixed $file A PHP file path
* @param string $type The resource type
*/
public function load($file, $type = null)

View File

@ -214,6 +214,7 @@ class Route
/**
* Returns the requirement for the given key.
*
* @param string $key The key
* @return string The regex
*/
public function getRequirement($key)
@ -224,8 +225,8 @@ class Route
/**
* Sets a requirement for the given key.
*
* @param string The key
* @param string The regex
* @param string $key The key
* @param string $regex The regex
*/
public function setRequirement($key, $regex)
{

View File

@ -43,7 +43,7 @@ class Router implements RouterInterface
* @param LoaderInterface $loader A LoaderInterface instance
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param array $context The context
* @param RequestContext $context The context
* @param array $defaults The default values
*
* @throws \InvalidArgumentException When unsupported option is provided

View File

@ -46,7 +46,7 @@ class AclProvider implements AclProviderInterface
private $permissionGrantingStrategy;
/**
* Constructor
* Constructor.
*
* @param Connection $connection
* @param PermissionGrantingStrategyInterface $permissionGrantingStrategy

View File

@ -27,7 +27,7 @@ class AclCollectionCache
private $securityIdentityRetrievalStrategy;
/**
* Constructor
* Constructor.
*
* @param AclProviderInterface $aclProvider
* @param ObjectIdentityRetrievalStrategy $oidRetrievalStrategy

View File

@ -36,6 +36,7 @@ class DoctrineAclCache implements AclCacheInterface
* @param Cache $cache
* @param PermissionGrantingStrategyInterface $permissionGrantingStrategy
* @param string $prefix
*
* @return void
*/
public function __construct(Cache $cache, PermissionGrantingStrategyInterface $permissionGrantingStrategy, $prefix = self::PREFIX)

View File

@ -26,7 +26,7 @@ class ObjectIdentity implements ObjectIdentityInterface
private $type;
/**
* Constructor
* Constructor.
*
* @param string $identifier
* @param string $type

View File

@ -129,10 +129,10 @@ class PermissionGrantingStrategy implements PermissionGrantingStrategyInterface
* access finally.
*
* @param AclInterface $acl
* @param array $aces an array of ACE to check against
* @param array $masks an array of permission masks
* @param array $sids an array of SecurityIdentityInterface implementations
* @param Boolean $administrativeMode true turns off audit logging
* @param array $aces An array of ACE to check against
* @param array $masks An array of permission masks
* @param array $sids An array of SecurityIdentityInterface implementations
* @param Boolean $administrativeMode True turns off audit logging
* @return Boolean true, or false; either granting, or denying access respectively.
*/
private function hasSufficientPermissions(AclInterface $acl, array $aces, array $masks, array $sids, $administrativeMode)

View File

@ -35,6 +35,7 @@ class SecurityIdentityRetrievalStrategy implements SecurityIdentityRetrievalStra
*
* @param RoleHierarchyInterface $roleHierarchy
* @param AuthenticationTrustResolver $authenticationTrustResolver
*
* @return void
*/
public function __construct(RoleHierarchyInterface $roleHierarchy, AuthenticationTrustResolver $authenticationTrustResolver)

View File

@ -37,6 +37,7 @@ interface PermissionGrantingStrategyInterface
* @param array $masks
* @param array $sids
* @param Boolean $administrativeMode
*
* @return Boolean
*/
function isFieldGranted(AclInterface $acl, $field, array $masks, array $sids, $administrativeMode = false);

View File

@ -138,6 +138,8 @@ class AclVoter implements VoterInterface
* You can override this method when writing a voter for a specific domain
* class.
*
* @param string $class The class name
*
* @return Boolean
*/
public function supportsClass($class)

View File

@ -35,9 +35,11 @@ class DaoAuthenticationProvider extends UserAuthenticationProvider
/**
* Constructor.
*
* @param UserProviderInterface $userProvider A UserProviderInterface instance
* @param UserProviderInterface $userProvider An UserProviderInterface instance
* @param UserCheckerInterface $userChecker An UserCheckerInterface instance
* @param EncoderFactoryInterface $encoderFactory A EncoderFactoryInterface instance
* @param string $providerKey The provider key
* @param EncoderFactoryInterface $encoderFactory An EncoderFactoryInterface instance
* @param Boolean $hideUserNotFoundExceptions Whether to hide user not found exception or not
*/
public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, $providerKey, EncoderFactoryInterface $encoderFactory, $hideUserNotFoundExceptions = true)
{

View File

@ -37,8 +37,9 @@ class PreAuthenticatedAuthenticationProvider implements AuthenticationProviderIn
/**
* Constructor.
*
* @param UserProviderInterface $userProvider A UserProviderInterface instance
* @param UserProviderInterface $userProvider An UserProviderInterface instance
* @param UserCheckerInterface $userChecker An UserCheckerInterface instance
* @param string $providerKey The provider key
*/
public function __construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, $providerKey)
{

View File

@ -35,6 +35,7 @@ abstract class UserAuthenticationProvider implements AuthenticationProviderInter
* Constructor.
*
* @param UserCheckerInterface $userChecker An UserCheckerInterface interface
* @param string $providerKey A provider key
* @param Boolean $hideUserNotFoundExceptions Whether to hide user not found exception or not
*/
public function __construct(UserCheckerInterface $userChecker, $providerKey, $hideUserNotFoundExceptions = true)

View File

@ -26,6 +26,10 @@ class UsernamePasswordToken extends AbstractToken
*
* @param string $user The username (like a nickname, email address, etc.)
* @param string $credentials This usually is the password of the user
* @param string $providerKey The provider key
* @param array $roles An array of roles
*
* @throws \InvalidArgumentException
*/
public function __construct($user, $credentials, $providerKey, array $roles = array())
{

View File

@ -33,6 +33,7 @@ class AccessDecisionManager implements AccessDecisionManagerInterface
* @param VoterInterface[] $voters An array of VoterInterface instances
* @param string $strategy The vote strategy
* @param Boolean $allowIfAllAbstainDecisions Whether to grant access if all voters abstained or not
* @param Boolean $allowIfEqualGrantedDeniedDecisions Whether to grant access if result are equals
*/
public function __construct(array $voters, $strategy = 'affirmative', $allowIfAllAbstainDecisions = false, $allowIfEqualGrantedDeniedDecisions = true)
{

View File

@ -36,7 +36,9 @@ class SecurityContext implements SecurityContextInterface
/**
* Constructor.
*
* @param AuthenticationManagerInterface $authenticationManager An AuthenticationManager instance
* @param AccessDecisionManagerInterface|null $accessDecisionManager An AccessDecisionManager instance
* @param Boolean $alwaysAuthenticate
*/
public function __construct(AuthenticationManagerInterface $authenticationManager, AccessDecisionManagerInterface $accessDecisionManager, $alwaysAuthenticate = false)
{

View File

@ -33,7 +33,6 @@ class InMemoryUserProvider implements UserProviderInterface
* an array of attributes: 'password', 'enabled', and 'roles'.
*
* @param array $users An array of users
* @param string $name
*/
public function __construct(array $users = array())
{

View File

@ -36,6 +36,7 @@ class Firewall
* Constructor.
*
* @param FirewallMap $map A FirewallMap instance
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
*/
public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
{

View File

@ -39,6 +39,7 @@ class LogoutListener implements ListenerInterface
* @param SecurityContextInterface $securityContext
* @param string $logoutPath The path that starts the logout process
* @param string $targetUrl The URL to redirect to after logout
* @param LogoutSuccessHandlerInterface $successHandler
*/
public function __construct(SecurityContextInterface $securityContext, $logoutPath, $targetUrl = '/', LogoutSuccessHandlerInterface $successHandler = null)
{

View File

@ -45,6 +45,8 @@ abstract class AbstractRememberMeServices implements RememberMeServicesInterface
* Constructor
*
* @param array $userProviders
* @param string $key
* @param string $providerKey
* @param array $options
* @param LoggerInterface $logger
*/

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