Fix some annotates

This commit is contained in:
bronze1man 2013-09-18 20:41:53 +08:00 committed by Fabien Potencier
parent 4bb14419a3
commit de39bd5433
51 changed files with 73 additions and 34 deletions

View File

@ -14,6 +14,7 @@ namespace Symfony\Bridge\Doctrine\Form\ChoiceList;
use Symfony\Component\Form\Exception\UnexpectedTypeException;
use Doctrine\ORM\QueryBuilder;
use Doctrine\DBAL\Connection;
use Doctrine\ORM\EntityManager;
/**
* Getting Entities through the ORM QueryBuilder

View File

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

View File

@ -15,6 +15,7 @@ use Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser;
use Symfony\Component\Config\Loader\DelegatingLoader as BaseDelegatingLoader;
use Symfony\Component\Config\Loader\LoaderResolverInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Routing\RouteCollection;
/**
* DelegatingLoader delegates route loading to other loaders using a loader resolver.

View File

@ -13,6 +13,7 @@ namespace Symfony\Bundle\FrameworkBundle\Templating\Asset;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Templating\Asset\PackageInterface;
/**
* Creates packages based on whether the current request is secure.

View File

@ -13,6 +13,7 @@ namespace Symfony\Bundle\TwigBundle\Loader;
use Symfony\Component\Templating\TemplateNameParserInterface;
use Symfony\Component\Config\FileLocatorInterface;
use Symfony\Component\Templating\TemplateReferenceInterface;
/**
* FilesystemLoader extends the default Twig filesystem loader

View File

@ -39,7 +39,7 @@ class ClassMapGenerator
/**
* Iterate over all files in the given directory searching for classes
*
* @param Iterator|string $dir The directory to search in or an iterator
* @param \Iterator|string $dir The directory to search in or an iterator
*
* @return array A class map array
*/

View File

