Class Varien_Directory_Collection

Description

Implements interfaces:

Data collection

Located in /Directory/Collection.php (line 39)

Varien_Data_Collection
   |
   --Varien_Directory_Collection
Variable Summary
mixed $_dirName
mixed $_filters
mixed $_path
Method Summary
static string getLastDir (string $path)
none __construct (string $path, [ $isRecursion = true], [ $recursionLevel = 0], bool $is_recursion)
none addFilter ( $field,  $value)
none addItem (IFactory $item)
array dirsName ()
array filesName ()
array filesObj ()
array filesPaths ()
string getDirName ()
none getDirsName ( &$dirs, array $dirs)
none getFilesName ( &$files, array $files)
none getFilesObj ( &$objs, array $objs)
none getFilesPaths ( &$paths, array $files)
string getPath ()
bool getRecursion ()
string lastDir (string $path)
none parseDir ()
none setFilesFilter (array $filter)
none setPath (string $path, [bool $isRecursion = ''])
none setRecursion (bool $isRecursion)
none setRecursionLevel (int $recursionLevel)
none toArray (array &$arr)
none toXml (string &$xml, [ $recursionLevel = 0], [bool $addOpenTag = true], [string $rootName = 'Struct'])
none useFilter (bool $useFilter)
none _renderFilters ()
array __toArray ()
none __toXml ([bool $addOpenTag = true], [string $rootName = 'Struct'])
Variables
mixed $_dirName = '' (line 41)
  • access: protected
mixed $_filters = array() (line 44)
  • access: protected

Redefinition of:
Varien_Data_Collection::$_filters
Filters configuration
mixed $_isRecursion (line 43)
  • access: protected
mixed $_path = '' (line 40)
  • access: protected
mixed $_recursionLevel (line 42)
  • access: protected

Inherited Variables

Inherited from Varien_Data_Collection

Varien_Data_Collection::$_cacheKey
Varien_Data_Collection::$_cacheLifetime
Varien_Data_Collection::$_cacheTags
Varien_Data_Collection::$_curPage
Varien_Data_Collection::$_flags
Varien_Data_Collection::$_isCollectionLoaded
Varien_Data_Collection::$_isFiltersRendered
Varien_Data_Collection::$_itemObjectClass
Varien_Data_Collection::$_items
Varien_Data_Collection::$_orders
Varien_Data_Collection::$_pageSize
Varien_Data_Collection::$_totalRecords
Methods
static method getLastDir (line 155)

get latest dir in the path

  • return: - latest dir in the path
  • access: public
static string getLastDir (string $path)
  • string $path: - path to directory
Constructor __construct (line 52)

Constructor

  • access: public
none __construct (string $path, [ $isRecursion = true], [ $recursionLevel = 0], bool $is_recursion)
  • string $path: - path to directory
  • bool $is_recursion: - use or not recursion
  • $isRecursion
  • $recursionLevel

Redefinition of:
Varien_Data_Collection::__construct()
addFilter (line 418)

add filter

  • access: public
none addFilter ( $field,  $value)
  • $field
  • $value

Redefinition of:
Varien_Data_Collection::addFilter()
Add collection filter
addItem (line 166)

add item to collection

  • access: public
none addItem (IFactory $item)

Redefinition of:
Varien_Data_Collection::addItem()
Adding item to item array
dirsName (line 267)

get names of dirs of current collection

  • return: - array of names of dirs
  • access: public
array dirsName ()
filesName (line 203)

get files names of current collection

  • return: - files names of current collection
  • access: public
array filesName ()
filesObj (line 246)

get SplFileObject objects of files of current collection

  • return: - array of SplFileObject objects
  • access: public
array filesObj ()
filesPaths (line 225)

get files paths of current collection

  • return: - files paths of current collection
  • access: public
array filesPaths ()
getDirName (line 68)

Get name of this directory

  • return: - name of this directory
  • access: public
string getDirName ()
getDirsName (line 279)

get names of dirs of current collection

  • access: public
none getDirsName ( &$dirs, array $dirs)
  • array $dirs: - array of names of dirs
  • &$dirs

Implementation of:
IFactory::getDirsName()
getFilesName (line 216)

get files names of current collection

  • access: public
none getFilesName ( &$files, array $files)
  • array $files: - array of files names
  • &$files

Implementation of:
IFactory::getFilesName()
getFilesObj (line 258)

get SplFileObject objects of files of current collection

  • access: public
none getFilesObj ( &$objs, array $objs)
  • array $objs: - array of SplFileObject objects
  • &$objs

Implementation of:
IFactory::getFilesObj()
getFilesPaths (line 237)

get files paths of current collection

  • access: public
none getFilesPaths ( &$paths, array $files)
  • array $files: - array of files paths
  • &$paths

Implementation of:
IFactory::getFilesPaths()
getPath (line 95)

Get path

  • return: - path to this directory
  • access: public
string getPath ()
getRecursion (line 77)

