|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FileSearch_Caching''.
| | #REDIRECT [[Class: I2CE_FileSearch_Caching (4.0.3)]] |
| *Extends the class: [[Class: I2CE_FileSearch | I2CE_FileSearch]].
| |
| *Location: Part of the module [[I2CE 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.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L38 lib/I2CE_FileSearch_Caching.php] on line 38
| |
| I2CE_FileSearch_Caching @todo Better Documentation
| |
| ==Variables==
| |
| ===$prefix===
| |
| The rpefix to use fir the APC keys
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L69 i2ce/lib/I2CE_FileSearch_Caching.php] on line 69
| |
| *Type: protected $prefix
| |
| | |
| ===$stale_time===
| |
| A local copy of the data (if any) stored in the magic data at /I2CE/fileSearch/stale_time
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L76 i2ce/lib/I2CE_FileSearch_Caching.php] on line 76
| |
| *Type: protected [http://www.php.net/manual/en/language.types.integer.php int ] $stale_time
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Constructor for the FileSearch class
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L50 i2ce/lib/I2CE_FileSearch_Caching.php] on line 50
| |
| *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()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L129 i2ce/lib/I2CE_FileSearch_Caching.php] on line 129
| |
| *Signature: public function clearCache()
| |
| ===search()===
| |
| Find a file (or directory) of a certain category
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L85 i2ce/lib/I2CE_FileSearch_Caching.php] on line 85
| |
| *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
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_FileSearch_Caching.php#L61 i2ce/lib/I2CE_FileSearch_Caching.php] on line 61
| |
| *Signature: public function setPrefix($prefix)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $prefix
| |
| ==Inherited Methods==
| |
| ===absolut()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#absolut() | I2CE_FileSearch->absolut()]]
| |
| | |
| ===addPath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#addPath() | I2CE_FileSearch->addPath()]]
| |
| | |
| ===changeRelativeToAbsolut()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#changeRelativeToAbsolut() | I2CE_FileSearch->changeRelativeToAbsolut()]]
| |
| | |
| ===convertUnixToWin()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#convertUnixToWin() | I2CE_FileSearch->convertUnixToWin()]]
| |
| | |
| ===findByRegularExpression()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#findByRegularExpression() | I2CE_FileSearch->findByRegularExpression()]]
| |
| | |
| ===findWinShortPathName()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#findWinShortPathName() | I2CE_FileSearch->findWinShortPathName()]]
| |
| | |
| ===getCategories()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getCategories() | I2CE_FileSearch->getCategories()]]
| |
| | |
| ===getLastOrder()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getLastOrder() | I2CE_FileSearch->getLastOrder()]]
| |
| | |
| ===getLocaleOfLastSearch()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getLocaleOfLastSearch() | I2CE_FileSearch->getLocaleOfLastSearch()]]
| |
| | |
| ===getParts()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getParts() | I2CE_FileSearch->getParts()]]
| |
| | |
| ===getRelativePath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getRelativePath() | I2CE_FileSearch->getRelativePath()]]
| |
| | |
| ===getRootPath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getRootPath() | I2CE_FileSearch->getRootPath()]]
| |
| | |
| ===getSearchPath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#getSearchPath() | I2CE_FileSearch->getSearchPath()]]
| |
| | |
| ===isAbsolut()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#isAbsolut() | I2CE_FileSearch->isAbsolut()]]
| |
| | |
| ===limitToSubdir()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#limitToSubdir() | I2CE_FileSearch->limitToSubdir()]]
| |
| | |
| ===realPath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#realPath() | I2CE_FileSearch->realPath()]]
| |
| | |
| ===relativePath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#relativePath() | I2CE_FileSearch->relativePath()]]
| |
| | |
| ===removePath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#removePath() | I2CE_FileSearch->removePath()]]
| |
| | |
| ===removePaths()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#removePaths() | I2CE_FileSearch->removePaths()]]
| |
| | |
| ===reset()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#reset() | I2CE_FileSearch->reset()]]
| |
| | |
| ===resolve()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#resolve() | I2CE_FileSearch->resolve()]]
| |
| | |
| ===searchCurrentWorkingDirectory()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#searchCurrentWorkingDirectory() | I2CE_FileSearch->searchCurrentWorkingDirectory()]]
| |
| | |
| ===searchHiddenSubdirectories()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#searchHiddenSubdirectories() | I2CE_FileSearch->searchHiddenSubdirectories()]]
| |
| | |
| ===searchPaths()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#searchPaths() | I2CE_FileSearch->searchPaths()]]
| |
| | |
| ===setPreferredLocales()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#setPreferredLocales() | I2CE_FileSearch->setPreferredLocales()]]
| |
| | |
| ===setRelativePath()===
| |
| This public method is inherited from [[Class: I2CE_FileSearch#setRelativePath() | I2CE_FileSearch->setRelativePath()]]
| |
| | |
| ===_resolve()===
| |
| This protected method is inherited from [[Class: I2CE_FileSearch#_resolve() | I2CE_FileSearch->_resolve()]]
| |
| | |
| ===findWinShortFileName()===
| |
| This protected method is inherited from [[Class: I2CE_FileSearch#findWinShortFileName() | I2CE_FileSearch->findWinShortFileName()]]
| |
| | |
| ===resetFoundLocales()===
| |
| This protected method is inherited from [[Class: I2CE_FileSearch#resetFoundLocales() | I2CE_FileSearch->resetFoundLocales()]]
| |
| ==Inherited Variables==
| |
| ===$relative_path===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$relative_path | I2CE_FileSearch->$relative_path]]
| |
| | |
| ===$relative_root===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$relative_root | I2CE_FileSearch->$relative_root]]
| |
| | |
| ===$relative_parts===
| |
| Theis protected variable is inherited from [[Class: I2CE_FileSearch#$relative_parts | I2CE_FileSearch->$relative_parts]]
| |
| | |
| ===$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]]
| |
