Function Module_filedump->_folder_search
Definitions
cms/pages/modules/filedump.php
- Find what 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 |
|---|---|---|---|---|---|---|---|
| $subpath | PATH | No | No | required parameter | N/A | N/A | Folder path |
| $description | string | No | No | required parameter | N/A | N/A | Folder 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 |
| $recursive | boolean | No | No | True | N/A | N/A | Whether to search recursively |
Returns
- Whether it passes the filter
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find what matches the search filter. If there is no filter, anything will match.
*
* @param PATH $subpath Folder path
* @param string $description Folder description
* @param string $search Search filter
* @param string $type_filter Type filter
* @set images videos audios others
* @param boolean $recursive Whether to search recursively
* @return boolean Whether it passes the filter
*/
public function _folder_search(string $subpath, string $description, string $search, string $type_filter, bool $recursive = true) : bool
* Find what matches the search filter. If there is no filter, anything will match.
*
* @param PATH $subpath Folder path
* @param string $description Folder description
* @param string $search Search filter
* @param string $type_filter Type filter
* @set images videos audios others
* @param boolean $recursive Whether to search recursively
* @return boolean Whether it passes the filter
*/
public function _folder_search(string $subpath, string $description, string $search, string $type_filter, bool $recursive = true) : bool
