|
|
| (22 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_FileSearch_Caching''.
| | #REDIRECT [[Class: I2CE_FileSearch_Caching (4.1.12)]] |
| *Extends the class: [[Class: I2CE_FileSearch | I2CE_FileSearch]].
| |
| *Location: Part of the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_FileSearch_Caching.php lib/I2CE_FileSearch_Caching.php]
| |
| I2CE_FileSearch_Caching @todo Better Documentation | |
| ==Variables==
| |
| ===$prefix===
| |
| The rpefix to use fir the APC keys
| |
| *Type: protected $prefix
| |
| | |
| ===$stale_time===
| |
| A local copy of the data (if any) stored in the magic data at /I2CE/fileSearch/stale_time
| |
| *Type: protected nt $stale_time
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Constructor for the FileSearch class
| |
| *Signature: public function __construct($hidden,$current_working,$make_absolut)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $hidden <br/>Defaults to false. Whether or not to search hidden sub-directories. At the moment it does not have meaning on non unix like platforms.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $current_working <br/>Defaults to false. Whether or not to search the current working directory for the file. If so, it checks there first, before the other paths.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $make_absolut <br/>Defaults to false. Whether or not to make a relative path absolute when adding it.
| |
| ***Default Value: false
| |
| ===clearCache()===
| |
| *Signature: public function clearCache()
| |
| ===search()===
| |
| Find a file (or directory) of a certain category
| |
| *Signature: public function search($category,$file_name,$find_all)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $category <br/>the category of the file
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $file_name <br/>the file name of the file we wish to find
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $find_all <br/>Defatults to false
| |
| ***Default Value: false
| |
| *Returns: mixed.<br/>Returns either a string which is the path and file name of the file we found, or null if we did not find the file.
| |
| ===setPrefix()===
| |
| Set the prefix to be used for the caching file search
| |
| *Signature: public function setPrefix($prefix)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $prefix
| |
| ==Inherited Variables==
| |
| ===$found_locales===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$found_locales | I2CE_FileSearch->$found_locales]]
| |
| | |
| ===$preferred_locales===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$preferred_locales | I2CE_FileSearch->$preferred_locales]]
| |
| | |
| ===$ordered_paths===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$ordered_paths | I2CE_FileSearch->$ordered_paths]]
| |
| | |
| ===$absolut===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$absolut | I2CE_FileSearch->$absolut]]
| |
| | |
| ===$search_hidden===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$search_hidden | I2CE_FileSearch->$search_hidden]]
| |
| | |
| ===$search_cwd===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$search_cwd | I2CE_FileSearch->$search_cwd]]
| |
| | |
| ===$last_order===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$last_order | I2CE_FileSearch->$last_order]]
| |
| | |
| ===$checked_directories===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$checked_directories | I2CE_FileSearch->$checked_directories]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
