Class: I2CE FileSearch Caching

This article desrcibes the class I2CE_FileSearch_Caching.

• Extends the class: I2CE_FileSearch.
• Location: Part of the module I2CE in the package I2CE
• Source: Defined in the file 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 int $stale_time

Methods

__construct()

Constructor for the FileSearch class

• 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()

• Signature: public function clearCache()

search()

Find a file (or directory) of a certain category

• 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

• Signature: public function setPrefix($prefix)
• Parameters:
  • string $prefix

Inherited Methods

__construct()

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

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()

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()

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()

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()

search()

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

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()

setPreferredLocales()

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

_resolve()

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

findWinShortFileName()

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

resetFoundLocales()

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

Inherited Variables

$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