Class modStaticResource

Description

A derivative of modResource that stores content on the filesystem.

Located in /model/modx/modstaticresource.class.php (line 9)

xPDOObject
   |
   --modAccessibleObject
      |
      --modAccessibleSimpleObject
         |
         --modResource
            |
            --modStaticResource
Variable Summary
Method Summary
 modStaticResource __construct ( &$xpdo)
 void getContent ([ $options = array()])
 string getFileContent (string $file, [ $options = array()])
 string getSourceFile ([ $options = array()])
 integer getSourceFileSize ([ $options = array()])
 integer _bytes (string $value)
Variables
Methods
Constructor __construct (line 25)
modStaticResource __construct ( &$xpdo)
  • &$xpdo

Redefinition of:
modResource::__construct()
getContent (line 81)

Treats the local content as a filename to load the raw content from.

  • access: public
void getContent ([ $options = array()])
  • array $options

Redefinition of:
modResource::getContent()
Gets the raw, unprocessed source content for a resource.
getFileContent (line 108)

Retrieve the resource content stored in a physical file.

  • return: The content of the file, of false if it could not be retrieved.
  • access: public
string getFileContent (string $file, [ $options = array()])
  • string $file: A path to the file representing the resource content.
  • array $options
getSourceFile (line 36)

Get the absolute path to the static source file represented by this instance.

  • return: The absolute path to the static source file.
  • access: public
string getSourceFile ([ $options = array()])
  • array $options: An array of options.
getSourceFileSize (line 66)

Get the filesize of the static source file represented by this instance.

  • return: The filesize of the source file in bytes.
  • access: public
integer getSourceFileSize ([ $options = array()])
  • array $options: An array of options.
_bytes (line 188)

Converts to bytes from PHP ini_get() format.

PHP ini modifiers for byte values:

  • G = gigabytes
  • M = megabytes
  • K = kilobytes

  • return: The value converted to bytes.
  • access: protected
integer _bytes (string $value)
  • string $value: Number of bytes represented in PHP ini value format.

Inherited Methods

Inherited From modResource

 modResource::__construct()
 modResource::addLock()
 modResource::addOne()
 modResource::cleanAlias()
 modResource::duplicate()
 modResource::findPolicy()
 modResource::getAliasPath()
 modResource::getCacheKey()
 modResource::getContent()
 modResource::getLock()
 modResource::getMany()
 modResource::getProcessed()
 modResource::getTVValue()
 modResource::hasChildren()
 modResource::isDuplicateAlias()
 modResource::joinGroup()
 modResource::mergeKeywords()
 modResource::mergeMetaTags()
 modResource::process()
 modResource::removeLock()
 modResource::save()
 modResource::set()
 modResource::setContent()

Inherited From modAccessibleObject

 modAccessibleObject::checkPolicy()
 modAccessibleObject::findPolicy()
 modAccessibleObject::getPolicies()
 modAccessibleObject::load()
 modAccessibleObject::loadCollection()
 modAccessibleObject::remove()
 modAccessibleObject::save()
 modAccessibleObject::setPolicies()
 modAccessibleObject::_loadCollectionInstance()
 modAccessibleObject::_loadInstance()

Inherited From xPDOObject

 xPDOObject::__construct()
 xPDOObject::addMany()
 xPDOObject::addOne()
 xPDOObject::addValidationRule()
 xPDOObject::encode()
 xPDOObject::fromArray()
 xPDOObject::fromJSON()
 xPDOObject::get()
 xPDOObject::getFieldName()
 xPDOObject::getFKClass()
 xPDOObject::getFKDefinition()
 xPDOObject::getMany()
 xPDOObject::getOne()
 xPDOObject::getOption()
 xPDOObject::getPK()
 xPDOObject::getPKType()
 xPDOObject::getPrimaryKey()
 xPDOObject::getSelectColumns()
 xPDOObject::getValidator()
 xPDOObject::isDirty()
 xPDOObject::isLazy()
 xPDOObject::isNew()
 xPDOObject::isValidated()
 xPDOObject::load()
 xPDOObject::loadCollection()
 xPDOObject::loadCollectionGraph()
 xPDOObject::remove()
 xPDOObject::removeValidationRules()
 xPDOObject::save()
 xPDOObject::set()
 xPDOObject::setDirty()
 xPDOObject::setOption()
 xPDOObject::toArray()
 xPDOObject::toJSON()
 xPDOObject::validate()
 xPDOObject::_getAliases()
 xPDOObject::_getDataType()
 xPDOObject::_getPHPType()
 xPDOObject::_getRelatedObjectsByFK()
 xPDOObject::_initFields()
 xPDOObject::_loadCollectionInstance()
 xPDOObject::_loadFieldData()
 xPDOObject::_loadInstance()
 xPDOObject::_loadRows()
 xPDOObject::_loadValidation()
 xPDOObject::_saveRelatedObject()
 xPDOObject::_saveRelatedObjects()
 xPDOObject::_setRaw()

Documentation generated on Fri, 17 Jun 2011 10:03:49 -0600 by phpDocumentor 1.4.3