Function Module_filedump->_matches_filter

Definitions

cms/pages/modules/filedump.php

  • Find whether a file matches the search filter. If there is no filter, anything will match.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filename ID_TEXT No No required parameter N/A N/A Filename
$_description string No No required parameter N/A N/A File description
$search string No No required parameter N/A N/A Search filter
$type_filter string No No required parameter images videos audios others N/A Type filter

Returns

  • Whether it passes the filter
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether a file matches the search filter. If there is no filter, anything will match.
 *
 * @param  ID_TEXT $filename Filename
 * @param  string $_description File description
 * @param  string $search Search filter
 * @param  string $type_filter Type filter
 * @set images videos audios others
 * @return boolean Whether it passes the filter
 */
public function _matches_filter(string $filename, string $_description, string $search, string $type_filter) : bool