From d98bbc9ab09392eab1933aef46250e2040008234 Mon Sep 17 00:00:00 2001 From: Lars Toomre Date: Fri, 7 Dec 2012 11:50:32 -0500 Subject: [PATCH] Issue 1860690 by Lars Toomre: Correct Boolean use in docblocks --- core/includes/bootstrap.inc | 4 ++-- core/includes/install.core.inc | 2 +- core/includes/menu.inc | 2 +- core/includes/schema.inc | 4 ++-- core/includes/session.inc | 6 ++--- core/includes/theme.inc | 20 ++++++++-------- core/includes/theme.maintenance.inc | 2 +- core/includes/token.inc | 6 ++--- .../lib/Drupal/Component/Datetime/DateTimePlus.php | 10 ++++---- core/lib/Drupal/Component/Gettext/PoItem.php | 6 ++--- .../Drupal/Component/Gettext/PoStreamReader.php | 2 +- core/lib/Drupal/Core/Ajax/AjaxResponse.php | 6 ++--- core/lib/Drupal/Core/Ajax/SettingsCommand.php | 7 +++--- .../CacheDecorator/AliasManagerCacheDecorator.php | 2 +- .../Core/Database/Driver/mysql/Connection.php | 2 +- .../Core/Database/Driver/sqlite/Connection.php | 6 ++--- core/lib/Drupal/Core/Database/Query/Merge.php | 2 +- core/lib/Drupal/Core/Database/Query/Select.php | 5 ++-- core/lib/Drupal/Core/Database/Transaction.php | 4 ++-- .../Core/Entity/DatabaseStorageController.php | 4 ++-- .../Core/Entity/DatabaseStorageControllerNG.php | 4 ++-- .../Core/Entity/EntityFormControllerInterface.php | 2 +- .../Core/Entity/Field/FieldItemInterface.php | 2 +- .../Core/Entity/Field/Type/EntityTranslation.php | 9 ++++---- core/lib/Drupal/Core/Entity/Query/QueryBase.php | 2 +- .../lib/Drupal/Core/Password/PasswordInterface.php | 2 +- core/lib/Drupal/Core/Path/AliasManager.php | 2 +- core/lib/Drupal/Core/Queue/QueueInterface.php | 2 +- .../Drupal/Core/TypedData/ComplexDataInterface.php | 2 +- core/lib/Drupal/Core/TypedData/ListInterface.php | 2 +- core/lib/Drupal/Core/TypedData/Type/Boolean.php | 8 +++---- .../lib/Drupal/comment/Tests/CommentTestBase.php | 27 +++++++++++----------- .../Drupal/contact/Tests/ContactSitewideTest.php | 4 ++-- .../forum/lib/Drupal/forum/Tests/ForumTest.php | 15 ++++++------ core/modules/locale/locale.batch.inc | 2 +- core/modules/locale/locale.compare.inc | 2 +- .../lib/Drupal/node/Plugin/Core/Entity/Node.php | 2 +- core/modules/openid/openid.module | 4 +++- .../poll/lib/Drupal/poll/Tests/PollTestBase.php | 2 +- .../search/lib/Drupal/search/SearchQuery.php | 6 ++--- .../simpletest/lib/Drupal/simpletest/TestBase.php | 2 +- .../system/Tests/KeyValueStore/StorageTestBase.php | 2 +- .../Drupal/system/Tests/System/UnicodeUnitTest.php | 2 +- core/modules/tracker/tracker.module | 4 ++-- .../EntityTranslationControllerInterface.php | 2 +- .../Tests/EntityTranslationUITest.php | 2 +- .../translation_entity/translation_entity.module | 5 ++-- .../lib/Drupal/views/Plugin/views/HandlerBase.php | 3 ++- 48 files changed, 117 insertions(+), 108 deletions(-) diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 77560459b28d077e080a242b40455fe562df80d3..fccf143cdf11101015c7ab56905f4f2666163ef1 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -2103,8 +2103,8 @@ function drupal_anonymous_user() { * - DRUPAL_BOOTSTRAP_FULL: Fully loads Drupal. Validates and fixes input * data. * @param $new_phase - * A boolean, set to FALSE if calling drupal_bootstrap from inside a - * function called from drupal_bootstrap (recursion). + * (optional) A Boolean, set to FALSE if calling drupal_bootstrap from inside + * a function called from drupal_bootstrap (recursion). Defaults to TRUE. * * @return * The most recently completed phase. diff --git a/core/includes/install.core.inc b/core/includes/install.core.inc index ef50d04e0cd993956904eb9fa9db46f60adb7e1d..b68139daf9dd04042dbbaab17fb0b0b46bca7e58 100644 --- a/core/includes/install.core.inc +++ b/core/includes/install.core.inc @@ -72,7 +72,7 @@ function install_drupal($settings = array()) { global $install_state; // Initialize the installation state with the settings that were passed in, - // as well as a boolean indicating whether or not this is an interactive + // as well as a Boolean indicating whether or not this is an interactive // installation. $interactive = empty($settings); $install_state = $settings + array('interactive' => $interactive) + install_state_defaults(); diff --git a/core/includes/menu.inc b/core/includes/menu.inc index 6492b10eefcb4381ac0cef274405d0642461fb12..df6c61e4ac6f9f223848ba7919983a1b9f5d5596 100644 --- a/core/includes/menu.inc +++ b/core/includes/menu.inc @@ -1617,7 +1617,7 @@ function theme_menu_link(array $variables) { * - element: A render element containing: * - #link: A menu link array with 'title', 'href', and 'localized_options' * keys. - * - #active: A boolean indicating whether the local task is active. + * - #active: A Boolean indicating whether the local task is active. * * @ingroup themeable */ diff --git a/core/includes/schema.inc b/core/includes/schema.inc index 7661dcb2ab255a858ba61c1f4ab71e7a731f1f16..cb54241f8a19ec92570650a8a4572e8670aa16fa 100644 --- a/core/includes/schema.inc +++ b/core/includes/schema.inc @@ -241,8 +241,8 @@ function drupal_install_schema($module) { * * @return array * An array of arrays with the following key/value pairs: - * - success: a boolean indicating whether the query succeeded. - * - query: the SQL query(s) executed, passed through check_plain(). + * - success: A Boolean indicating whether the query succeeded. + * - query: The SQL query(s) executed, passed through check_plain(). */ function drupal_uninstall_schema($module) { $schema = drupal_get_schema_unprocessed($module); diff --git a/core/includes/session.inc b/core/includes/session.inc index 9ffd3d13cc1c2efa1e9e8b716ed273675375e650..6479b81416396619dc926e54c0c517825779f2b5 100644 --- a/core/includes/session.inc +++ b/core/includes/session.inc @@ -448,10 +448,10 @@ function _drupal_session_destroy($sid) { /** * Deletes the session cookie. * - * @param $name + * @param string $name * Name of session cookie to delete. - * @param boolean $secure - * Force the secure value of the cookie. + * @param bool|null $secure + * (optional) Force the secure value of the cookie. Defaults to NULL. */ function _drupal_session_delete_cookie($name, $secure = NULL) { global $is_https; diff --git a/core/includes/theme.inc b/core/includes/theme.inc index 8a35b6ed8b9c446f331ba1effa40dc6b06dfa46b..2f74843296edbef5f3cfa5b63b9368be76d18485 100644 --- a/core/includes/theme.inc +++ b/core/includes/theme.inc @@ -61,7 +61,7 @@ * Either the name of a theme or a full theme object. * * @return - * Boolean TRUE if the theme is enabled or is the site administration theme; + * A Boolean TRUE if the theme is enabled or is the site administration theme; * FALSE otherwise. */ function drupal_theme_access($theme) { @@ -245,11 +245,11 @@ function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callb * Get the theme registry. * * @param bool $complete - * Optional boolean to indicate whether to return the complete theme registry - * array or an instance of the Drupal\Core\Utility\ThemeRegistry class. - * If TRUE, the complete theme registry array will be returned. This is useful - * if you want to foreach over the whole registry, use array_* functions or - * inspect it in a debugger. If FALSE, an instance of the + * (optional) A Boolean to indicate whether to return the complete theme + * registry array or an instance of the Drupal\Core\Utility\ThemeRegistry + * class. If TRUE, the complete theme registry array will be returned. This is + * useful if you want to foreach over the whole registry, use array_* + * functions or inspect it in a debugger. If FALSE, an instance of the * Drupal\Core\Utility\ThemeRegistry class will be returned, this provides an * ArrayObject which allows it to be accessed with array syntax and isset(), * and should be more lightweight than the full registry. Defaults to TRUE. @@ -1876,14 +1876,14 @@ function theme_breadcrumb($variables) { * cell. * - rows: An array of table rows. Every row is an array of cells, or an * associative array with the following keys: - * - "data": an array of cells + * - data: An array of cells. * - Any HTML attributes, such as "class", to apply to the table row. - * - "no_striping": a boolean indicating that the row should receive no + * - no_striping: A Boolean indicating that the row should receive no * 'even / odd' styling. Defaults to FALSE. * Each cell can be either a string or an associative array with the * following keys: - * - "data": The string to display in the table cell. - * - "header": Indicates this cell is a header. + * - data: The string to display in the table cell. + * - header: Indicates this cell is a header. * - Any HTML attributes, such as "colspan", to apply to the table cell. * Here's an example for $rows: * @code diff --git a/core/includes/theme.maintenance.inc b/core/includes/theme.maintenance.inc index 4b3e80ceac40a42bcb394d8bb03f7cb050dd9ca0..736975f7346066ebd8abc8da696807a8e06f00c2 100644 --- a/core/includes/theme.maintenance.inc +++ b/core/includes/theme.maintenance.inc @@ -199,7 +199,7 @@ function theme_authorize_report($variables) { * @param $variables * An associative array containing: * - message: The log message. - * - success: A boolean indicating failure or success. + * - success: A Boolean indicating failure or success. * * @ingroup themeable */ diff --git a/core/includes/token.inc b/core/includes/token.inc index a6f80647670f6d028a390fb67f7356d74f43feff..c42113dae4e7c6c5f86946194b835a2022478a10 100644 --- a/core/includes/token.inc +++ b/core/includes/token.inc @@ -65,9 +65,9 @@ * of token replacements after they are generated. For example, a module * using tokens in a text-only email might provide a callback to strip HTML * entities from token values before they are inserted into the final text. - * - clear: A boolean flag indicating that tokens should be removed from the + * - clear: A Boolean flag indicating that tokens should be removed from the * final text if no replacement value can be generated. - * - sanitize: A boolean flag indicating that tokens should be sanitized for + * - sanitize: A Boolean flag indicating that tokens should be sanitized for * display to a web browser. Defaults to TRUE. Developers who set this * option to FALSE assume responsibility for running filter_xss(), * check_plain() or other appropriate scrubbing functions before displaying @@ -160,7 +160,7 @@ function token_scan($text) { * array of token replacements after they are generated. Can be used when * modules require special formatting of token text, for example URL * encoding or truncation to a specific length. - * - sanitize: A boolean flag indicating that tokens should be sanitized for + * - sanitize: A Boolean flag indicating that tokens should be sanitized for * display to a web browser. Developers who set this option to FALSE assume * responsibility for running filter_xss(), check_plain() or other * appropriate scrubbing functions before displaying data to users. diff --git a/core/lib/Drupal/Component/Datetime/DateTimePlus.php b/core/lib/Drupal/Component/Datetime/DateTimePlus.php index 283daaeb11f98cfcf1b1396e0fd52adca708fa9d..f005cd78668fa46715b00e3f92f7c1fe7e944ace 100644 --- a/core/lib/Drupal/Component/Datetime/DateTimePlus.php +++ b/core/lib/Drupal/Component/Datetime/DateTimePlus.php @@ -286,7 +286,7 @@ protected function prepareFormat($format) { /** * Checks whether input is a DateTime object. * - * @return boolean + * @return bool * TRUE if the input time is a DateTime object. */ public function inputIsObject() { @@ -314,7 +314,7 @@ protected function constructFromObject() { * avoid interpreting a value like '2010' with a format of 'Y' as a * timestamp. The 'U' format indicates this is a timestamp. * - * @return boolean + * @return bool * TRUE if the input time is a timestamp. */ public function inputIsTimestamp() { @@ -340,7 +340,7 @@ protected function constructFromTimestamp() { /** * Checks if input is an array of date parts. * - * @return boolean + * @return bool * TRUE if the input time is a DateTime object. */ public function inputIsArray() { @@ -377,7 +377,7 @@ protected function constructFromArray() { /** * Checks if input is a string with an expected format. * - * @return boolean + * @return bool * TRUE if the input time is a string with an expected format. */ public function inputIsFormat() { @@ -580,7 +580,7 @@ public static function prepareArray($array, $force_valid_date = FALSE) { * @param array $array * An array of datetime values keyed by date part. * - * @return boolean + * @return bool * TRUE if the datetime parts contain valid values, otherwise FALSE. */ public static function checkArray($array) { diff --git a/core/lib/Drupal/Component/Gettext/PoItem.php b/core/lib/Drupal/Component/Gettext/PoItem.php index 599a58a5a5a1ae134cefbbc749997ae8c0305d4d..6d88ccf523b0f480e06fc4589882fd14a3c68211 100644 --- a/core/lib/Drupal/Component/Gettext/PoItem.php +++ b/core/lib/Drupal/Component/Gettext/PoItem.php @@ -40,7 +40,7 @@ class PoItem { /** * Flag indicating if this translation has plurals. * - * @var boolean + * @var bool */ private $_plural; @@ -138,7 +138,7 @@ function setTranslation($translation) { /** * Set if the translation has plural values. * - * @param boolean $plural + * @param bool $plural */ function setPlural($plural) { $this->_plural = $plural; @@ -147,7 +147,7 @@ function setPlural($plural) { /** * Get if the translation has plural values. * - * @return boolean $plural + * @return bool $plural */ function isPlural() { return $this->_plural; diff --git a/core/lib/Drupal/Component/Gettext/PoStreamReader.php b/core/lib/Drupal/Component/Gettext/PoStreamReader.php index 74a9baee34903070a63a25b03ed6c5c8b720df53..d75235bc90a75fe76641f8756fcbbbe7066ceec4 100644 --- a/core/lib/Drupal/Component/Gettext/PoStreamReader.php +++ b/core/lib/Drupal/Component/Gettext/PoStreamReader.php @@ -100,7 +100,7 @@ class PoStreamReader implements PoStreamInterface, PoReaderInterface { /** * Indicator of whether the stream reading is finished. * - * @var boolean + * @var bool */ private $_finished; diff --git a/core/lib/Drupal/Core/Ajax/AjaxResponse.php b/core/lib/Drupal/Core/Ajax/AjaxResponse.php index 492665e6136bd1c7eab9b37737e390f3cecea2bb..5d3d0ce2f663fa3e6268980a847ea04fc4a093c4 100644 --- a/core/lib/Drupal/Core/Ajax/AjaxResponse.php +++ b/core/lib/Drupal/Core/Ajax/AjaxResponse.php @@ -27,9 +27,9 @@ class AjaxResponse extends JsonResponse { * * @param object $command * An AJAX command object implementing CommandInterface. - * @param boolean $prepend - * A boolean which determines whether the new command should be executed - * before previously added commands. Defaults to FALSE. + * @param bool $prepend + * (optional) A Boolean which determines whether the new command should be + * executed before previously added commands. Defaults to FALSE. * * @return AjaxResponse * The current AjaxResponse. diff --git a/core/lib/Drupal/Core/Ajax/SettingsCommand.php b/core/lib/Drupal/Core/Ajax/SettingsCommand.php index 7a00f8ac4ea949d41c2bb56f046861577a84536c..1e6af9b6f1b9b7966e22ceccde7d6a5544ff7dd3 100644 --- a/core/lib/Drupal/Core/Ajax/SettingsCommand.php +++ b/core/lib/Drupal/Core/Ajax/SettingsCommand.php @@ -37,7 +37,7 @@ class SettingsCommand implements CommandInterface { * By default (FALSE), the settings that are passed to Drupal.attachBehaviors * will not include the global Drupal.settings. * - * @var boolean + * @var bool */ protected $merge; @@ -46,8 +46,9 @@ class SettingsCommand implements CommandInterface { * * @param array $settings * An array of key/value pairs of JavaScript settings. - * @param boolean $merge - * Whether the settings should be merged into the global Drupal.settings. + * @param bool $merge + * (optional) Whether the settings should be merged into the global + * Drupal.settings. Defaults to FALSE. */ public function __construct(array $settings, $merge = FALSE) { $this->settings = $settings; diff --git a/core/lib/Drupal/Core/CacheDecorator/AliasManagerCacheDecorator.php b/core/lib/Drupal/Core/CacheDecorator/AliasManagerCacheDecorator.php index ae5c8bca4fd0d72dddf49d9daef61baa7445bcdf..d502cd72f28fc3b11ac7917a9816c9b563e247fc 100644 --- a/core/lib/Drupal/Core/CacheDecorator/AliasManagerCacheDecorator.php +++ b/core/lib/Drupal/Core/CacheDecorator/AliasManagerCacheDecorator.php @@ -42,7 +42,7 @@ class AliasManagerCacheDecorator implements CacheDecoratorInterface, AliasManage /** * Whether the cache needs to be written. * - * @var boolean + * @var bool */ protected $cacheNeedsWriting = TRUE; diff --git a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php index 128780ff0a07ec443d26c0ff2dd3c38c1d20dbb3..0984c60647a8ad77e2e7182086ba2af3633049bc 100644 --- a/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/mysql/Connection.php @@ -32,7 +32,7 @@ class Connection extends DatabaseConnection { /** * Flag to indicate if the cleanup function in __destruct() should run. * - * @var boolean + * @var bool */ protected $needsCleanup = FALSE; diff --git a/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php b/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php index abda55628d4413c679ae191ed0bf730fb379f391..57c8c038a985096a1907d886025f4cae3599dbf4 100644 --- a/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php +++ b/core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php @@ -30,7 +30,7 @@ class Connection extends DatabaseConnection { * Version of sqlite lower then 3.6.8 can't use savepoints. * See http://www.sqlite.org/releaselog/3_6_8.html * - * @var boolean + * @var bool */ protected $savepointSupport = FALSE; @@ -42,7 +42,7 @@ class Connection extends DatabaseConnection { /** * Whether or not the active transaction (if any) will be rolled back. * - * @var boolean + * @var bool */ protected $willRollback; @@ -62,7 +62,7 @@ class Connection extends DatabaseConnection { * This variable is set to public because Schema needs to * access it. However, it should not be manually set. * - * @var boolean + * @var bool */ var $tableDropped = FALSE; diff --git a/core/lib/Drupal/Core/Database/Query/Merge.php b/core/lib/Drupal/Core/Database/Query/Merge.php index 3d7564afe173bc2bb25ed86894deae9bedb13859..ecec2731815bdbb930eebd483dbf7a9395c78d87 100644 --- a/core/lib/Drupal/Core/Database/Query/Merge.php +++ b/core/lib/Drupal/Core/Database/Query/Merge.php @@ -121,7 +121,7 @@ class Merge extends Query implements ConditionInterface { /** * Flag indicating whether an UPDATE is necessary. * - * @var boolean + * @var bool */ protected $needsUpdate = FALSE; diff --git a/core/lib/Drupal/Core/Database/Query/Select.php b/core/lib/Drupal/Core/Database/Query/Select.php index 1bfe9a0f4e83f3b9519545888b2c635a049993f4..db2bc4bc8d317a213020ac644f02a862e2222762 100644 --- a/core/lib/Drupal/Core/Database/Query/Select.php +++ b/core/lib/Drupal/Core/Database/Query/Select.php @@ -86,7 +86,7 @@ class Select extends Query implements SelectInterface { /** * Whether or not this query should be DISTINCT * - * @var boolean + * @var bool */ protected $distinct = FALSE; @@ -112,7 +112,8 @@ class Select extends Query implements SelectInterface { /** * Indicates if preExecute() has already been called. - * @var boolean + * + * @var bool */ protected $prepared = FALSE; diff --git a/core/lib/Drupal/Core/Database/Transaction.php b/core/lib/Drupal/Core/Database/Transaction.php index 2dceb24d6814a06fea78958a26f08f2b4b1585d3..7729312492882d0c1794dfde1d57a58407b5a7e9 100644 --- a/core/lib/Drupal/Core/Database/Transaction.php +++ b/core/lib/Drupal/Core/Database/Transaction.php @@ -36,9 +36,9 @@ class Transaction { protected $connection; /** - * A boolean value to indicate whether this transaction has been rolled back. + * A Boolean value to indicate whether this transaction has been rolled back. * - * @var Boolean + * @var bool */ protected $rolledBack = FALSE; diff --git a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php index bf515dea1899dedf6ef1cead8b337fda7a334ba8..ef0807a90b16a27fe333e386e97cbec5b3f48d9d 100644 --- a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php +++ b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php @@ -85,7 +85,7 @@ class DatabaseStorageController implements EntityStorageControllerInterface { * * Has the value FALSE if this entity does not use revisions. * - * @var string + * @var string|false */ protected $revisionKey; @@ -101,7 +101,7 @@ class DatabaseStorageController implements EntityStorageControllerInterface { * * Set by entity info. * - * @var boolean + * @var bool */ protected $cache; diff --git a/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php b/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php index 10a7a77e722fbcaa1275f662308360f655c68ce5..7a963b44edb8a194dd7746f65e53b8729579e31b 100644 --- a/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php +++ b/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php @@ -141,8 +141,8 @@ protected function attachLoad(&$queried_entities, $load_revision = FALSE) { * * @param array $records * Associative array of query results, keyed on the entity ID. - * @param boolean $load_revision - * (optional) TRUE if the revision should be loaded, defaults to FALSE. + * @param bool $load_revision + * (optional) TRUE if the revision should be loaded. Defaults to FALSE. * * @return array * An array of entity objects implementing the EntityInterface. diff --git a/core/lib/Drupal/Core/Entity/EntityFormControllerInterface.php b/core/lib/Drupal/Core/Entity/EntityFormControllerInterface.php index fecb0783ff192f509d9e08bfef8ea027a8656ab2..91e278e250091c9d8639be4a74acc59a2e7d5a66 100644 --- a/core/lib/Drupal/Core/Entity/EntityFormControllerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityFormControllerInterface.php @@ -49,7 +49,7 @@ public function getFormLangcode(array $form_state); * @param array $form_state * A reference to a keyed array containing the current state of the form. * - * @return boolean + * @return bool * Returns TRUE if the entity form language matches the entity one. */ public function isDefaultFormLangcode($form_state); diff --git a/core/lib/Drupal/Core/Entity/Field/FieldItemInterface.php b/core/lib/Drupal/Core/Entity/Field/FieldItemInterface.php index 2b94e7a599411514153b23bdd4eccdac536d8bb5..7c410ccdaa7b23b6912fed89e8c74e288b4a58a9 100644 --- a/core/lib/Drupal/Core/Entity/Field/FieldItemInterface.php +++ b/core/lib/Drupal/Core/Entity/Field/FieldItemInterface.php @@ -58,7 +58,7 @@ public function __set($property_name, $value); * @param $property_name * The name of the property to get; e.g., 'title' or 'name'. * - * @return boolean + * @return bool * Returns TRUE if the property exists and is set, FALSE otherwise. */ public function __isset($property_name); diff --git a/core/lib/Drupal/Core/Entity/Field/Type/EntityTranslation.php b/core/lib/Drupal/Core/Entity/Field/Type/EntityTranslation.php index 280fca9a5ab1a8fd0f00b4b65e3cdec960f0d82c..ad05ded7f56542652272928260889cc851c5d392 100644 --- a/core/lib/Drupal/Core/Entity/Field/Type/EntityTranslation.php +++ b/core/lib/Drupal/Core/Entity/Field/Type/EntityTranslation.php @@ -46,14 +46,14 @@ class EntityTranslation extends TypedData implements IteratorAggregate, Accessib /** * Whether the entity translation acts in strict mode. * - * @var boolean + * @var bool */ protected $strict = TRUE; /** * Returns whether the entity translation acts in strict mode. * - * @return boolean + * @return bool * Whether the entity translation acts in strict mode. */ public function getStrictMode() { @@ -63,8 +63,9 @@ public function getStrictMode() { /** * Sets whether the entity translation acts in strict mode. * - * @param boolean $strict - * Whether the entity translation acts in strict mode. + * @param bool $strict + * (optional) Whether the entity translation acts in strict mode. Defaults + * to TRUE. * * @see \Drupal\Core\TypedData\TranslatableInterface::getTranslation() */ diff --git a/core/lib/Drupal/Core/Entity/Query/QueryBase.php b/core/lib/Drupal/Core/Entity/Query/QueryBase.php index d22dbacb4272398cd777be68b9f26904a6ae1140..7b7cf5d0dcabaaebfdd4c3c9ef9366b0c30cf1cb 100644 --- a/core/lib/Drupal/Core/Entity/Query/QueryBase.php +++ b/core/lib/Drupal/Core/Entity/Query/QueryBase.php @@ -31,7 +31,7 @@ /** * TRUE if this is a count query, FALSE if it isn't. * - * @var boolean + * @var bool */ protected $count = FALSE; diff --git a/core/lib/Drupal/Core/Password/PasswordInterface.php b/core/lib/Drupal/Core/Password/PasswordInterface.php index e14a6d8aa6f7e4ef876fd072fcc3bdd9bfff900d..b272db585ef45099aeb0f05b07edbd6477121ae8 100644 --- a/core/lib/Drupal/Core/Password/PasswordInterface.php +++ b/core/lib/Drupal/Core/Password/PasswordInterface.php @@ -56,7 +56,7 @@ public function check($password, $account); * @param Drupal\user\User * A user object with at least the fields from the {users} table. * - * @return boolean + * @return bool * TRUE or FALSE. */ public function userNeedsNewHash($account); diff --git a/core/lib/Drupal/Core/Path/AliasManager.php b/core/lib/Drupal/Core/Path/AliasManager.php index 47bf77bfddb28302f21c45088eacc6cb33914764..dd928b69b1ed9d365eac8cbcf3445fd028027704 100644 --- a/core/lib/Drupal/Core/Path/AliasManager.php +++ b/core/lib/Drupal/Core/Path/AliasManager.php @@ -64,7 +64,7 @@ class AliasManager implements AliasManagerInterface { /** * Whether lookupPath() has not yet been called. * - * @var boolean + * @var bool */ protected $firstLookup = TRUE; diff --git a/core/lib/Drupal/Core/Queue/QueueInterface.php b/core/lib/Drupal/Core/Queue/QueueInterface.php index 8e7e22c1091cebd0f45377421a4b2c4dff4480f0..f3bcda91cd8d7babc0a7a493b83560cb6a7874bd 100644 --- a/core/lib/Drupal/Core/Queue/QueueInterface.php +++ b/core/lib/Drupal/Core/Queue/QueueInterface.php @@ -82,7 +82,7 @@ public function deleteItem($item); * @param $item * The item returned by Drupal\Core\Queue\QueueInterface::claimItem(). * - * @return boolean + * @return bool * TRUE if the item has been released, FALSE otherwise. */ public function releaseItem($item); diff --git a/core/lib/Drupal/Core/TypedData/ComplexDataInterface.php b/core/lib/Drupal/Core/TypedData/ComplexDataInterface.php index 71364ce80b2d96ae21de79fd98ee20f4ce72a1e8..acc8b93f7191a292a34bbf6883c26e3d987f5fde 100644 --- a/core/lib/Drupal/Core/TypedData/ComplexDataInterface.php +++ b/core/lib/Drupal/Core/TypedData/ComplexDataInterface.php @@ -113,7 +113,7 @@ public function getPropertyDefinitions(); /** * Determines whether the data structure is empty. * - * @return boolean + * @return bool * TRUE if the data structure is empty, FALSE otherwise. */ public function isEmpty(); diff --git a/core/lib/Drupal/Core/TypedData/ListInterface.php b/core/lib/Drupal/Core/TypedData/ListInterface.php index 4ce6af01ab3b80e01d3999d0d7ab2af51f9c420e..27a22c8333f350fc6153795e63c35bb6f88c9d6a 100644 --- a/core/lib/Drupal/Core/TypedData/ListInterface.php +++ b/core/lib/Drupal/Core/TypedData/ListInterface.php @@ -25,7 +25,7 @@ /** * Determines whether the list contains any non-empty items. * - * @return boolean + * @return bool * TRUE if the list is empty, FALSE otherwise. */ public function isEmpty(); diff --git a/core/lib/Drupal/Core/TypedData/Type/Boolean.php b/core/lib/Drupal/Core/TypedData/Type/Boolean.php index 5714599994ba9a0e40a7ae10a934a387c5af3d81..d21d91c0818bab46431c2ba645bfb274b954a529 100644 --- a/core/lib/Drupal/Core/TypedData/Type/Boolean.php +++ b/core/lib/Drupal/Core/TypedData/Type/Boolean.php @@ -10,17 +10,17 @@ use Drupal\Core\TypedData\TypedDataInterface; /** - * The boolean data type. + * The Boolean data type. * - * The plain value of a boolean is a regular PHP boolean. For setting the value - * any PHP variable that casts to a boolean may be passed. + * The plain value of a Boolean is a regular PHP Boolean. For setting the value + * any PHP variable that casts to a Boolean may be passed. */ class Boolean extends TypedData implements TypedDataInterface { /** * The data value. * - * @var boolean + * @var bool */ protected $value; diff --git a/core/modules/comment/lib/Drupal/comment/Tests/CommentTestBase.php b/core/modules/comment/lib/Drupal/comment/Tests/CommentTestBase.php index 902dbddee4b2e37225d6cf16617254086ae089f7..b333da235189eba7aabf9cbc6f333ad1ba3de68e 100644 --- a/core/modules/comment/lib/Drupal/comment/Tests/CommentTestBase.php +++ b/core/modules/comment/lib/Drupal/comment/Tests/CommentTestBase.php @@ -152,13 +152,14 @@ function postComment($node, $comment, $subject = '', $contact = NULL) { /** * Checks current page for specified comment. * - * @param Drupal\comment\Comment $comment - * The comment object. - * @param boolean $reply - * Boolean indicating whether the comment is a reply to another comment. + * @param \Drupal\comment\Comment $comment + * (optional) The comment object. Defaults to NULL. + * @param bool $reply + * (optional) A Boolean indicating whether the comment is a reply to another + * comment. Defaults to FALSE. * - * @return boolean - * Boolean indicating whether the comment was found. + * @return bool + * A Boolean indicating whether the comment was found. */ function commentExists(Comment $comment = NULL, $reply = FALSE) { if ($comment) { @@ -189,8 +190,8 @@ function deleteComment(Comment $comment) { /** * Sets the value governing whether the subject field should be enabled. * - * @param boolean $enabled - * Boolean specifying whether the subject field should be enabled. + * @param bool $enabled + * A Boolean specifying whether the subject field should be enabled. */ function setCommentSubject($enabled) { $this->setCommentSettings('comment_subject_field', ($enabled ? '1' : '0'), 'Comment subject ' . ($enabled ? 'enabled' : 'disabled') . '.'); @@ -222,7 +223,7 @@ function setCommentPreview($mode) { /** * Sets the value governing whether the comment form is on its own page. * - * @param boolean $enabled + * @param bool $enabled * TRUE if the comment form should be displayed on the same page as the * comments; FALSE if it should be displayed on its own page. */ @@ -272,8 +273,8 @@ function setCommentSettings($name, $value, $message) { /** * Checks whether the commenter's contact information is displayed. * - * @return boolean - * Contact info is available. + * @return bool + * A Boolean indicating if Contact info is available. */ function commentContactInfoAvailable() { return preg_match('/(input).*?(name="name").*?(input).*?(name="mail").*?(input).*?(name="homepage")/s', $this->drupalGetContent()); @@ -286,8 +287,8 @@ function commentContactInfoAvailable() { * Comment to perform operation on. * @param string $operation * Operation to perform. - * @param boolean $aproval - * Operation is found on approval page. + * @param bool $aproval + * (optional) Operation is found on approval page. Defaults to FALSE. */ function performCommentOperation($comment, $operation, $approval = FALSE) { $edit = array(); diff --git a/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php b/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php index 96926983696b0d20a57f70fbbfaed846e2c0d28c..b36bbf7bf6d2662b0e93cda769f3df793d314d7b 100644 --- a/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php +++ b/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php @@ -231,7 +231,7 @@ function testAutoReply() { * @param string $reply * The auto-reply text that is sent to a user upon completing the contact * form. - * @param boolean $selected + * @param bool $selected * A Boolean indicating whether the category should be selected by default. */ function addCategory($id, $label, $recipients, $reply, $selected) { @@ -256,7 +256,7 @@ function addCategory($id, $label, $recipients, $reply, $selected) { * @param string $reply * The auto-reply text that is sent to a user upon completing the contact * form. - * @param boolean $selected + * @param bool $selected * A Boolean indicating whether the category should be selected by default. */ function updateCategory($id, $label, $recipients, $reply, $selected) { diff --git a/core/modules/forum/lib/Drupal/forum/Tests/ForumTest.php b/core/modules/forum/lib/Drupal/forum/Tests/ForumTest.php index 9bd703bbf46af5e4e4b421235e773ffed585e2ca..7305a8426ee5a4df0d4eddc1be7e2ebd39918356 100644 --- a/core/modules/forum/lib/Drupal/forum/Tests/ForumTest.php +++ b/core/modules/forum/lib/Drupal/forum/Tests/ForumTest.php @@ -447,8 +447,9 @@ private function doBasicTests($user, $admin) { * * @param array $forum * A forum array. - * @param boolean $container - * TRUE if $forum is a container; FALSE otherwise. + * @param bool $container + * (optional) TRUE if $forum is a container; FALSE otherwise. Defaults to + * FALSE. * * @return object * The created topic node. @@ -497,12 +498,12 @@ function createForumTopic($forum, $container = FALSE) { * * @param $node_user * The user who creates the node. - * @param Drupal\node\Node $node + * @param \Drupal\node\Node $node * The node being checked. - * @param $admin - * Boolean to indicate whether the user can 'access administration pages'. - * @param $response - * The exptected HTTP response code. + * @param bool $admin + * A Boolean to indicate whether the user can 'access administration pages'. + * @param int $response + * (optional) The exptected HTTP response code. Defaults to 200. */ private function verifyForums($node_user, Node $node, $admin, $response = 200) { $response2 = ($admin) ? 200 : 403; diff --git a/core/modules/locale/locale.batch.inc b/core/modules/locale/locale.batch.inc index a287e16d4ca07ab7a41ecff0c9f30930d841829e..e751e5ac6d5ae014f2d89571639a27a6861027eb 100644 --- a/core/modules/locale/locale.batch.inc +++ b/core/modules/locale/locale.batch.inc @@ -153,7 +153,7 @@ function locale_translation_batch_status_compare(&$context) { /** * Batch finished callback: Set result message. * - * @param boolean $success + * @param bool $success * TRUE if batch succesfully completed. * @param array $results * Batch results. diff --git a/core/modules/locale/locale.compare.inc b/core/modules/locale/locale.compare.inc index efe944bbe55f1d4733fda6d0224db7f72f0fd004..e0c0121f072754f37e40deb7870e440b2a2ff0d0 100644 --- a/core/modules/locale/locale.compare.inc +++ b/core/modules/locale/locale.compare.inc @@ -513,7 +513,7 @@ function locale_translation_source_build($project, $langcode, $filename = NULL) * @param string $url * The URL or URL pattern of the file. * - * @return boolean + * @return bool * TRUE if the $url is a remote file. */ function _locale_translation_file_is_remote($url) { diff --git a/core/modules/node/lib/Drupal/node/Plugin/Core/Entity/Node.php b/core/modules/node/lib/Drupal/node/Plugin/Core/Entity/Node.php index 47de776cd426716e4e2d151f48cf8192f4a70399..e7bf61dbc96616a8484af80320b7f93c966e3e60 100644 --- a/core/modules/node/lib/Drupal/node/Plugin/Core/Entity/Node.php +++ b/core/modules/node/lib/Drupal/node/Plugin/Core/Entity/Node.php @@ -77,7 +77,7 @@ class Node extends Entity implements ContentEntityInterface { * The default revision of a node is the one loaded when no specific revision * has been specified. Only default revisions are saved to the node table. * - * @var boolean + * @var bool */ public $isDefaultRevision = TRUE; diff --git a/core/modules/openid/openid.module b/core/modules/openid/openid.module index ada493368c00f23b56f911fcea7068875a5d4d9f..8a5056220874917c107228dbe5434c57b8b64fd2 100644 --- a/core/modules/openid/openid.module +++ b/core/modules/openid/openid.module @@ -870,7 +870,9 @@ function openid_authentication_request($claimed_id, $identity, $return_to = '', * @param $response * Array of response values from the provider. * - * @return boolean + * @return bool + * Whether the response received is valid. + * * @see http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4 */ function openid_verify_assertion($service, $response) { diff --git a/core/modules/poll/lib/Drupal/poll/Tests/PollTestBase.php b/core/modules/poll/lib/Drupal/poll/Tests/PollTestBase.php index 94da1efb081871653827fe137c8f6d89b3382ad6..04720841503ea5a555eda989d2012939a7985678 100644 --- a/core/modules/poll/lib/Drupal/poll/Tests/PollTestBase.php +++ b/core/modules/poll/lib/Drupal/poll/Tests/PollTestBase.php @@ -28,7 +28,7 @@ * The title of the poll. * @param array $choices * A list of choice labels. - * @param boolean $preview + * @param bool $preview * (optional) Whether to test if the preview is working or not. Defaults to * TRUE. * diff --git a/core/modules/search/lib/Drupal/search/SearchQuery.php b/core/modules/search/lib/Drupal/search/SearchQuery.php index 689fe7c00061322a178e2ced35c067855db2366c..bd7984d2dd5f4cdfac7a7f8ca7dd13a756533e5a 100644 --- a/core/modules/search/lib/Drupal/search/SearchQuery.php +++ b/core/modules/search/lib/Drupal/search/SearchQuery.php @@ -63,7 +63,7 @@ class SearchQuery extends SelectExtender { /** * Indicates whether the first pass query requires complex conditions (LIKE). * - * @var boolean. + * @var bool */ protected $simple = TRUE; @@ -107,7 +107,7 @@ class SearchQuery extends SelectExtender { /** * Indicates whether the first pass query has been executed. * - * @var boolean + * @var bool */ protected $executedFirstPass = FALSE; @@ -138,7 +138,7 @@ class SearchQuery extends SelectExtender { * The maximum number of AND/OR combinations exceeded can be configured to * avoid Denial-of-Service attacks. Expressions beyond the limit are ignored. * - * @var boolean + * @var bool */ protected $expressionsIgnored = FALSE; diff --git a/core/modules/simpletest/lib/Drupal/simpletest/TestBase.php b/core/modules/simpletest/lib/Drupal/simpletest/TestBase.php index 93cdbf2f16088d41b0dd6e056040c6c45e067e46..a41003ef91a2b24cc1d433115d6134f96530f76b 100644 --- a/core/modules/simpletest/lib/Drupal/simpletest/TestBase.php +++ b/core/modules/simpletest/lib/Drupal/simpletest/TestBase.php @@ -96,7 +96,7 @@ /** * TRUE if verbose debugging is enabled. * - * @var boolean + * @var bool */ protected $verbose = FALSE; diff --git a/core/modules/system/lib/Drupal/system/Tests/KeyValueStore/StorageTestBase.php b/core/modules/system/lib/Drupal/system/Tests/KeyValueStore/StorageTestBase.php index 9bd2412f54d99988c8c5034e96f5d72c134bdcb0..e30c3a3910544e96a4960941da4cf71090e11b87 100644 --- a/core/modules/system/lib/Drupal/system/Tests/KeyValueStore/StorageTestBase.php +++ b/core/modules/system/lib/Drupal/system/Tests/KeyValueStore/StorageTestBase.php @@ -33,7 +33,7 @@ /** * Whether we are using an expirable key/value store. * - * @var boolean + * @var string */ protected $factory = 'keyvalue'; diff --git a/core/modules/system/lib/Drupal/system/Tests/System/UnicodeUnitTest.php b/core/modules/system/lib/Drupal/system/Tests/System/UnicodeUnitTest.php index 58bef1032904141109328eb49ac270fbbd5ea9c4..6f72efaf976751e8efa2b32ccb584e426591f1b0 100644 --- a/core/modules/system/lib/Drupal/system/Tests/System/UnicodeUnitTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/System/UnicodeUnitTest.php @@ -17,7 +17,7 @@ class UnicodeUnitTest extends UnitTestBase { /** * Whether to run the extended version of the tests (including non latin1 characters). * - * @var boolean + * @var bool */ protected $extendedMode = FALSE; diff --git a/core/modules/tracker/tracker.module b/core/modules/tracker/tracker.module index 92f570175816affc5d14afe79467a5158e587dd1..ebbacc2f893b93e4add5d3c546d96aebb76d85de 100644 --- a/core/modules/tracker/tracker.module +++ b/core/modules/tracker/tracker.module @@ -160,7 +160,7 @@ function tracker_cron() { * @param int $account * The account ID to check. * - * @return boolean + * @return bool * TRUE if a user is accessing tracking info for their own account and * has permission to access the content. * @@ -177,7 +177,7 @@ function _tracker_myrecent_access($account) { * @param int $account * The user account ID to track. * - * @return boolean + * @return bool * TRUE if a user has permission to access the account for $account and * has permission to access the content. * diff --git a/core/modules/translation_entity/lib/Drupal/translation_entity/EntityTranslationControllerInterface.php b/core/modules/translation_entity/lib/Drupal/translation_entity/EntityTranslationControllerInterface.php index ed08fc08c6ab2b0c0a22166b0547325979beaa61..752d0d7b363891b296da1508191e432f950dbeb2 100644 --- a/core/modules/translation_entity/lib/Drupal/translation_entity/EntityTranslationControllerInterface.php +++ b/core/modules/translation_entity/lib/Drupal/translation_entity/EntityTranslationControllerInterface.php @@ -139,7 +139,7 @@ public function getAccess(EntityInterface $entity, $op); * @param string $langcode * The language code identifying the translation to be accessed. * - * @return boolean + * @return bool * TRUE if the operation may be performed, FALSE otherwise. */ public function getTranslationAccess(EntityInterface $entity, $langcode); diff --git a/core/modules/translation_entity/lib/Drupal/translation_entity/Tests/EntityTranslationUITest.php b/core/modules/translation_entity/lib/Drupal/translation_entity/Tests/EntityTranslationUITest.php index eac0b7fa2c4ac0ee245b93224b4ed30ab936221b..07348b687762f0c6976e274ec63a9fd09f39812a 100644 --- a/core/modules/translation_entity/lib/Drupal/translation_entity/Tests/EntityTranslationUITest.php +++ b/core/modules/translation_entity/lib/Drupal/translation_entity/Tests/EntityTranslationUITest.php @@ -50,7 +50,7 @@ /** * Whether the behavior of the language selector should be tested. * - * @var boolean + * @var bool */ protected $testLanguageSelector = TRUE; diff --git a/core/modules/translation_entity/translation_entity.module b/core/modules/translation_entity/translation_entity.module index dac1001ec18335521ebc50d37ee7ce6f09fdcda3..8c0634fc7d00ae8eb66684db6973f7f29e06584e 100644 --- a/core/modules/translation_entity/translation_entity.module +++ b/core/modules/translation_entity/translation_entity.module @@ -319,10 +319,11 @@ function translation_entity_set_config($entity_type, $bundle, $setting, $value) * The type of the entity. * @param string $bundle * (optional) The bundle of the entity. If no bundle is provided, all the - * available bundles are checked. - * @param boolean $skip_handler + * available bundles are checked. Defaults to NULL. + * @param bool $skip_handler * (optional) Specifies whether the availablity of a field translation handler * should affect the returned value. By default the check is performed. + * Defaults to FALSE. * * @returns * TRUE if the specified bundle is translatable. If no bundle is provided diff --git a/core/modules/views/lib/Drupal/views/Plugin/views/HandlerBase.php b/core/modules/views/lib/Drupal/views/Plugin/views/HandlerBase.php index ef039c8f19c1ef5e1d148752c57368886b3726ae..89805e9c80b196db0717b5dfee7ef4c97dc9bcf2 100644 --- a/core/modules/views/lib/Drupal/views/Plugin/views/HandlerBase.php +++ b/core/modules/views/lib/Drupal/views/Plugin/views/HandlerBase.php @@ -462,7 +462,8 @@ public function showExposeForm(&$form, &$form_state) { /** * Check whether current user has access to this handler. * - * @return boolean + * @return bool + * TRUE if current user has access to this handler; otherwise, FALSE. */ public function access() { if (isset($this->definition['access callback']) && function_exists($this->definition['access callback'])) { -- 1.8.0.msysgit.0