@ -10,6 +10,7 @@
*/
namespace Symfony\Component\Config\Definition\Builder;
use Symfony\Component\Config\Definition\Exception\UnsetKeyException;
/**

View File

@ -736,7 +736,7 @@ class Application
* @param string $namespace An optional namespace name
* @param Boolean $asDom Whether to return a DOM or an XML string
*
* @return string|DOMDocument An XML string representing the Application
* @return string|\DOMDocument An XML string representing the Application
*/
public function asXml($namespace = null, $asDom = false)
{
@ -787,7 +787,7 @@ class Application
/**
* Renders a caught exception.
*
* @param Exception $e An exception instance
* @param \Exception $e An exception instance
* @param OutputInterface $output An OutputInterface instance
*/
public function renderException($e, $output)

View File

@ -597,7 +597,7 @@ class Command
*
* @param Boolean $asDom Whether to return a DOM or an XML string
*
* @return string|DOMDocument An XML string representing the command
* @return string|\DOMDocument An XML string representing the command
*/
public function asXml($asDom = false)
{

View File

@ -45,7 +45,7 @@ class OutputFormatter implements OutputFormatterInterface
* Initializes console output formatter.
*
* @param Boolean $decorated Whether this formatter should actually decorate strings
* @param FormatterStyle[] $styles Array of "name => FormatterStyle" instances
* @param OutputFormatterStyleInterface[] $styles Array of "name => FormatterStyle" instances
*
* @api
*/

View File

@ -475,7 +475,7 @@ class InputDefinition
*
* @param Boolean $asDom Whether to return a DOM or an XML string
*
* @return string|DOMDocument An XML string representing the InputDefinition
* @return string|\DOMDocument An XML string representing the InputDefinition
*/
public function asXml($asDom = false)
{

View File

@ -14,6 +14,8 @@ namespace Symfony\Component\Console\Tester;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\StreamOutput;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Eases the testing of console commands.

View File

@ -12,6 +12,7 @@
namespace Symfony\Component\CssSelector\Node;
use Symfony\Component\CssSelector\Exception\ParseException;
use Symfony\Component\CssSelector\XPathExpr;
/**
* CombinedSelectorNode represents a combinator node.

View File

@ -11,6 +11,9 @@
namespace Symfony\Component\CssSelector\Node;
use Symfony\Component\CssSelector\XPathExpr;
use Symfony\Component\CssSelector\Exception\ParseException;
/**
* ClassNode represents a "selector.className" node.
*

View File

@ -28,7 +28,7 @@ interface ExtensionInterface
* @param array $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws InvalidArgumentException When provided tag is not defined in this extension
* @throws \InvalidArgumentException When provided tag is not defined in this extension
*
* @api
*/

View File

@ -11,6 +11,9 @@
namespace Symfony\Component\Form;
use Symfony\Component\Form\Exception\UnexpectedTypeException;
use Symfony\Component\Form\Exception\TransformationFailedException;
class CallbackTransformer implements DataTransformerInterface
{
/**

View File

@ -144,7 +144,7 @@ class Form implements \IteratorAggregate, FormInterface
*
* @param FormConfigInterface $config The form configuration.
*
* @throws FormException if a data mapper is not provided for a compound form
* @throws Exception if a data mapper is not provided for a compound form
*/
public function __construct(FormConfigInterface $config)
{

View File

@ -34,7 +34,7 @@ class BinaryFileResponse extends Response
/**
* Constructor.
*
* @param SplFileInfo|string $file The file to stream
* @param \SplFileInfo|string $file The file to stream
* @param integer $status The response status code
* @param array $headers An array of response headers
* @param boolean $public Files are public by default
@ -64,7 +64,7 @@ class BinaryFileResponse extends Response
/**
* Sets the file to stream.
*
* @param SplFileInfo|string $file The file to stream
* @param \SplFileInfo|string $file The file to stream
* @param string $contentDisposition
* @param Boolean $autoEtag
* @param Boolean $autoLastModified

View File

@ -20,6 +20,7 @@ use Symfony\Component\BrowserKit\Cookie as DomCookie;
use Symfony\Component\BrowserKit\History;
use Symfony\Component\BrowserKit\CookieJar;
use Symfony\Component\HttpKernel\TerminableInterface;
use Symfony\Component\HttpFoundation\Response;
/**
* Client simulates a browser and makes requests to a Kernel object.

View File

@ -51,7 +51,7 @@ class ErrorHandler
*
* @param integer $level The level at which the conversion to Exception is done (null to use the error_reporting() value and 0 to disable)
*
* @return The registered error handler
* @return ErrorHandler The registered error handler
*/
public static function register($level = null)
{

View File

@ -56,7 +56,7 @@ class GetResponseForControllerResultEvent extends GetResponseEvent
/**
* Assigns the return value of the controller.
*
* @param mixed The controller return value
* @param mixed $controllerResult The controller return value
*
* @api
*/

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\HttpKernel\Fragment;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ControllerReference;
use Symfony\Component\HttpFoundation\Response;
/**
* Interface implemented by all rendering strategies.

View File

@ -11,7 +11,6 @@
namespace Symfony\Component\HttpKernel\Profiler;
use Redis;
/**
* RedisProfilerStorage stores profiling information in Redis.
@ -32,7 +31,7 @@ class RedisProfilerStorage implements ProfilerStorageInterface
protected $lifetime;
/**
* @var Redis
* @var \Redis
*/
private $redis;
@ -199,7 +198,7 @@ class RedisProfilerStorage implements ProfilerStorageInterface
/**
* Internal convenience method that returns the instance of Redis.
*
* @return Redis
* @return \Redis
*
* @throws \RuntimeException
*/
@ -216,7 +215,7 @@ class RedisProfilerStorage implements ProfilerStorageInterface
throw new \RuntimeException('RedisProfilerStorage requires that the redis extension is loaded.');
}
$redis = new Redis;
$redis = new \Redis;
$redis->connect($data['host'], $data['port']);
if (isset($data['path'])) {
@ -238,7 +237,7 @@ class RedisProfilerStorage implements ProfilerStorageInterface
/**
* Set instance of the Redis
*
* @param Redis $redis
* @param \Redis $redis
*/
public function setRedis($redis)
{

View File

@ -84,7 +84,7 @@ class Locale extends \Locale
* Returns all available country codes
*
* @return array The country codes
* @throws RuntimeException When the resource bundles cannot be loaded
* @throws \RuntimeException When the resource bundles cannot be loaded
*/
public static function getCountries()
{
@ -137,7 +137,7 @@ class Locale extends \Locale
* Returns all available language codes
*
* @return array The language codes
* @throws RuntimeException When the resource bundles cannot be loaded
* @throws \RuntimeException When the resource bundles cannot be loaded
*/
public static function getLanguages()
{
@ -187,7 +187,7 @@ class Locale extends \Locale
* Returns all available locale codes
*
* @return array The locale codes
* @throws RuntimeException When the resource bundles cannot be loaded
* @throws \RuntimeException When the resource bundles cannot be loaded
*/
public static function getLocales()
{
@ -282,7 +282,7 @@ class Locale extends \Locale
/**
* Returns the fallback locale for a given locale, if any
*
* @param $locale The locale to find the fallback for
* @param string $locale The locale to find the fallback for
* @return string|null The fallback locale, or null if no parent exists
*/
protected static function getFallbackLocale($locale)

View File

@ -102,7 +102,7 @@ class FullTransformer
* Return the formatted ICU value for the matched date characters
*
* @param string $dateChars The date characters to be replaced with a formatted ICU value
* @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
*

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Routing\Matcher\Dumper;
use Symfony\Component\Routing\RouteCollection;
/**
* MatcherDumperInterface is the interface that all matcher dumper classes must implement.
*

View File

@ -14,6 +14,7 @@ namespace Symfony\Component\Security\Acl\Domain;
use Symfony\Component\Security\Acl\Model\AclProviderInterface;
use Symfony\Component\Security\Acl\Model\ObjectIdentityRetrievalStrategyInterface;
use Symfony\Component\Security\Acl\Model\SecurityIdentityRetrievalStrategyInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
/**
* This service caches ACLs for an entire collection of objects.

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Acl\Model;
use Symfony\Component\Security\Acl\Exception\NoAceFoundException;
/**
* This interface represents an access control list (ACL) for a domain object.
* Each domain object can have exactly one associated ACL.

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Acl\Model;
use Symfony\Component\Security\Acl\Exception\AclNotFoundException;
/**
* Provides a common interface for retrieving ACLs.
*

View File

@ -100,7 +100,7 @@ final class PersistentToken implements PersistentTokenInterface
/**
* Returns the time the token was last used
*
* @return DateTime
* @return \DateTime
*/
public function getLastUsed()
{

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Core\Authentication\RememberMe;
use Symfony\Component\Security\Core\Exception\TokenNotFoundException;
/**
* Interface for TokenProviders
*

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\RoleInterface;
/**
* AnonymousToken represents an anonymous token.
*

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Core\Authentication\Token;
use Symfony\Component\Security\Core\Role\RoleInterface;
/**
* UsernamePasswordToken implements a username and password token.
*

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Security\Core\User;
use Symfony\Component\Security\Core\Role\Role;
/**
* Represents the interface that all user classes must implement.
*

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\Security\Http\Authentication;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* Interface for custom authentication failure handlers.

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\Security\Http\Authentication;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* Interface for a custom authentication success handler

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\Security\Http\Authorization;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Symfony\Component\HttpFoundation\Response;
/**
* This is used by the ExceptionListener to translate an AccessDeniedException

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\Security\Http\EntryPoint;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* AuthenticationEntryPointInterface is the interface used to start the

View File

@ -20,6 +20,7 @@ use Symfony\Component\Security\Core\Exception\LogoutException;
use Symfony\Component\Security\Http\HttpUtils;
use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
use Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface;
use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
/**
* LogoutListener logout users.

View File

@ -20,6 +20,7 @@ use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Routing\Exception\MethodNotAllowedException;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Symfony\Component\HttpFoundation\Response;
/**
* Encapsulates the logic needed to create sub-requests, redirect the user, and match URLs.

View File

@ -12,6 +12,7 @@
namespace Symfony\Component\Security\Http\Logout;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* LogoutSuccesshandlerInterface.

View File

@ -372,7 +372,7 @@ class MutableAclProviderTest extends \PHPUnit_Framework_TestCase
* @param AclProvider $provider
* @param array $data
* @throws \InvalidArgumentException
* @throws Exception
* @throws \Exception
*/
protected function importAcls(AclProvider $provider, array $data)
{

View File

@ -14,7 +14,6 @@ namespace Symfony\Component\Security\Tests\Http\RememberMe;
use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
use Symfony\Component\Security\Core\Authentication\Token\RememberMeToken;
use Symfony\Component\Security\Core\Authentication\Token\Token;
use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

View File

@ -148,7 +148,7 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec
}
/**
* @param DOMNode $node
* @param \DOMNode $node
* @param string $val
*
* @return Boolean

View File

@ -11,7 +11,7 @@
namespace Symfony\Component\Templating\Loader;
use Symfony\Component\Templating\Storage;
use Symfony\Component\Templating\Storage\Storage;
use Symfony\Component\Templating\TemplateReferenceInterface;
/**

View File

@ -12,6 +12,7 @@
namespace Symfony\Component\Templating\Loader;
use Symfony\Component\Templating\TemplateReferenceInterface;
use Symfony\Component\Templating\Storage\Storage;
/**
* LoaderInterface is the interface all loaders must implement.

View File

@ -13,6 +13,7 @@ namespace Symfony\Component\Translation\Loader;
use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\Exception\InvalidResourceException;
use Symfony\Component\Translation\Exception\NotFoundResourceException;
/**
* LoaderInterface is the interface implemented by all translation loaders.

View File

@ -12,6 +12,7 @@
namespace Symfony\Component\Validator\Mapping\Loader;
use Symfony\Component\Validator\Exception\MappingException;
use Symfony\Component\Validator\Constraint;
abstract class AbstractLoader implements LoaderInterface
{

View File

@ -183,7 +183,7 @@ class XmlFileLoader extends FileLoader
*
* @param string $file Path of file
*
* @return SimpleXMLElement
* @return \SimpleXMLElement
*
* @throws MappingException
*/

View File

@ -32,9 +32,9 @@ class ParseException extends RuntimeException
* @param integer $parsedLine The line where the error occurred
* @param integer $snippet The snippet of code near the problem
* @param string $parsedFile The file name where the error occurred
* @param Exception $previous The previous exception
* @param \Exception $previous The previous exception
*/
public function __construct($message, $parsedLine = -1, $snippet = null, $parsedFile = null, Exception $previous = null)
public function __construct($message, $parsedLine = -1, $snippet = null, $parsedFile = null, \Exception $previous = null)
{
$this->parsedFile = $parsedFile;
$this->parsedLine = $parsedLine;

View File

@ -130,7 +130,7 @@ class Unescaper
*
* @return string The string with the new encoding
*
* @throws RuntimeException if no suitable encoding function is found (iconv or mbstring)
* @throws \RuntimeException if no suitable encoding function is found (iconv or mbstring)
*/
private function convertEncoding($value, $to, $from)
{
@ -140,6 +140,6 @@ class Unescaper
return iconv($from, $to, $value);
}
throw new RuntimeException('No suitable convert encoding function (install the iconv or mbstring extension).');
throw new \RuntimeException('No suitable convert encoding function (install the iconv or mbstring extension).');
}
}