minor #11483 fix some docblocks (xabbuh)
This PR was merged into the 2.3 branch.
Discussion
----------
fix some docblocks
| Q | A
| ------------- | ---
| Bug fix? | yes
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets |
| License | MIT
| Doc PR |
Commits
-------
1775da5 fix some docblocks
This commit is contained in:
Fabien Potencier
commit
abf2edf81a
|
|
@ -74,7 +74,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
|
|||
* @param string[] $managerParameters list of container parameters
|
||||
* that could hold the manager name
|
||||
* @param string $driverPattern pattern to get the metadata driver service names
|
||||
* @param string $enabledParameter service container parameter that must be
|
||||
* @param string|false $enabledParameter service container parameter that must be
|
||||
* present to enable the mapping. Set to false
|
||||
* to not do any check, optional.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -80,6 +80,9 @@ class ModelChoiceList extends ObjectChoiceList
|
|||
* Either an array if $choices is given,
|
||||
* or a ModelCriteria to be merged with the $queryObject.
|
||||
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths.
|
||||
*
|
||||
* @throws MissingOptionsException when no model class is given
|
||||
* @throws InvalidOptionsException when the model class cannot be found
|
||||
*/
|
||||
public function __construct($class, $labelPath = null, $choices = null, $queryObject = null, $groupPath = null, $preferred = array(), PropertyAccessorInterface $propertyAccessor = null)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -287,6 +287,7 @@ abstract class BaseNode implements NodeInterface
|
|||
*
|
||||
* @return mixed The finalized value
|
||||
*
|
||||
* @throws Exception
|
||||
* @throws InvalidConfigurationException
|
||||
*/
|
||||
final public function finalize($value)
|
||||
|
|
|
|||
|
|
@ -884,6 +884,8 @@ class Application
|
|||
* @param OutputInterface $output An Output instance
|
||||
*
|
||||
* @return int 0 if everything went fine, or an error code
|
||||
*
|
||||
* @throws \Exception when the command being run threw an exception
|
||||
*/
|
||||
protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -48,9 +48,11 @@ class DescriptorHelper extends Helper
|
|||
*
|
||||
* @param OutputInterface $output
|
||||
* @param object $object
|
||||
* @param string $format
|
||||
* @param string|null $format
|
||||
* @param bool $raw
|
||||
* @param string $namespace
|
||||
* @param string|null $namespace
|
||||
*
|
||||
* @throws \InvalidArgumentException when the given format is not supported
|
||||
*/
|
||||
public function describe(OutputInterface $output, $object, $format = null, $raw = false, $namespace = null)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -321,7 +321,7 @@ class DialogHelper extends Helper
|
|||
* @param OutputInterface $output An Output instance
|
||||
* @param string|array $question The question to ask
|
||||
* @param callable $validator A PHP callback
|
||||
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
|
||||
* @param int|false $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 array $autocomplete List of values to autocomplete
|
||||
*
|
||||
|
|
@ -350,7 +350,7 @@ class DialogHelper extends Helper
|
|||
* @param OutputInterface $output An Output instance
|
||||
* @param string|array $question The question to ask
|
||||
* @param callable $validator A PHP callback
|
||||
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
|
||||
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
|
||||
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
|
||||
*
|
||||
* @return string The response
|
||||
|
|
@ -444,7 +444,7 @@ class DialogHelper extends Helper
|
|||
* @param callable $interviewer A callable that will ask for a question and return the result
|
||||
* @param OutputInterface $output An Output instance
|
||||
* @param callable $validator A PHP callback
|
||||
* @param int $attempts Max number of times to ask before giving up ; false will ask infinitely
|
||||
* @param int|false $attempts Max number of times to ask before giving up ; false will ask infinitely
|
||||
*
|
||||
* @return string The validated response
|
||||
*
|
||||
|
|
|
|||
|
|
@ -78,6 +78,8 @@ class TableHelper extends Helper
|
|||
* @param int $layout self::LAYOUT_*
|
||||
*
|
||||
* @return TableHelper
|
||||
*
|
||||
* @throws InvalidArgumentException when the table layout is not known
|
||||
*/
|
||||
public function setLayout($layout)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -266,9 +266,10 @@ class Container implements IntrospectableContainerInterface
|
|||
*
|
||||
* @return object The associated service
|
||||
*
|
||||
* @throws InvalidArgumentException if the service is not defined
|
||||
* @throws InvalidArgumentException if the service is not defined
|
||||
* @throws ServiceCircularReferenceException When a circular reference is detected
|
||||
* @throws ServiceNotFoundException When the service is not defined
|
||||
* @throws ServiceNotFoundException When the service is not defined
|
||||
* @throws \Exception if an exception has been thrown when the service has been resolved
|
||||
*
|
||||
* @see Reference
|
||||
*
|
||||
|
|
|
|||
|
|
@ -423,7 +423,10 @@ class PhpDumper extends Dumper
|
|||
*
|
||||
* @param string $id
|
||||
* @param Definition $definition
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @throws ServiceCircularReferenceException when the container contains a circular reference
|
||||
*/
|
||||
private function addServiceInlinedDefinitionsSetup($id, $definition)
|
||||
{
|
||||
|
|
@ -627,6 +630,8 @@ EOF;
|
|||
*
|
||||
* @param string $id A service identifier
|
||||
* @param Definition $definition A Definition instance
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
private function addServiceSynchronizer($id, Definition $definition)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -242,6 +242,8 @@ class YamlFileLoader extends FileLoader
|
|||
* @param string $file
|
||||
*
|
||||
* @return array The file content
|
||||
*
|
||||
* @throws InvalidArgumentException when the given file is not a local file or when it does not exist
|
||||
*/
|
||||
protected function loadFile($file)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -503,6 +503,8 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
|
|||
*
|
||||
* @param bool $initialize
|
||||
*
|
||||
* @return ButtonBuilder
|
||||
*
|
||||
* @throws BadMethodCallException
|
||||
*/
|
||||
public function setAutoInitialize($initialize)
|
||||
|
|
|
|||
|
|
@ -61,6 +61,8 @@ class BinaryFileResponse extends Response
|
|||
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
|
||||
* @param bool $autoEtag Whether the ETag header should be automatically set
|
||||
* @param bool $autoLastModified Whether the Last-Modified header should be automatically set
|
||||
*
|
||||
* @return BinaryResponse The created response
|
||||
*/
|
||||
public static function create($file = null, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -286,7 +286,7 @@ class UploadedFile extends File
|
|||
/**
|
||||
* Returns an informative upload error message.
|
||||
*
|
||||
* @param int $code The error code returned by an upload attempt
|
||||
* @param int $errorCode The error code returned by an upload attempt
|
||||
*
|
||||
* @return string The error message regarding the specified error code
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -261,8 +261,9 @@ class TraceableEventDispatcher implements EventDispatcherInterface, TraceableEve
|
|||
/**
|
||||
* Returns information about the listener
|
||||
*
|
||||
* @param object $listener The listener
|
||||
* @param string $eventName The event name
|
||||
* @param object $listener The listener
|
||||
* @param int|null $eventId The event id
|
||||
* @param string $eventName The event name
|
||||
*
|
||||
* @return array Information about the listener
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -81,6 +81,7 @@ class FragmentHandler
|
|||
* @return string|null The Response content or null when the Response is streamed
|
||||
*
|
||||
* @throws \InvalidArgumentException when the renderer does not exist
|
||||
* @throws \LogicException when no master request is being handled
|
||||
* @throws \RuntimeException when the Response is not successful
|
||||
*/
|
||||
public function render($uri, $renderer = 'inline', array $options = array())
|
||||
|
|
|
|||
|
|
@ -505,7 +505,7 @@ class NumberFormatter
|
|||
* Parse a number
|
||||
*
|
||||
* @param string $value The value to parse
|
||||
* @param string $type Type of the formatting, one of the format type constants. NumberFormatter::TYPE_DOUBLE by default
|
||||
* @param int $type Type of the formatting, one of the format type constants. NumberFormatter::TYPE_DOUBLE by default
|
||||
* @param int $position Offset to begin the parsing on return this value will hold the offset at which the parsing ended
|
||||
*
|
||||
* @return bool|string The parsed value of false on error
|
||||
|
|
|
|||
|
|
@ -801,12 +801,12 @@ QUERY;
|
|||
}
|
||||
|
||||
/**
|
||||
* This process old entries changes on an ACE related property (classFieldAces, or objectFieldAces).
|
||||
* This processes old entries changes on an ACE related property (classFieldAces, or objectFieldAces).
|
||||
*
|
||||
* @param string $name
|
||||
* @param array $changes
|
||||
* @param array $changes
|
||||
*/
|
||||
private function updateOldFieldAceProperty($ane, array $changes)
|
||||
private function updateOldFieldAceProperty($name, array $changes)
|
||||
{
|
||||
$currentIds = array();
|
||||
foreach ($changes[1] as $field => $new) {
|
||||
|
|
|
|||
|
|
@ -61,6 +61,8 @@ class BCryptPasswordEncoder extends BasePasswordEncoder
|
|||
*
|
||||
* @return string The encoded password
|
||||
*
|
||||
* @throws BadCredentialsException when the given password is too long
|
||||
*
|
||||
* @link http://lxr.php.net/xref/PHP_5_5/ext/standard/password.c#111
|
||||
*/
|
||||
public function encodePassword($raw, $salt)
|
||||
|
|
|
|||
|
|
@ -89,6 +89,8 @@ abstract class BasePasswordEncoder implements PasswordEncoderInterface
|
|||
/**
|
||||
* Checks if the password is too long.
|
||||
*
|
||||
* @param string $password The password to check
|
||||
*
|
||||
* @return bool true if the password is too long, false otherwise
|
||||
*/
|
||||
protected function isPasswordTooLong($password)
|
||||
|
|
|
|||
|
|
@ -33,6 +33,8 @@ class LuhnValidator extends ConstraintValidator
|
|||
*
|
||||
* @param mixed $value
|
||||
* @param Constraint $constraint
|
||||
*
|
||||
* @throws UnexpectedTypeException when the given credit card number is no string
|
||||
*/
|
||||
public function validate($value, Constraint $constraint)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -384,6 +384,8 @@ class Inline
|
|||
* @param string $scalar
|
||||
*
|
||||
* @return string A YAML string
|
||||
*
|
||||
* @throws ParseException when object parsing support was disabled and the parser detected a PHP object
|
||||
*/
|
||||
private static function evaluateScalar($scalar)
|
||||
{
|
||||
|
|
|
|||
Reference in New Issue