Function Module_cms_comcode_pages->get_comcode_files_list_disk_search

Definitions

cms/pages/modules/cms_comcode_pages.php

  • Find all pages using a disk search.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$lang LANGUAGE_NAME No No required parameter N/A N/A The language we are searching for pages of
$zone_filter ?array No No required parameter N/A N/A List of zones to limit to (null: no filter)
$check_permissions boolean No No True N/A N/A Whether to check edit permissions

Returns

  • The map (page-link => map [path & row])
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find all pages using a disk search.
 *
 * @param  LANGUAGE_NAME $lang The language we are searching for pages of
 * @param  ?array $zone_filter List of zones to limit to (null: no filter)
 * @param  boolean $check_permissions Whether to check edit permissions
 * @return array The map (page-link => map [path & row])
 */
public function get_comcode_files_list_disk_search(string $lang, ?array $zone_filter, bool $check_permissions = true) : array