Get recursion

  • return: - is or not recursion
  • access: public
bool getRecursion ()
getRecursionLevel (line 86)

Get recursion level

  • return: - recursion level
  • access: public
int getRecursionLevel ()
lastDir (line 145)

get latest dir in the path

  • return: - latest dir in the path
  • access: public
string lastDir (string $path)
  • string $path: - path to directory
parseDir (line 175)

parse this directory

  • access: protected
none parseDir ()
setFilesFilter (line 291)

set filters for files

  • access: protected
none setFilesFilter (array $filter)
  • array $filter: - array of filters
setPath (line 105)

Set path to this directory

  • access: public
none setPath (string $path, [bool $isRecursion = ''])
  • string $path: - path to this directory
  • bool $isRecursion: - use or not recursion
setRecursion (line 125)

Set recursion

  • access: public
none setRecursion (bool $isRecursion)
  • bool $isRecursion: - use or not recursion
setRecursionLevel (line 135)

Set level of recursion

  • access: public
none setRecursionLevel (int $recursionLevel)
  • int $recursionLevel: - level of recursion
toArray (line 311)

display this collection as array

  • access: public
none toArray (array &$arr)
  • array &$arr: - this collection array

Redefinition of:
Varien_Data_Collection::toArray()
Convert collection to array

Implementation of:
IFactory::toArray()
toXml (line 339)

get this collection as xml

  • access: public
none toXml (string &$xml, [ $recursionLevel = 0], [bool $addOpenTag = true], [string $rootName = 'Struct'])
  • string &$xml: - xml
  • bool $addOpenTag: - add or not header of xml
  • string $rootName: - root element name
  • $recursionLevel

Redefinition of:
Varien_Data_Collection::toXml()
Convert collection to XML

Implementation of:
IFactory::toXml()
useFilter (line 193)

set filter using

  • access: public
none useFilter (bool $useFilter)
  • bool $useFilter: - filter using

Implementation of:
IFactory::useFilter()
_renderFilters (line 359)

apply filters

  • access: protected
none _renderFilters ()

Redefinition of:
Varien_Data_Collection::_renderFilters()
Render sql select conditions
__toArray (line 300)

display this collection as array

  • access: public
array __toArray ()
__toXml (line 326)

get this collection as xml

  • access: public
none __toXml ([bool $addOpenTag = true], [string $rootName = 'Struct'])
  • bool $addOpenTag: - add or not header of xml
  • string $rootName: - root element name

Inherited Methods

Inherited From Varien_Data_Collection

Varien_Data_Collection::__construct()
Varien_Data_Collection::addFilter()
Varien_Data_Collection::addItem()
Varien_Data_Collection::clear()
Varien_Data_Collection::count()
Varien_Data_Collection::distinct()
Varien_Data_Collection::each()
Varien_Data_Collection::getAllIds()
Varien_Data_Collection::getCacheKey()
Varien_Data_Collection::getCacheLifetime()
Varien_Data_Collection::getCacheTags()
Varien_Data_Collection::getColumnValues()
Varien_Data_Collection::getCurPage()
Varien_Data_Collection::getFilter()
Varien_Data_Collection::getFirstItem()
Varien_Data_Collection::getFlag()
Varien_Data_Collection::getItemByColumnValue()
Varien_Data_Collection::getItemById()
Varien_Data_Collection::getItems()
Varien_Data_Collection::getItemsByColumnValue()
Varien_Data_Collection::getIterator()
Varien_Data_Collection::getLastItem()
Varien_Data_Collection::getLastPageNumber()
Varien_Data_Collection::getNewEmptyItem()
Varien_Data_Collection::getPageSize()
Varien_Data_Collection::getSize()
Varien_Data_Collection::hasFlag()
Varien_Data_Collection::isLoaded()
Varien_Data_Collection::load()
Varien_Data_Collection::loadData()
Varien_Data_Collection::removeItemByKey()
Varien_Data_Collection::setCacheKey()
Varien_Data_Collection::setCacheTags()
Varien_Data_Collection::setCurPage()
Varien_Data_Collection::setDataToAll()
Varien_Data_Collection::setFlag()
Varien_Data_Collection::setItemObjectClass()
Varien_Data_Collection::setOrder()
Varien_Data_Collection::setPageSize()
Varien_Data_Collection::toArray()
Varien_Data_Collection::toOptionArray()
Varien_Data_Collection::toOptionHash()
Varien_Data_Collection::toXml()
Varien_Data_Collection::walk()
Varien_Data_Collection::_getItemId()
Varien_Data_Collection::_renderFilters()
Varien_Data_Collection::_renderLimit()
Varien_Data_Collection::_renderOrders()
Varien_Data_Collection::_setIsLoaded()
Varien_Data_Collection::_toOptionArray()
Varien_Data_Collection::_toOptionHash()
Class Constants

Documentation generated on Fri, 11 Feb 2011 16:53:15 +0200 by phpDocumentor 1.4.3