Class: I2CE FileSearch Caching (Development)

From IHRIS Wiki
Revision as of 15:26, 10 March 2010 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE_FileSearch_Caching}} This article describes the class ''I2CE_FileSearch_Caching'' . *Extends the class: [[Class: I2CE_FileSearch (Development) | I2CE_…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_FileSearch_Caching (versions) .


This article describes the class I2CE_FileSearch_Caching .

I2CE_FileSearch_Caching @todo Better Documentation

Variables

$prefix

The rpefix to use fir the APC keys

$stale_time

A local copy of the data (if any) stored in the magic data at /I2CE/fileSearch/stale_time

Methods

__construct()

Constructor for the FileSearch class

  • Defined in i2ce/lib/I2CE_FileSearch_Caching.php on line 50
  • Signature: public function __construct($hidden,$current_working,$make_absolut)
  • Parameters:
    • boolean $hidden
      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
    • boolean $current_working
      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
    • boolean $make_absolut
      Defaults to false. Whether or not to make a relative path absolute when adding it.
      • Default Value: false

clearCache()

search()

Find a file (or directory) of a certain category

  • Defined in i2ce/lib/I2CE_FileSearch_Caching.php on line 85
  • Signature: public function search($category,$file_name,$find_all)
  • Parameters:
    • string $category
      the category of the file
    • string $file_name
      the file name of the file we wish to find
    • boolean $find_all
      Defatults to false
      • Default Value: false
  • Returns: mixed.
    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

Inherited Methods

absolut()

This public method is inherited from I2CE_FileSearch->absolut()

addPath()

This public method is inherited from I2CE_FileSearch->addPath()

changeRelativeToAbsolut()

This public method is inherited from I2CE_FileSearch->changeRelativeToAbsolut()

convertUnixToWin()

This public method is inherited from I2CE_FileSearch->convertUnixToWin()

findByGlob()

This public method is inherited from I2CE_FileSearch->findByGlob()

findByRegularExpression()

This public method is inherited from I2CE_FileSearch->findByRegularExpression()

findWinShortPathName()

This public method is inherited from I2CE_FileSearch->findWinShortPathName()

getCategories()

This public method is inherited from I2CE_FileSearch->getCategories()

getLastOrder()

This public method is inherited from I2CE_FileSearch->getLastOrder()

getLocaleOfLastSearch()

This public method is inherited from I2CE_FileSearch->getLocaleOfLastSearch()

getParts()

This public method is inherited from I2CE_FileSearch->getParts()

getRelativePath()

This public method is inherited from I2CE_FileSearch->getRelativePath()

getRootPath()

This public method is inherited from I2CE_FileSearch->getRootPath()

getSearchPath()

This public method is inherited from I2CE_FileSearch->getSearchPath()

isAbsolut()

This public method is inherited from I2CE_FileSearch->isAbsolut()

limitToSubdir()

This public method is inherited from I2CE_FileSearch->limitToSubdir()

realPath()

This public method is inherited from I2CE_FileSearch->realPath()

relativePath()

This public method is inherited from I2CE_FileSearch->relativePath()

removePath()

This public method is inherited from I2CE_FileSearch->removePath()

removePaths()

This public method is inherited from I2CE_FileSearch->removePaths()

reset()

This public method is inherited from I2CE_FileSearch->reset()

resolve()

This public method is inherited from I2CE_FileSearch->resolve()

resolveGlob()

This public method is inherited from I2CE_FileSearch->resolveGlob()

searchCurrentWorkingDirectory()

This public method is inherited from I2CE_FileSearch->searchCurrentWorkingDirectory()

searchHiddenSubdirectories()

This public method is inherited from I2CE_FileSearch->searchHiddenSubdirectories()

searchPaths()

This public method is inherited from I2CE_FileSearch->searchPaths()

searchPathsByGlob()

This public method is inherited from I2CE_FileSearch->searchPathsByGlob()

setPreferredLocales()

This public method is inherited from I2CE_FileSearch->setPreferredLocales()

setRelativePath()

This public method is inherited from I2CE_FileSearch->setRelativePath()

_resolve()

This protected method is inherited from I2CE_FileSearch->_resolve()

_resolveGlob()

This protected method is inherited from I2CE_FileSearch->_resolveGlob()

findWinShortFileName()

This protected method is inherited from I2CE_FileSearch->findWinShortFileName()

resetFoundLocales()

This protected method is inherited from I2CE_FileSearch->resetFoundLocales()

Inherited Variables

$relative_path

Theis protected variable is inherited from I2CE_FileSearch->$relative_path

$relative_root

Theis protected variable is inherited from I2CE_FileSearch->$relative_root

$relative_parts

Theis protected variable is inherited from I2CE_FileSearch->$relative_parts

$found_locales

Theis protected variable is inherited from I2CE_FileSearch->$found_locales

$preferred_locales

Theis protected variable is inherited from I2CE_FileSearch->$preferred_locales

$ordered_paths

Theis protected variable is inherited from I2CE_FileSearch->$ordered_paths

$absolut

Theis protected variable is inherited from I2CE_FileSearch->$absolut

$search_hidden

Theis protected variable is inherited from I2CE_FileSearch->$search_hidden

$search_cwd

Theis protected variable is inherited from I2CE_FileSearch->$search_cwd

$last_order

Theis protected variable is inherited from I2CE_FileSearch->$last_order

$checked_directories

Theis protected variable is inherited from I2CE_FileSearch->$checked_directories

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FileSearch_Caching_(Development)&oldid=14043"