Function Hook_health_check_upkeep_backups->run
Definitions
sources/hooks/systems/health_checks/upkeep_backups.php
- Standard hook run function to run this category of health checks.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $sections_to_run | ?array | No | No | required parameter | N/A | N/A | Which check sections to run (null: all) |
| $check_context | integer | No | No | required parameter | N/A | N/A | The current state of the website (a CHECK_CONTEXT__* constant) |
| $manual_checks | boolean | No | No | False | N/A | N/A | Mention manual checks |
| $automatic_repair | boolean | No | No | False | N/A | N/A | Do automatic repairs where possible |
| $use_test_data_for_pass | ?boolean | No | No | Null | N/A | N/A | Should test data be for a pass [if test data supported] (null: no test data) |
| $urls_or_page_links | ?array | No | No | Null | N/A | N/A | List of URLs and/or page-links to operate on, if applicable (null: those configured) |
| $comcode_segments | ?array | No | No | Null | N/A | N/A | Map of field names to Comcode segments to operate on, if applicable (null: N/A) |
| $show_unusable_categories | boolean | No | No | False | N/A | N/A | Whether to include categories that might not be accessible for some reason |
Returns
- A pair: category label, list of results
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Standard hook run function to run this category of health checks.
*
* @param ?array $sections_to_run Which check sections to run (null: all)
* @param integer $check_context The current state of the website (a CHECK_CONTEXT__* constant)
* @param boolean $manual_checks Mention manual checks
* @param boolean $automatic_repair Do automatic repairs where possible
* @param ?boolean $use_test_data_for_pass Should test data be for a pass [if test data supported] (null: no test data)
* @param ?array $urls_or_page_links List of URLs and/or page-links to operate on, if applicable (null: those configured)
* @param ?array $comcode_segments Map of field names to Comcode segments to operate on, if applicable (null: N/A)
* @param boolean $show_unusable_categories Whether to include categories that might not be accessible for some reason
* @return array A pair: category label, list of results
*/
public function run(?array $sections_to_run, int $check_context, bool $manual_checks = false, bool $automatic_repair = false, ?bool $use_test_data_for_pass = null, ?array $urls_or_page_links = null, ?array $comcode_segments = null, bool $show_unusable_categories = false) : array
* Standard hook run function to run this category of health checks.
*
* @param ?array $sections_to_run Which check sections to run (null: all)
* @param integer $check_context The current state of the website (a CHECK_CONTEXT__* constant)
* @param boolean $manual_checks Mention manual checks
* @param boolean $automatic_repair Do automatic repairs where possible
* @param ?boolean $use_test_data_for_pass Should test data be for a pass [if test data supported] (null: no test data)
* @param ?array $urls_or_page_links List of URLs and/or page-links to operate on, if applicable (null: those configured)
* @param ?array $comcode_segments Map of field names to Comcode segments to operate on, if applicable (null: N/A)
* @param boolean $show_unusable_categories Whether to include categories that might not be accessible for some reason
* @return array A pair: category label, list of results
*/
public function run(?array $sections_to_run, int $check_context, bool $manual_checks = false, bool $automatic_repair = false, ?bool $use_test_data_for_pass = null, ?array $urls_or_page_links = null, ?array $comcode_segments = null, bool $show_unusable_categories = false) : array
