diff -u b/core/modules/update/tests/update_test.module b/core/modules/update/tests/update_test.module --- b/core/modules/update/tests/update_test.module +++ b/core/modules/update/tests/update_test.module @@ -2,7 +2,7 @@ /** * @file - * The module file of the module used to test Update manager functionality. + * Module for testing Update Manager functionality. */ /** @@ -84,7 +84,7 @@ } /** - * Page callback: Prints mock XML for the Update manager module. + * Page callback: Prints mock XML for the Update Manager module. * * The specific XML file to print depends on two things: the project we're * trying to fetch data for, and the desired "availability scenario" for that @@ -93,9 +93,9 @@ * the 'update_test_xml_map' variable as an array, keyed by project name, * indicating which availability scenario to use for that project. * - * @param string $project_name - * The project short name update.module is trying to fetch data for (the fetch - * URLs are of the form: [base_url]/[project_name]/[core_version]). + * @param $project_name + * The project short name the update manager is trying to fetch data for (the + * fetch URLs are of the form: [base_url]/[project_name]/[core_version]). * * @see update_test_menu() */ diff -u b/core/modules/update/update.api.php b/core/modules/update/update.api.php --- b/core/modules/update/update.api.php +++ b/core/modules/update/update.api.php @@ -14,14 +14,14 @@ * Alter the list of projects before fetching data and comparing versions. * * Most modules will never need to implement this hook. It is for advanced - * interaction with the Update manager module: mere mortals need not apply. The - * primary use-case for this hook is to add projects to the list, for example, - * to provide update status data on disabled modules and themes. A contributed - * module might want to hide projects from the list, for example, if there is a - * site-specific module that doesn't have any official releases, that module - * could remove itself from this list to avoid "No available releases found" - * warnings on the available updates report. In rare cases, a module might want - * to alter the data associated with a project already in the list. + * interaction with the Update Manager module. The primary use-case for this + * hook is to add projects to the list; for example, to provide update status + * data on disabled modules and themes. A contributed module might want to hide + * projects from the list; for example, if there is a site-specific module that + * doesn't have any official releases, that module could remove itself from this + * list to avoid "No available releases found" warnings on the available updates + * report. In rare cases, a module might want to alter the data associated with + * a project already in the list. * * @param $projects * Reference to an array of the projects installed on the system. This diff -u b/core/modules/update/update.authorize.inc b/core/modules/update/update.authorize.inc --- b/core/modules/update/update.authorize.inc +++ b/core/modules/update/update.authorize.inc @@ -6,15 +6,15 @@ * * We use the Batch API to actually update each individual project on the site. * All of the code in this file is run at a low bootstrap level (modules are not - * loaded), so these functions cannot assume access to the rest of the - * update.module code. + * loaded), so these functions cannot assume access to the rest of the code of + * the Update Manager module. */ use Drupal\Core\Updater\UpdaterException; /** * Updates existing projects when invoked by authorize.php. - * + * * Callback for system_authorized_init() in * update_manager_update_ready_form_submit(). * @@ -303,9 +303,9 @@ /** * Creates a structure of log messages. * - * @param $project_results + * @param array $project_results * An associative array of results from the batch operation. - * @param $message + * @param string $message * A string containing a log message. * @param bool $success * TRUE if the operation the message is about was a success, FALSE if there @@ -318,10 +318,10 @@ /** * Clears cached available update status data. * - * Since this function is run at such a low bootstrap level, update.module is - * not loaded. So, we can't just call _update_cache_clear(). However, the - * database is bootstrapped, so we can do a query ourselves to clear out what we - * want to clear. + * Since this function is run at such a low bootstrap level, the Update Manager + * module is not loaded. So, we can't just call _update_cache_clear(). However, + * the database is bootstrapped, so we can do a query ourselves to clear out + * what we want to clear. * * Note that we do not want to just truncate the table, since that would remove * items related to currently pending fetch attempts. diff -u b/core/modules/update/update.compare.inc b/core/modules/update/update.compare.inc --- b/core/modules/update/update.compare.inc +++ b/core/modules/update/update.compare.inc @@ -739,7 +739,7 @@ * 'update_available_releases' cache ID -- it needs to persist longer than 1 * hour and never get invalidated just by visiting a page on the site. * - * @param string $cid + * @param $cid * The cache ID of data to return from the cache. Valid options are * 'update_project_data' and 'update_project_projects'. * @@ -784,7 +784,7 @@ * Array of .info file data as returned by drupal_parse_info_file(). * * @return - * Array of .info file data we need for the Update manager. + * Array of .info file data we need for the update manager. * * @see _update_process_info_list() */ diff -u b/core/modules/update/update.fetch.inc b/core/modules/update/update.fetch.inc --- b/core/modules/update/update.fetch.inc +++ b/core/modules/update/update.fetch.inc @@ -79,7 +79,7 @@ /** * Batch callback: Performs actions when all fetch tasks have been completed. * - * @param bool $success + * @param $success * TRUE if the batch operation was successful, FALSE if there were errors. * @param $results * An associative array of results from the batch operation, including the key @@ -264,7 +264,7 @@ * * @param $project * The array of project information from update_get_projects(). - * @param string $site_key + * @param $site_key * (optional) The anonymous site key hash. Defaults to an empty string. * * @return string @@ -299,7 +299,7 @@ * @param $project * The array of project information from update_get_projects(). * - * @return string + * @return * The base of the URL used for fetching available update data. This does * not include the path elements to specify a particular project, version, * site_key, etc. diff -u b/core/modules/update/update.install b/core/modules/update/update.install --- b/core/modules/update/update.install +++ b/core/modules/update/update.install @@ -2,7 +2,7 @@ /** * @file - * Install, update and uninstall functions for the Update manager module. + * Install, update and uninstall functions for the Update Manager module. */ /** diff -u b/core/modules/update/update.manager.inc b/core/modules/update/update.manager.inc --- b/core/modules/update/update.manager.inc +++ b/core/modules/update/update.manager.inc @@ -2,7 +2,7 @@ /** * @file - * Administrative screens and processing functions for the Update manager. + * Administrative screens and processing functions for the update manager. * * This allows site administrators with the 'administer software updates' * permission to either upgrade existing projects, or download and install new @@ -47,7 +47,7 @@ */ /** - * Form constructor for the Update manager update form. + * Form constructor for the update manager update form. * * This presents a table with all projects that have available updates with * checkboxes to select which ones to upgrade. @@ -305,7 +305,7 @@ /** * Form submission handler for update_manager_update_form(). * - * Sets up a batch to download, extract and verify the selected releases. + * Sets up a batch that downloads, extracts, and verifies the selected releases. * * @see update_manager_update_form_validate() */ @@ -481,7 +481,7 @@ */ /** - * Form constructor for the Update manager install form. + * Form constructor for the update manager install form. * * This presents a place to enter a URL or upload an archive file to use to * install a new module or theme. @@ -544,11 +544,11 @@ * @param array $form * Reference to the form array we're building. * @param string $operation - * The Update manager operation we're in the middle of. Can be either 'update' + * The update manager operation we're in the middle of. Can be either 'update' * or 'install'. Use to provide operation-specific interface text. * * @return - * TRUE if the Update manager should continue to the next step in the + * TRUE if the update manager should continue to the next step in the * workflow, or FALSE if we've hit a fatal configuration and must halt the * workflow. */ @@ -903,7 +903,7 @@ * * If the server is configured such that webserver-created files have the same * owner as the configuration directory (e.g., sites/default) where new code - * will eventually be installed, the Update manager can transfer files entirely + * will eventually be installed, the update manager can transfer files entirely * locally, without changing their ownership (in other words, without prompting * the user for FTP, SSH or other credentials). * diff -u b/core/modules/update/update.module b/core/modules/update/update.module --- b/core/modules/update/update.module +++ b/core/modules/update/update.module @@ -2,7 +2,7 @@ /** * @file - * The Update manager module handles updates of Drupal and contributed projects. + * Handles updates of Drupal core and contributed projects. * * The module checks for available updates of Drupal core and any installed * contributed modules and themes. It warns site administrators if newer @@ -252,7 +252,7 @@ * Access callback: Determines if current user can access updater menu items. * * It both enforces the 'administer software updates' permission and the global - * killswitch for the authorize.php script. + * kill switch for the authorize.php script. * * @return * TRUE if the current user can access the updater menu items; FALSE @@ -500,7 +500,7 @@ * * Constructs the e-mail notification message when the site is out of date. * - * @param string $key + * @param $key * Unique key to indicate what message to build, always 'status_notify'. * @param $message * Reference to the message array being built. @@ -539,7 +539,7 @@ * * These error messages are shared by both update_requirements() for the * site-wide status report at admin/reports/status and in the body of the - * notification e-mails generated by update_cron(). + * notification e-mail messages generated by update_cron(). * * @param $msg_type * String to indicate what kind of message to generate. Can be either 'core' @@ -552,7 +552,7 @@ * @param $language * (optional) A language object to use. Defaults to NULL. * - * @return string + * @return * The properly translated error message for the given key. */ function _update_message_text($msg_type, $msg_reason, $report_link = FALSE, $language = NULL) { @@ -621,9 +621,9 @@ } /** - * Callback for uasort() within update_requirements(). - * * Orders projects based on their status. + * + * Callback for uasort() within update_requirements(). */ function _update_project_status_sort($a, $b) { // The status constants are numerically in the right order, so we can @@ -663,7 +663,7 @@ * Implements hook_verify_update_archive(). * * First, we ensure that the archive isn't a copy of Drupal core, which the - * Update manager does not yet support. See http://drupal.org/node/606592 + * update manager does not yet support. See http://drupal.org/node/606592 * * Then, we make sure that at least one module included in the archive file has * an .info file which claims that the code is compatible with the current @@ -739,7 +739,7 @@ * minimum and a maximum) defined, or if a site uses memcache or another * pluggable cache system that assumes volatile caches. * - * Update manager module still uses the {cache_update} table, but instead of + * The Update Manager module still uses the {cache_update} table, but instead of * using the cache API, there are private helper functions that implement these * same basic tasks but ensure that the cache is not prematurely cleared, and * that the data is always stored in the database, even if memcache or another @@ -749,9 +749,9 @@ /** * Stores data in the private update status cache table. * - * @param string $cid + * @param $cid * The cache ID to save the data with. - * @param array $data + * @param $data * The data to store. * @param $expire * One of the following values: @@ -784,7 +784,7 @@ /** * Retrieves data from the private update status cache table. * - * @param string $cid + * @param $cid * The cache ID to retrieve. * * @return @@ -835,7 +835,7 @@ * (optional) Cache ID of the record to clear from the private update module * cache. If empty, all records will be cleared from the table. Defaults to * NULL. - * @param bool $wildcard + * @param $wildcard * (optional) If TRUE, cache IDs starting with $cid are deleted in addition to * the exact cache ID specified by $cid. Defaults to FALSE. */ @@ -899,11 +899,11 @@ /** * Returns the directory where update archive files should be extracted. * - * @param bool $create + * @param $create * (optional) If TRUE, attempt to create the directory if it does not already * exist. Defaults to TRUE. * - * @return string + * @return * The full path to the temporary directory where update file archives should * be extracted. */ @@ -921,11 +921,11 @@ /** * Returns the directory where update archive files should be cached. * - * @param bool $create + * @param $create * (optional) If TRUE, attempt to create the directory if it does not already * exist. Defaults to TRUE. * - * @return string + * @return * The full path to the temporary directory where update file archives should * be cached. */ @@ -958,7 +958,7 @@ } /** - * Deletes stale files and directories from the Update manager disk cache. + * Deletes stale files and directories from the update manager disk cache. * * Files and directories older than 6 hours and development snapshots older than * 5 minutes are considered stale. We only cache development snapshots for 5 diff -u b/core/modules/update/update.report.inc b/core/modules/update/update.report.inc --- b/core/modules/update/update.report.inc +++ b/core/modules/update/update.report.inc @@ -287,11 +287,11 @@ * @param array $variables * An associative array containing: * - version: An array of data about the latest released version, containing: - * - version: A string containing the version number. - * - release_link: A string containing the URL for the release notes. - * - date: A string containing the date of the release. - * - download_link: A string containing the URL for the downloadable file. - * - tag: A string containing the title of the project. + * - version: The version number. + * - release_link: The URL for the release notes. + * - date: The date of the release. + * - download_link: The URL for the downloadable file. + * - tag: The title of the project. * - class: A string containing extra classes for the wrapping table. * * @ingroup themeable diff -u b/core/modules/update/update.test b/core/modules/update/update.test --- b/core/modules/update/update.test +++ b/core/modules/update/update.test @@ -2,9 +2,9 @@ /** * @file - * Tests for the Update manager module. + * Tests for the Update Manager module. * - * This file contains tests for the Update manager module. The overarching + * This file contains tests for the Update Manager module. The overarching * methodology of these tests is we need to compare a given state of installed * modules and themes (e.g., version, project grouping, timestamps, etc) against * a current state of what the release history XML files we fetch say is @@ -61,9 +61,6 @@ */ class UpdateCoreTestCase extends UpdateTestHelper { - /** - * Returns general information about the tests in this class. - */ public static function getInfo() { return array( 'name' => 'Update core functionality', @@ -72,9 +69,6 @@ ); } - /** - * Sets up the environment necessary for the tests in this class. - */ function setUp() { parent::setUp('update_test', 'update'); $admin_user = $this->drupalCreateUser(array('administer site configuration', 'administer modules')); @@ -257,9 +251,6 @@ */ class UpdateTestContribCase extends UpdateTestHelper { - /** - * Returns general information about the tests in this class. - */ public static function getInfo() { return array( 'name' => 'Update contrib functionality', @@ -268,9 +259,6 @@ ); } - /** - * Sets up the environment necessary for the tests in this class. - */ function setUp() { parent::setUp('update_test', 'update', 'aaa_update_test', 'bbb_update_test', 'ccc_update_test'); $admin_user = $this->drupalCreateUser(array('administer site configuration')); @@ -630,9 +618,6 @@ */ class UpdateTestUploadCase extends UpdateTestHelper { - /** - * Returns general information about the tests in this class. - */ public static function getInfo() { return array( 'name' => 'Upload and extract module functionality', @@ -641,9 +626,6 @@ ); } - /** - * Sets up the environment necessary for the tests in this class. - */ public function setUp() { parent::setUp('update', 'update_test'); variable_set('allow_authorize_operations', TRUE); @@ -691,7 +673,7 @@ } /** - * Checks the messages on Update manager pages when missing a security update. + * Checks the messages on update manager pages when missing a security update. */ function testUpdateManagerCoreSecurityUpdateMessages() { $setting = array( @@ -737,9 +719,6 @@ */ class UpdateCoreUnitTestCase extends DrupalUnitTestCase { - /** - * Returns general information about the tests in this class. - */ public static function getInfo() { return array( 'name' => "Unit tests", @@ -748,9 +727,6 @@ ); } - /** - * Sets up the environment necessary for the tests in this class. - */ function setUp() { parent::setUp('update'); module_load_include('inc', 'update', 'update.fetch');