Commit 08b7a3fb authored by alexpott's avatar alexpott

Issue #2783393 by Mile23: Fix...

Issue #2783393 by Mile23: Fix 'Drupal.Commenting.FunctionComment.IncorrectParamVarName' coding standard
parent 182f0316
......@@ -440,7 +440,7 @@ protected function dumpValue($value) {
*
* @param string $id
* The ID of the service to get a reference for.
* @param \Symfony\Component\DependencyInjection\Reference|NULL $reference
* @param \Symfony\Component\DependencyInjection\Reference|null $reference
* (optional) The reference object to process; needed to get the invalid
* behavior value.
*
......
......@@ -349,7 +349,7 @@ public static function mergeDeepArray(array $arrays, $preserve_integer_keys = FA
*
* @param array $array
* The filtered nested array.
* @param callable|NULL $callable
* @param callable|null $callable
* The callable to apply for filtering.
*
* @return array
......
......@@ -24,7 +24,7 @@ public function applies(Request $request);
/**
* Authenticates the user.
*
* @param \Symfony\Component\HttpFoundation\Request|NULL $request
* @param \Symfony\Component\HttpFoundation\Request|null $request
* The request object.
*
* @return \Drupal\Core\Session\AccountInterface|NULL
......
......@@ -28,14 +28,14 @@ class ChainedFastBackendFactory implements CacheFactoryInterface {
/**
* Constructs ChainedFastBackendFactory object.
*
* @param \Drupal\Core\Site\Settings|NULL $settings
* @param \Drupal\Core\Site\Settings|null $settings
* (optional) The settings object.
* @param string|NULL $consistent_service_name
* @param string|null $consistent_service_name
* (optional) The service name of the consistent backend factory. Defaults
* to:
* - $settings->get('cache')['default'] (if specified)
* - 'cache.backend.database' (if the above isn't specified)
* @param string|NULL $fast_service_name
* @param string|null $fast_service_name
* (optional) The service name of the fast backend factory. Defaults to:
* - 'cache.backend.apcu' (if the PHP process has APCu enabled)
* - NULL (if the PHP process doesn't have APCu enabled)
......
......@@ -1443,7 +1443,7 @@ protected function updateSharedTableSchema(FieldStorageDefinitionInterface $stor
*
* @param array $entity_schema
* The entity schema definition.
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|NULL $storage_definition
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|null $storage_definition
* (optional) If a field storage definition is specified, only indexes and
* keys involving its columns will be processed. Otherwise all defined
* entity indexes and keys will be processed.
......@@ -1500,7 +1500,7 @@ protected function createEntitySchemaIndexes(array $entity_schema, FieldStorageD
*
* @param array $entity_schema_data
* The entity schema data definition.
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|NULL $storage_definition
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface|null $storage_definition
* (optional) If a field storage definition is specified, only indexes and
* keys involving its columns will be processed. Otherwise all defined
* entity indexes and keys will be processed.
......
......@@ -13,7 +13,7 @@ interface MenuActiveTrailInterface {
/**
* Gets the active trail IDs of the specified menu tree.
*
* @param string|NULL $menu_name
* @param string|null $menu_name
* (optional) The menu name of the requested tree. If omitted, all menu
* trees will be searched.
*
......@@ -25,7 +25,7 @@ public function getActiveTrailIds($menu_name);
/**
* Fetches a menu link which matches the route name, parameters and menu name.
*
* @param string|NULL $menu_name
* @param string|null $menu_name
* (optional) The menu within which to find the active link. If omitted, all
* menus will be searched.
*
......
......@@ -135,7 +135,7 @@ protected function getParentDepthLimit($id) {
* An excluded menu link.
* @param int $depth_limit
* The maximum depth of menu links considered for the select options.
* @param \Drupal\Core\Cache\CacheableMetadata|NULL &$cacheability
* @param \Drupal\Core\Cache\CacheableMetadata|null &$cacheability
* The object to add cacheability metadata to, if not NULL.
*/
protected function parentSelectOptionsTreeWalk(array $tree, $menu_name, $indent, array &$options, $exclude, $depth_limit, CacheableMetadata &$cacheability = NULL) {
......
......@@ -18,7 +18,7 @@ interface MenuParentFormSelectorInterface {
* @param array $menus
* Optional array of menu names as keys and titles as values to limit
* the select options. If NULL, all menus will be included.
* @param \Drupal\Core\Cache\CacheableMetadata|NULL &$cacheability
* @param \Drupal\Core\Cache\CacheableMetadata|null &$cacheability
* Optional cacheability metadata object, which will be populated based on
* the accessibility of the links and the cacheability of the links.
*
......
......@@ -78,7 +78,7 @@ class SessionManager extends NativeSessionStorage implements SessionManagerInter
* The session metadata bag.
* @param \Drupal\Core\Session\SessionConfigurationInterface $session_configuration
* The session configuration interface.
* @param \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy|Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeSessionHandler|\SessionHandlerInterface|NULL $handler
* @param \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy|Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeSessionHandler|\SessionHandlerInterface|null $handler
* The object to register as a PHP session handler.
* @see \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::setSaveHandler()
*/
......
......@@ -573,7 +573,7 @@ public function renderVar($arg) {
*
* @param \Twig_Environment $env
* A Twig_Environment instance.
* @param mixed[]|\Traversable|NULL $value
* @param mixed[]|\Traversable|null $value
* The pieces to join.
* @param string $glue
* The delimiter with which to join the string. Defaults to an empty string.
......
......@@ -75,7 +75,7 @@ class UpdateRegistry {
* A list of enabled modules.
* @param \Drupal\Core\KeyValueStore\KeyValueStoreInterface $key_value
* The key value store.
* @param bool|NULL $include_tests
* @param bool|null $include_tests
* (optional) A flag whether to include tests in the scanning of modules.
*/
public function __construct($root, $site_path, array $enabled_modules, KeyValueStoreInterface $key_value, $include_tests = NULL) {
......
......@@ -18,7 +18,7 @@ class BlockRegionTest extends UnitTestCase {
*
* @param array $value
* The value to transform.
* @param \Drupal\migrate\Row|NULL $row
* @param \Drupal\migrate\Row|null $row
* (optional) The mocked row.
*
* @return array|string
......
......@@ -215,7 +215,7 @@ public function testMultilingualModeration() {
*
* @param \Drupal\node\NodeInterface $node
* The node to reload.
* @param int|FALSE $revision_id
* @param int|false $revision_id
* The specific revision ID to load. Defaults FALSE and just loads the
* default revision.
*
......
......@@ -120,7 +120,7 @@ protected static function filterXssDataAttributes($html) {
/**
* Get all allowed tags from a restrictions data structure.
*
* @param array|FALSE $restrictions
* @param array|false $restrictions
* Restrictions as returned by FilterInterface::getHTMLRestrictions().
*
* @return array
......@@ -144,7 +144,7 @@ protected static function getAllowedTags($restrictions) {
/**
* Get all forbidden tags from a restrictions data structure.
*
* @param array|FALSE $restrictions
* @param array|false $restrictions
* Restrictions as returned by FilterInterface::getHTMLRestrictions().
*
* @return array
......
......@@ -65,7 +65,7 @@ function assertFileHooksCalled($expected) {
* String with the hook name; for instance, 'load', 'save', 'insert', etc.
* @param int $expected_count
* Optional integer count.
* @param string|NULL $message
* @param string|null $message
* Optional translated string message.
*/
function assertFileHookCalled($hook, $expected_count = 1, $message = NULL) {
......
......@@ -317,7 +317,7 @@ function file_test_validator(File $file, $errors) {
* When the function is called with no $filepath parameter, the results are
* returned.
*
* @param string|NULL $filepath
* @param string|null $filepath
* File path
* @return array
* If $filepath is NULL, an array of all previous $filepath parameters
......
......@@ -15,7 +15,7 @@ abstract class FieldableEntity extends DrupalSqlBase {
*
* @param string $entity_type
* The entity type ID.
* @param string|NULL $bundle
* @param string|null $bundle
* (optional) The bundle.
*
* @return array[]
......
......@@ -56,7 +56,7 @@ function options_field_storage_config_delete(FieldStorageConfigInterface $field_
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition.
* @param \Drupal\Core\Entity\FieldableEntityInterface|NULL $entity
* @param \Drupal\Core\Entity\FieldableEntityInterface|null $entity
* (optional) The specific entity when this function is called from the
* context of a specific field on a specific entity. This allows custom
* 'allowed_values_function' callbacks to either restrict the values or
......
......@@ -290,7 +290,7 @@ protected function entityValues($entity_type_id) {
/**
* Enables the REST service interface for a specific entity type.
*
* @param string|FALSE $resource_type
* @param string|false $resource_type
* The resource type that should get REST API enabled or FALSE to disable all
* resource types.
* @param string $method
......
......@@ -148,13 +148,13 @@ public function providerTestSerialization() {
* The HTTP methods to test.
* @param string[] $supported_formats
* The supported formats for the REST route to be tested.
* @param string|FALSE $request_format
* @param string|false $request_format
* The value for the ?_format URL query argument, if any.
* @param string[] $request_headers
* The request headers to send, if any.
* @param string|NULL $request_body
* @param string|null $request_body
* The request body to send, if any.
* @param string|NULL $expected_response_content_type
* @param string|null $expected_response_content_type
* The expected MIME type of the response, if any.
* @param string $expected_response_content
* The expected content of the response.
......
......@@ -38,7 +38,7 @@ protected function setUp() {
* @param string $hit_or_miss
* 'HIT' if a page cache hit is expected, 'MISS' otherwise.
*
* @param array|FALSE $tags
* @param array|false $tags
* When expecting a page cache hit, you may optionally specify an array of
* expected cache tags. While FALSE, the cache tags will not be verified.
*/
......
......@@ -29,7 +29,7 @@ protected function setUp() {
* The role ID.
* @param string $label
* The role's expected label.
* @param int|NULL $original_rid
* @param int|null $original_rid
* The original (integer) ID of the role, to check permissions.
*/
protected function assertEntity($id, $label, $original_rid) {
......
......@@ -44,7 +44,6 @@
<rule ref="Drupal.Commenting.DocCommentStar"/>
<rule ref="Drupal.Commenting.FileComment"/>
<rule ref="Drupal.Commenting.FunctionComment">
<exclude name="Drupal.Commenting.FunctionComment.IncorrectParamVarName"/>
<exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
<exclude name="Drupal.Commenting.FunctionComment.InvalidReturn"/>
......
......@@ -545,7 +545,7 @@ protected function generatePlaceholderElement() {
}
/**
* @param FALSE|array $cid_parts
* @param false|array $cid_parts
* @param array $expected_data
* FALSE if no render cache item is expected, a render array with the
* expected values if a render cache item is expected.
......
......@@ -24,7 +24,7 @@ class PhpTransliterationTest extends UnitTestCase {
* The string which was not transliterated yet.
* @param string $expected
* The string expected after the transliteration.
* @param string|NULL $printable
* @param string|null $printable
* (optional) An alternative version of the original string which is
* printable in the output.
*
......
......@@ -811,7 +811,7 @@ public function testFromRouteUriWithMissingRouteName() {
* Creates a mock access manager for the access tests.
*
* @param bool $access
* @param \Drupal\Core\Session\AccountInterface|NULL $account
* @param \Drupal\Core\Session\AccountInterface|null $account
*
* @return \Drupal\Core\Access\AccessManagerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
......
......@@ -112,7 +112,7 @@ public function providerTestFormatBacktrace() {
/**
* Creates a mock backtrace item.
*
* @param string|NULL $function
* @param string|null $function
* (optional) The function name to use in the backtrace item.
* @param string $class
* (optional) The class to use in the backtrace item.
......
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