Commit fa841b80 authored by jhodgdon's avatar jhodgdon

Issue #2105065 by tim.plunkett, dawehner: Standards cleanup for null and other types in API docs

parent 755cc547
......@@ -365,7 +365,7 @@ function _drupal_rewrite_settings_is_array_index($type) {
*
* Makes the new settings global.
*
* @param array|NULL $ref
* @param array|null $ref
* A reference to a nested index in $GLOBALS.
* @param array|object $variable
* The nested value of the setting being copied.
......
......@@ -36,7 +36,7 @@ class BreadcrumbManager implements BreadcrumbBuilderInterface {
*
* Set to NULL if the array needs to be re-calculated.
*
* @var array|NULL
* @var array|null
*/
protected $sortedBuilders;
......
......@@ -22,7 +22,7 @@ interface TitleResolverInterface {
* @param \Symfony\Component\Routing\Route $route
* The route information of the route to fetch the title.
*
* @return string|NULL
* @return string|null
* The title for the route.
*/
public function getTitle(Request $request, Route $route);
......
......@@ -100,7 +100,7 @@ public function access(EntityInterface $entity, $operation, $langcode = Language
* @param array $access
* An array of access results of the fired access hook.
*
* @return bool|NULL
* @return bool|null
* Returns FALSE if access should be denied, TRUE if access should be
* granted and NULL if no module denied access.
*/
......
......@@ -64,7 +64,7 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
/**
* Forwards the request to another controller.
*
* @param string|NULL $controller
* @param string|null $controller
* The controller name (a string like BlogBundle:Post:index).
* @param array $attributes
* An array of request attributes.
......
......@@ -196,7 +196,7 @@ public function clearCachedDefinitions() {
/**
* Returns the cached plugin definitions of the decorated discovery class.
*
* @return array|NULL
* @return array|null
* On success this will return an array of plugin definitions. On failure
* this should return NULL, indicating to other methods that this has not
* yet been defined. Success with no values should return as an empty array
......
......@@ -45,7 +45,7 @@ public function hasPermission($permission);
/**
* Returns the session ID.
*
* @return string|NULL
* @return string|null
* The session ID or NULL if this user does not have an active session.
*/
public function getSessionId();
......@@ -53,7 +53,7 @@ public function getSessionId();
/**
* Returns the secure session ID.
*
* @return string|NULL
* @return string|null
* The session ID or NULL if this user does not have an active secure session.
*/
public function getSecureSessionId();
......
......@@ -83,7 +83,7 @@ function hook_block_view_BASE_BLOCK_ID_alter(array &$build, \Drupal\block\BlockP
* @param string $langcode
* The language code to perform the access check operation on.
*
* @return bool|NULL
* @return bool|null
* FALSE denies access. TRUE allows access unless another module returns
* FALSE. If all modules return NULL, then default access rules from
* \Drupal\block\BlockAccessController::checkAccess() are used.
......
......@@ -19,12 +19,12 @@ interface EditorSelectorInterface {
*
* @param string $formatter_type
* The field's formatter type name.
* @param \Drupal\Core\Entity\Field\FieldDefinitionInterface $field_definition
* @param \Drupal\Core\Entity\Field\FieldDefinitionInterface $instance
* The field definition.
* @param array $items
* The field's item values.
*
* @return string|NULL
* @return string|null
* The editor to use, or NULL to not enable in-place editing.
*/
public function getEditor($formatter_type, FieldDefinitionInterface $instance, array $items);
......
......@@ -39,7 +39,7 @@ class SelectionBase implements SelectionInterface {
/**
* The entity object, or NULL
*
* @var NULL|EntityInterface
* @var \Drupal\Core\Entity\EntityInterface|null
*/
protected $entity;
......
......@@ -301,7 +301,7 @@ public function hasTranslation($name, Language $language) {
*
* @param string $langcode
* The language code.
* @param string|NULL $name
* @param string|null $name
* Name of the original configuration. Set to NULL to get the name prefix
* for all $langcode overrides.
*
......
......@@ -596,7 +596,7 @@ function locale_js_alter(&$javascript) {
*
* @param array $files
* An array of local file paths.
* @return string|NULL
* @return string|null
* The filepath to the translation file or NULL if no translation is
* applicable.
*/
......
......@@ -35,7 +35,7 @@ interface EntityResolverInterface {
* @param string $entity_type
* The type of entity being resolved; e.g., 'node' or 'user'.
*
* @return string|NULL
* @return string|null
* Returns the local entity ID, if found. Otherwise, returns NULL.
*/
public function resolve(NormalizerInterface $normalizer, $data, $entity_type);
......
......@@ -719,7 +719,7 @@ function hook_entity_operation_alter(array &$operations, \Drupal\Core\Entity\Ent
* (optional) The entity field object on which the operation is to be
* performed.
*
* @return bool|NULL
* @return bool|null
* TRUE if access should be allowed, FALSE if access should be denied and NULL
* if the implementation has no opinion.
*/
......
......@@ -36,7 +36,7 @@ class ViewsSelection implements SelectionInterface {
/**
* The entity object, or NULL
*
* @var NULL|EntityInterface
* @var \Drupal\Core\Entity\EntityInterface|null
*/
protected $entity;
......
......@@ -2768,7 +2768,7 @@ public function getSpecialBlocks() {
/**
* Render the exposed form as block.
*
* @return string|NULL
* @return string|null
* The rendered exposed form as string or NULL otherwise.
*/
public function viewExposedFormBlocks() {
......
......@@ -1288,7 +1288,7 @@ public function execute($display_id = NULL) {
* @param string $display_id
* The machine name of the display, which should be rendered.
*
* @return (string|NULL)
* @return string|null
* Return the output of the rendered view or NULL if something failed in the process.
*/
public function render($display_id = NULL) {
......
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