Skip to content

Commit

Permalink
Nsdocblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
Drak authored and fabpot committed Oct 20, 2012
1 parent dba9bc3 commit 788cc2c
Show file tree
Hide file tree
Showing 43 changed files with 104 additions and 78 deletions.
Expand Up @@ -60,6 +60,9 @@ public function testUsesRequestServerData()
}

/**
* @param integer $level
* @param string $message
*
* @return array Record
*/
protected function getRecord($level = Logger::WARNING, $message = 'test')
Expand Down
Expand Up @@ -27,7 +27,7 @@ class RouterCacheWarmer implements CacheWarmerInterface
/**
* Constructor.
*
* @param Router $router A Router instance
* @param RouterInterface $router A Router instance
*/
public function __construct(RouterInterface $router)
{
Expand Down
Expand Up @@ -133,7 +133,7 @@ public function stream($view, array $parameters = array(), StreamedResponse $res
* throw $this->createNotFoundException('Page not found!');
*
* @param string $message A message
* @param Exception $previous The previous exception
* @param \Exception $previous The previous exception
*
* @return NotFoundHttpException
*/
Expand Down
Expand Up @@ -82,7 +82,7 @@ public function getLogoutUrl($key)
* @param string $key The firewall key
* @param Boolean $absolute Whether to generate an absolute URL
* @return string The logout URL
* @throws InvalidArgumentException if no LogoutListener is registered for the key
* @throws \InvalidArgumentException if no LogoutListener is registered for the key
*/
private function generateLogoutUrl($key, $absolute)
{
Expand Down
Expand Up @@ -102,6 +102,8 @@ public function purgeAction()
/**
* Imports token data.
*
* @param Request $request
*
* @return Response A Response instance
*/
public function importAction(Request $request)
Expand Down
Expand Up @@ -33,7 +33,7 @@ class TemplateManager
* Constructor.
*
* @param Profiler $profiler
* @param TwigEngine $templating
* @param EngineInterface $templating
* @param \Twig_Environment $twig
* @param array $templates
*/
Expand Down
Expand Up @@ -11,6 +11,7 @@

namespace Symfony\Component\Config\Definition\Builder;

use Symfony\Component\Config\Definition\NodeInterface;
use Symfony\Component\Config\Definition\ArrayNode;
use Symfony\Component\Config\Definition\PrototypedArrayNode;
use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException;
Expand Down
8 changes: 4 additions & 4 deletions src/Symfony/Component/Console/Output/ConsoleOutput.php
Expand Up @@ -37,10 +37,10 @@ class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
/**
* Constructor.
*
* @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
* @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 OutputFormatterInterface $formatter Output formatter instance
*
* @api
*/
Expand Down
10 changes: 5 additions & 5 deletions src/Symfony/Component/Console/Output/StreamOutput.php
Expand Up @@ -35,11 +35,11 @@ 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 Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance
* @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 OutputFormatterInterface $formatter Output formatter instance
*
* @throws \InvalidArgumentException When first argument is not a real stream
*
Expand Down
Expand Up @@ -880,9 +880,9 @@ private function wrapServiceConditionals($value, $code)
/**
* Builds service calls from arguments
*
* @param array $arguments
* @param string &$calls By reference
* @param string &$behavior By reference
* @param array $arguments
* @param array &$calls By reference
* @param array &$behavior By reference
*/
private function getServiceCallsFromArguments(array $arguments, array &$calls, array &$behavior)
{
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
Expand Up @@ -848,6 +848,8 @@ public function providePathsForIsAbsolutePath()
/**
* Returns file permissions as three digits (i.e. 755)
*
* @param string $filepath
*
* @return integer
*/
private function getFilePermissions($filePath)
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Finder/Finder.php
Expand Up @@ -329,7 +329,7 @@ public static function addVCSPattern($pattern)
*
* 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
*
Expand Down Expand Up @@ -448,7 +448,7 @@ public function sortByModifiedTime()
* 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
*
Expand Down
Expand Up @@ -71,7 +71,7 @@ public function __construct($inputTimezone = null, $outputTimezone = null, $date
/**
* Transforms a normalized date into a localized date string/array.
*
* @param DateTime $dateTime Normalized date.
* @param \DateTime $dateTime Normalized date.
*
* @return string|array Localized date string/array.
*
Expand Down Expand Up @@ -108,7 +108,7 @@ public function transform($dateTime)
*
* @param string|array $value Localized date string/array
*
* @return DateTime Normalized date
* @return \DateTime Normalized date
*
* @throws UnexpectedTypeException if the given value is not a string
* @throws TransformationFailedException if the date could not be parsed
Expand Down
Expand Up @@ -38,8 +38,8 @@ public function __construct(CsrfProviderInterface $defaultCsrfProvider, $default
/**
* Adds a CSRF field to the form when the CSRF protection is enabled.
*
* @param FormBuilder $builder The form builder
* @param array $options The options
* @param FormBuilderInterface $builder The form builder
* @param array $options The options
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
Expand Down
Expand Up @@ -528,6 +528,10 @@ private function getExecutionContext($propertyPath = null)
}

/**
* @param string $name
* @param string $dataClass
* @param array $options
*
* @return FormBuilder
*/
private function getBuilder($name = 'name', $dataClass = null, array $options = array())
Expand Down
Expand Up @@ -48,7 +48,7 @@ protected function runTest()

/**
* @param integer $maxRunningTime
* @throws InvalidArgumentException
* @throws \InvalidArgumentException
*/
public function setMaxRunningTime($maxRunningTime)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Form/Util/PropertyPath.php
Expand Up @@ -572,7 +572,7 @@ private function camelize($string)
* Searches for add and remove methods.
*
* @param \ReflectionClass $reflClass The reflection class for the given object
* @param string|null $singulars The singular form of the property name or null.
* @param array $singulars The singular form of the property name or null.
*
* @return array|null An array containing the adder and remover when found, null otherwise.
*
Expand Down
Expand Up @@ -50,6 +50,8 @@ public function close();
/**
* Read session.
*
* @param string $sessionId
*
* @see http://php.net/sessionhandlerinterface.read
*
* @throws \RuntimeException On fatal error but not "record not found".
Expand Down
Expand Up @@ -29,6 +29,8 @@
class NativeSessionStorageTest extends \PHPUnit_Framework_TestCase
{
/**
* @param array $options
*
* @return NativeSessionStorage
*/
protected function getStorage(array $options = array())
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/HttpKernel/Debug/ExceptionHandler.php
Expand Up @@ -43,6 +43,8 @@ public function __construct($debug = true, $charset = 'UTF-8')
/**
* Register the exception handler.
*
* @param Boolean $debug
*
* @return ExceptionHandler The registered exception handler
*/
public static function register($debug = true)
Expand Down
Expand Up @@ -22,9 +22,9 @@ class AccessDeniedHttpException extends HttpException
/**
* Constructor.
*
* @param string $message The internal exception message
* @param Exception $previous The previous exception
* @param integer $code The internal exception code
* @param string $message The internal exception message
* @param \Exception $previous The previous exception
* @param integer $code The internal exception code
*/
public function __construct($message = null, \Exception $previous = null, $code = 0)
{
Expand Down
Expand Up @@ -21,10 +21,10 @@ class MethodNotAllowedHttpException extends HttpException
/**
* Constructor.
*
* @param array $allow An array of allowed methods
* @param string $message The internal exception message
* @param Exception $previous The previous exception
* @param integer $code The internal exception code
* @param array $allow An array of allowed methods
* @param string $message The internal exception message
* @param \Exception $previous The previous exception
* @param integer $code The internal exception code
*/
public function __construct(array $allow, $message = null, \Exception $previous = null, $code = 0)
{
Expand Down
Expand Up @@ -21,9 +21,9 @@ class NotFoundHttpException extends HttpException
/**
* Constructor.
*
* @param string $message The internal exception message
* @param Exception $previous The previous exception
* @param integer $code The internal exception code
* @param string $message The internal exception message
* @param \Exception $previous The previous exception
* @param integer $code The internal exception code
*/
public function __construct($message = null, \Exception $previous = null, $code = 0)
{
Expand Down
Expand Up @@ -29,7 +29,7 @@ public function __construct()
}

/**
* Add a memcached server to connection pool
* Add a server to connection pool
*
* @param string $host
* @param integer $port
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Locale/Resources/stubs/functions.php
Expand Up @@ -53,6 +53,8 @@ function intl_get_error_message()
/**
* Stub implementation for the intl_error_name function of the intl extension
*
* @param integer $errorCode
*
* @return String will be the same as the name of the error code constant
*
* @see Symfony\Component\Locale\Stub\StubIntl::getErrorName
Expand Down
10 changes: 5 additions & 5 deletions src/Symfony/Component/Locale/Stub/DateFormat/FullTransformer.php
Expand Up @@ -79,7 +79,7 @@ public function getTransformers()
/**
* Format a DateTime using ICU dateformat pattern
*
* @param DateTime $dateTime A DateTime object to be used to generate the formatted value
* @param \DateTime $dateTime A DateTime object to be used to generate the formatted value
*
* @return string The formatted value
*/
Expand Down Expand Up @@ -127,12 +127,12 @@ public function formatReplace($dateChars, $dateTime)
/**
* Parse a pattern based string to a timestamp value
*
* @param DateTime $dateTime A configured DateTime object to use to perform the date calculation
* @param \DateTime $dateTime A configured DateTime object to use to perform the date calculation
* @param string $value String to convert to a time value
*
* @return int The corresponding Unix timestamp
*
* @throws InvalidArgumentException When the value can not be matched with pattern
* @throws \InvalidArgumentException When the value can not be matched with pattern
*/
public function parse(\DateTime $dateTime, $value)
{
Expand Down Expand Up @@ -278,8 +278,8 @@ protected function normalizeArray(array $data)
* Calculates the Unix timestamp based on the matched values by the reverse matching regular
* expression of parse()
*
* @param DateTime $dateTime The DateTime object to be used to calculate the timestamp
* @param array $options An array with the matched values to be used to calculate the timestamp
* @param \DateTime $dateTime The DateTime object to be used to calculate the timestamp
* @param array $options An array with the matched values to be used to calculate the timestamp
*
* @return Boolean|int The calculated timestamp or false if matched date is invalid
*/
Expand Down
Expand Up @@ -75,7 +75,7 @@ public function extractDateOptions($matched, $length)
* @see http://www.twinsun.com/tz/tz-link.htm
*
* @throws NotImplementedException When the GMT time zone have minutes offset different than zero
* @throws InvalidArgumentException When the value can not be matched with pattern
* @throws \InvalidArgumentException When the value can not be matched with pattern
*/
public static function getEtcTimeZoneId($formattedTimeZone)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Locale/Stub/DateFormat/Transformer.php
Expand Up @@ -22,8 +22,8 @@ abstract class Transformer
* Format a value using a configured DateTime as date/time source
*
*
* @param DateTime $dateTime A DateTime object to be used to generate the formatted value
* @param int $length The formatted value string length
* @param \DateTime $dateTime A DateTime object to be used to generate the formatted value
* @param int $length The formatted value string length
*
* @return string The formatted value
*/
Expand Down
12 changes: 6 additions & 6 deletions src/Symfony/Component/Locale/Stub/StubLocale.php
Expand Up @@ -79,7 +79,7 @@ class StubLocale
*
* @return array The country names with their codes as keys
*
* @throws InvalidArgumentException When the locale is different than 'en'
* @throws \InvalidArgumentException When the locale is different than 'en'
*/
public static function getDisplayCountries($locale)
{
Expand All @@ -103,7 +103,7 @@ public static function getCountries()
*
* @return array The language names with their codes as keys
*
* @throws InvalidArgumentException When the locale is different than 'en'
* @throws \InvalidArgumentException When the locale is different than 'en'
*/
public static function getDisplayLanguages($locale)
{
Expand All @@ -127,7 +127,7 @@ public static function getLanguages()
*
* @return array The locale names with their codes as keys
*
* @throws InvalidArgumentException When the locale is different than 'en'
* @throws \InvalidArgumentException When the locale is different than 'en'
*/
public static function getDisplayLocales($locale)
{
Expand Down Expand Up @@ -163,7 +163,7 @@ public static function getCurrenciesData($locale)
*
* @return array The currencies names with their codes as keys
*
* @throws InvalidArgumentException When the locale is different than 'en'
* @throws \InvalidArgumentException When the locale is different than 'en'
*/
public static function getDisplayCurrencies($locale)
{
Expand Down Expand Up @@ -429,7 +429,7 @@ public static function getScript($locale)
*
* @see http://www.php.net/manual/en/locale.lookup.php
*
* @throws RuntimeException When the intl extension is not loaded
* @throws \RuntimeException When the intl extension is not loaded
*/
public static function lookup(array $langtag, $locale, $canonicalize = false, $default = null)
{
Expand Down Expand Up @@ -494,7 +494,7 @@ public static function getDataDirectory()
*
* @return array
*
* @throws InvalidArgumentException When the locale is different than 'en'
* @throws \InvalidArgumentException When the locale is different than 'en'
*/
private static function getStubData($locale, $cacheVariable, $stubDataDir)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Process/Process.php
Expand Up @@ -575,7 +575,7 @@ public function isRunning()
*
* @param float $timeout The timeout in seconds
*
* @return integer The exitcode of the process
* @return integer The exit-code of the process
*
* @throws \RuntimeException if the process got signaled
*/
Expand Down

0 comments on commit 788cc2c

Please sign in to comment.