Function Module_admin->_section_match

Definitions

adminzone/pages/modules/admin.php

  • See if our current section is going to be searched.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$section_limitations array No No required parameter N/A N/A List of sections to search (empty: search all sections)
$results_type string No No required parameter N/A N/A Current section

Returns

  • Whether there is a match
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * See if our current section is going to be searched.
 *
 * @param  array $section_limitations List of sections to search (empty: search all sections)
 * @param  string $results_type Current section
 * @return boolean Whether there is a match
 */

public function _section_match(array $section_limitations, string $results_type) : bool