Commit 2e5e060c authored by alexpott's avatar alexpott

Issue #2783395 by Mile23: Fix 'Drupal.Commenting.FunctionComment.InvalidReturn' coding standard

parent 6bdf44e8
......@@ -599,7 +599,7 @@ function _drupal_exception_handler_additional($exception, $exception2) {
* @param string $new_prefix
* Internal use only. A new prefix to be stored.
*
* @return string|FALSE
* @return string|false
* Either the simpletest prefix (the string "simpletest" followed by any
* number of digits) or FALSE if the user agent does not contain a valid
* HMAC and timestamp.
......
......@@ -80,7 +80,7 @@ public function deleteAll();
* @param string $name
* The virtual file name. Can be a relative path.
*
* @return string|FALSE
* @return string|false
* The full file path for the provided name. Return FALSE if the
* implementation needs to prevent access to the file.
*/
......
......@@ -17,7 +17,7 @@ interface AccessResultReasonInterface extends AccessResultInterface {
/**
* Gets the reason for this access result.
*
* @return string|NULL
* @return string|null
* The reason of this access result or NULL if no reason is provided.
*/
public function getReason();
......@@ -25,7 +25,7 @@ public function getReason();
/**
* Sets the reason for this access result.
*
* @param $reason string|NULL
* @param $reason string|null
* The reason of this access result or NULL if no reason is provided.
*
* @return \Drupal\Core\Access\AccessResultInterface
......
......@@ -39,7 +39,7 @@ public function getLibrariesByExtension($extension);
* @param string $name
* The name of a registered library to retrieve.
*
* @return array|FALSE
* @return array|false
* The definition of the requested library, if $name was passed and it
* exists, otherwise FALSE.
*/
......
......@@ -41,7 +41,7 @@ public function isGlobal($provider_id);
* @param string $provider_id
* The provider ID.
*
* @return \Drupal\Core\Authentication\AuthenticationProviderInterface|NULL
* @return \Drupal\Core\Authentication\AuthenticationProviderInterface|null
* The authentication provider which matches the ID.
*/
public function getProvider($provider_id);
......
......@@ -94,7 +94,7 @@ public function challengeException(Request $request, \Exception $previous) {
* @param \Symfony\Component\HttpFoundation\Request $request
* The incoming request.
*
* @return string|NULL
* @return string|null
* The id of the first authentication provider which applies to the request.
* If no application detects appropriate credentials, then NULL is returned.
*/
......@@ -112,7 +112,7 @@ protected function getProvider(Request $request) {
* @param \Symfony\Component\HttpFoundation\Request $request
* The incoming request.
*
* @return string|NULL
* @return string|null
* The ID of the first authentication provider which applies to the request.
* If no application detects appropriate credentials, then NULL is returned.
*/
......
......@@ -21,7 +21,7 @@ interface AuthenticationProviderChallengeInterface {
* @param \Exception $previous
* The previous exception.
*
* @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|NULL
* @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|null
* An exception to be used in order to generate an authentication challenge.
*/
public function challengeException(Request $request, \Exception $previous);
......
......@@ -27,7 +27,7 @@ public function applies(Request $request);
* @param \Symfony\Component\HttpFoundation\Request|null $request
* The request object.
*
* @return \Drupal\Core\Session\AccountInterface|NULL
* @return \Drupal\Core\Session\AccountInterface|null
* AccountInterface - in case of a successful authentication.
* NULL - in case where authentication failed.
*/
......
......@@ -196,7 +196,7 @@ public static function vendorTestCodeCleanup(PackageEvent $event) {
* @param string $package_name
* The package name from composer. This is always already lower case.
*
* @return NULL|string
* @return string|null
* The string key, or NULL if none was found.
*/
protected static function findPackageKey($package_name) {
......
......@@ -63,7 +63,7 @@ public function getCollectionNames($include_default = TRUE) {
* @param string $collection
* The configuration collection.
*
* @return \Drupal\Core\Config\ConfigFactoryOverrideInterface|NULL
* @return \Drupal\Core\Config\ConfigFactoryOverrideInterface|null
* The override service responsible for the collection if one exists. NULL
* if not.
*/
......
......@@ -65,7 +65,7 @@ public function getConfigPrefix();
/**
* Gets the config entity properties to export if declared on the annotation.
*
* @return array|NULL
* @return array|null
* The properties to export or NULL if they can not be determine from the
* config entity type annotation.
*/
......
......@@ -189,7 +189,7 @@ protected function getKeys(Config $config, $key, $get_method, ConfigEntityTypeIn
* @param int $start
* Which position of $parts we are processing. Defaults to 0.
*
* @return array|NULL
* @return array|null
* The array of configuration values the match the provided key. NULL if
* the configuration object does not have a value that corresponds to the
* key.
......
......@@ -58,7 +58,7 @@ public function getContainer();
*
* This also allows inspecting a built container for debugging purposes.
*
* @return array|NULL
* @return array|null
* The cached container definition or NULL if not found in cache.
*/
public function getCachedContainerDefinition();
......
......@@ -273,7 +273,7 @@ public function deleteTitle(RouteMatchInterface $route_match, EntityInterface $_
* (optional) The entity, set in
* \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer.
*
* @return \Drupal\Core\Entity\EntityInterface|NULL
* @return \Drupal\Core\Entity\EntityInterface|null
* The entity, if it is passed in directly or if the first parameter of the
* active route is an entity; otherwise, NULL.
*/
......
......@@ -30,14 +30,14 @@ class AuthenticationSubscriber implements EventSubscriberInterface {
/**
* Authentication provider filter.
*
* @var \Drupal\Core\Authentication\AuthenticationProviderFilterInterface|NULL
* @var \Drupal\Core\Authentication\AuthenticationProviderFilterInterface|null
*/
protected $filter;
/**
* Authentication challenge provider.
*
* @var \Drupal\Core\Authentication\AuthenticationProviderChallengeInterface|NULL
* @var \Drupal\Core\Authentication\AuthenticationProviderChallengeInterface|null
*/
protected $challengeProvider;
......
......@@ -190,7 +190,7 @@ protected function sanitizeLabel(&$label) {
/**
* Returns the empty option label to add to the list of options, if any.
*
* @return string|NULL
* @return string|null
* Either a label of the empty option, or NULL.
*/
protected function getEmptyLabel() { }
......
......@@ -37,7 +37,7 @@ class EnforcedResponse extends Response {
* @param \Exception $e
* The exception where the enforced response is to be extracted from.
*
* @return \Drupal\Core\Form\EnforcedResponse|NULL
* @return \Drupal\Core\Form\EnforcedResponse|null
* The enforced response or NULL if the exception chain does not contain a
* \Drupal\Core\Form\EnforcedResponseException exception.
*/
......
......@@ -29,7 +29,7 @@ public function getActiveTrailIds($menu_name);
* (optional) The menu within which to find the active link. If omitted, all
* menus will be searched.
*
* @return \Drupal\Core\Menu\MenuLinkInterface|NULL
* @return \Drupal\Core\Menu\MenuLinkInterface|null
* The menu link for the given route name, parameters and menu, or NULL if
* there is no matching menu link or the current user cannot access the
* current page (i.e. we have a 403 response).
......
......@@ -68,7 +68,7 @@ class MenuLinkTreeElement {
* If the value is NULL the access was not determined yet, if an access result
* object, it was determined already.
*
* @var \Drupal\Core\Access\AccessResultInterface|NULL
* @var \Drupal\Core\Access\AccessResultInterface|null
*/
public $access;
......
......@@ -41,7 +41,7 @@ public function rebuild(array $definitions);
* @param string $id
* The menu link plugin ID.
*
* @return array|FALSE
* @return array|false
* The plugin definition, or FALSE if no definition was found for the ID.
*/
public function load($id);
......
......@@ -21,7 +21,7 @@ public function reload();
* @param string $id
* A menu link plugin ID.
*
* @return array|NULL
* @return array|null
* An override with following supported keys:
* - parent
* - weight
......
......@@ -39,7 +39,7 @@ interface RequestPolicyInterface {
* @param \Symfony\Component\HttpFoundation\Request $request
* The incoming request object.
*
* @return string|NULL
* @return string|null
* One of static::ALLOW, static::DENY or NULL. Calling code may attempt to
* deliver a cached page if static::ALLOW is returned. Returns NULL if the
* policy is not specified for the given request.
......
......@@ -27,7 +27,7 @@ interface ResponsePolicyInterface {
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
*
* @return string|NULL
* @return string|null
* Either static::DENY or NULL. Calling code may attempt to store a page in
* the cache unless static::DENY is returned. Returns NULL if the policy
* policy is not specified for the given response.
......
......@@ -42,7 +42,7 @@ class Context extends ComponentContext implements ContextInterface {
*
* @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context_definition
* The context definition.
* @param mixed $context_value|NULL
* @param mixed $context_value|null
* The context value object.
*/
public function __construct(ContextDefinitionInterface $context_definition, $context_value = NULL) {
......
......@@ -28,7 +28,7 @@ public function getMasterRouteMatch();
/**
* Returns the parent route match of the current.
*
* @return \Drupal\Core\Routing\RouteMatchInterface|NULL
* @return \Drupal\Core\Routing\RouteMatchInterface|null
* The parent route match or NULL, if it the master route match.
*/
public function getParentRouteMatch();
......@@ -39,7 +39,7 @@ public function getParentRouteMatch();
* @param \Symfony\Component\HttpFoundation\Request
* The request.
*
* @return \Drupal\Core\Routing\RouteMatchInterface|NULL
* @return \Drupal\Core\Routing\RouteMatchInterface|null
* THe matching route match, or NULL if there is no matching one.
*/
public function getRouteMatchFromRequest(Request $request);
......
......@@ -179,7 +179,7 @@ public function setInitialAccountId($account_id) {
* @param int $account_id
* The id of an account to load.
*
* @return \Drupal\Core\Session\AccountInterface|NULL
* @return \Drupal\Core\Session\AccountInterface|null
* An account or NULL if none is found.
*/
protected function loadUserEntity($account_id) {
......
......@@ -141,7 +141,7 @@ protected function getCookieDomain(Request $request) {
/**
* Wraps drupal_valid_test_ua().
*
* @return string|FALSE
* @return string|false
* Either the simpletest prefix (the string "simpletest" followed by any
* number of digits) or FALSE if the user agent does not contain a valid
* HMAC and timestamp.
......
......@@ -17,7 +17,7 @@ interface TranslatorInterface {
* @param string $context
* The string context.
*
* @return string|FALSE
* @return string|false
* Translated string if there is a translation, FALSE if not.
*/
public function getStringTranslation($langcode, $string, $context);
......
......@@ -24,7 +24,7 @@ class ThemeNegotiator implements ThemeNegotiatorInterface {
*
* Set to NULL if the array needs to be re-calculated.
*
* @var array|NULL
* @var array|null
*/
protected $sortedNegotiators;
......
......@@ -71,7 +71,7 @@ public function getLibraries(Editor $editor);
* Note: this does not use a Drupal library because this uses CKEditor's API,
* see http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.resourceManager.html#addExternal.
*
* @return string|FALSE
* @return string|false
* The Drupal root-relative path to the file, FALSE if an internal plugin.
*/
public function getFile();
......
......@@ -115,7 +115,7 @@ public function validateStylesValue(array $element, FormStateInterface $form_sta
*
* @param string $styles
* The "styles" setting.
* @return array|FALSE
* @return array|false
* An array containing the "stylesSet" configuration, or FALSE when the
* syntax is invalid.
*/
......
......@@ -32,7 +32,7 @@ public function hasParentComment();
/**
* Returns the parent comment entity if this is a reply to a comment.
*
* @return \Drupal\comment\CommentInterface|NULL
* @return \Drupal\comment\CommentInterface|null
* A comment entity of the parent comment or NULL if there is no parent.
*/
public function getParentComment();
......
......@@ -1318,7 +1318,7 @@ function file_icon_class($mime_type) {
* @param string $mime_type
* A MIME type.
*
* @return string|FALSE
* @return string|false
* The generic icon MIME package expected for this file.
*/
function file_icon_map($mime_type) {
......
......@@ -70,7 +70,7 @@ public function getFilterTypes();
* It is up to the caller to handle this in whatever way it sees fit; this way
* no information granularity is lost.
*
* @return array|FALSE
* @return array|false
* A structured array as returned by FilterInterface::getHTMLRestrictions(),
* but with the intersection of all filters in this text format.
* Will either indicate blacklisting of tags or whitelisting of tags. In
......
......@@ -182,7 +182,7 @@ public function process($text, $langcode);
* a generic manner into which HTML tags and attributes are allowed by a
* format.
*
* @return array|FALSE
* @return array|false
* A nested array with *either* of the following keys:
* - 'allowed': (optional) the allowed tags as keys, and for each of those
* tags (keys) either of the following values:
......
......@@ -434,7 +434,7 @@ public function reset() {
* @param string $context
* The string context.
*
* @return \Drupal\locale\TranslationString|FALSE
* @return \Drupal\locale\TranslationString|false
* The translation object if the string was not empty or FALSE otherwise.
*/
public function getStringTranslation($name, $langcode, $source, $context) {
......
......@@ -147,7 +147,7 @@ public function getIds() {
* @param \Drupal\migrate\Row $row
* The row object to update from.
*
* @return NULL|\Drupal\Core\Entity\EntityInterface
* @return \Drupal\Core\Entity\EntityInterface|null
* An updated entity, or NULL if it's the same as the one passed in.
*/
protected function updateEntity(EntityInterface $entity, Row $row) {
......
......@@ -125,7 +125,7 @@ protected function getMigrations($database_state_key, $drupal_version) {
* @param \Drupal\Core\Database\Connection $connection
* The database connection object.
*
* @return int|FALSE
* @return int|false
* An integer representing the major branch of Drupal core (e.g. '6' for
* Drupal 6.x), or FALSE if no valid version is matched.
*/
......
......@@ -167,7 +167,7 @@ protected function parseContent($content) {
* @param array $arguments
* Some arguments for the xpath.
*
* @return array|FALSE
* @return array|false
* The return value of the xpath search. For details on the xpath string
* format and return values see the SimpleXML documentation,
* http://php.net/manual/function.simplexml-element-xpath.php.
......
......@@ -449,7 +449,7 @@ protected function entityPermissions($entity_type_id, $operation) {
* @param string $location_url
* The URL returned in the Location header.
*
* @return \Drupal\Core\Entity\Entity|FALSE.
* @return \Drupal\Core\Entity\Entity|false
* The entity or FALSE if there is no matching entity.
*/
protected function loadEntityFromLocationHeader($location_url) {
......
......@@ -117,7 +117,7 @@ protected function setDrupalSettings($settings) {
/**
* Parse content returned from curlExec using DOM and SimpleXML.
*
* @return \SimpleXMLElement|FALSE
* @return \SimpleXMLElement|false
* A SimpleXMLElement or FALSE on failure.
*/
protected function parse() {
......
......@@ -87,7 +87,7 @@ function statistics_cron() {
* @param int $dbrows
* The number of rows to be returned.
*
* @return SelectQuery|FALSE
* @return SelectQuery|false
* A query result containing the node ID, title, user ID that owns the node,
* and the username for the selected node(s), or FALSE if the query could not
* be executed correctly.
......
......@@ -229,7 +229,7 @@ protected function installLanguages() {
* @param string $langcode
* The langcode of the specified language.
*
* @return string|FALSE
* @return string|false
* The .po contents for the specified language or FALSE if none exists.
*/
protected function poFileContents($langcode) {
......
......@@ -62,7 +62,7 @@ public function authenticate(Request $request) {
* @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
* The session.
*
* @return \Drupal\Core\Session\AccountInterface|NULL
* @return \Drupal\Core\Session\AccountInterface|null
* The UserSession object for the current user, or NULL if this is an
* anonymous session.
*/
......
......@@ -58,7 +58,7 @@ public function summaryTitle() {
* @param \Drupal\Core\Session\AccountInterface $account
* The user who wants to access this view.
*
* @return TRUE
* @return bool
* Returns whether the user has access to the view.
*/
abstract public function access(AccountInterface $account);
......
......@@ -233,7 +233,7 @@ public function getPath();
* block display links to a page display, the page display will be returned
* in both cases.
*
* @return \Drupal\views\Plugin\views\display\DisplayRouterInterface|NULL
* @return \Drupal\views\Plugin\views\display\DisplayRouterInterface|null
*/
public function getRoutedDisplay();
......
......@@ -54,7 +54,7 @@ public function init(ViewExecutable $view, DisplayPluginBase $display, array &$o
* This can use a guard to be used to reduce database hits as much as
* possible.
*
* @return array|NULL
* @return array|null
* The stored values from $this->valueOptions.
*/
public function getValueOptions() {
......
......@@ -169,7 +169,7 @@ protected function parseContent($content) {
* @param array $arguments
* Some arguments for the xpath.
*
* @return array|FALSE
* @return array|false
* The return value of the xpath search. For details on the xpath string
* format and return values see the SimpleXML documentation,
* http://php.net/manual/function.simplexml-element-xpath.php.
......
......@@ -97,7 +97,7 @@ protected function setUp() {
* @param \Drupal\views\ViewExecutable $view
* The view.
*
* @return array|FALSE
* @return array|false
* The render cache result or FALSE if not existent.
*/
protected function getRenderCache(ViewExecutable $view) {
......
......@@ -46,7 +46,6 @@
<rule ref="Drupal.Commenting.FunctionComment">
<exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidReturn"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidReturnNotVoid"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidTypeHint"/>
<exclude name="Drupal.Commenting.FunctionComment.Missing"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment