Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

Utility Class Reference

Utility model class Execute utility operations. More...

Inheritance diagram for Utility:
AppModel

List of all members.

Public Member Functions

 call ($operation, $options=array())
 call a specific utility operation and eventually log errors

Public Attributes

 $useTable = false

Protected Member Functions

 updateStreamFields ($options)
 utility operation update stream fields according to Stream::updateStreamFields
 rebuildIndex ($options)
 utility operation rebuild index for search text according to SearchText::rebuildIndex()
 clearMediaCache ($options)
 utility operation clear media cache, remove image thumbs according to Stream::clearMediaCache()
 emptyLogs ($options)
 utility operation delete log files according to BeSystem::emptyLogs()
 cleanupCache ($options=array())
 utility operation cleanup cached files according to BeSystem::cleanupCache()

Protected Attributes

 $response = array('results' => null, 'message' => null, 'log' => null)

Detailed Description

Utility model class Execute utility operations.

Version:
$Revision$ $LastChangedBy$ $LastChangedDate$

$Id$

Definition at line 32 of file utility.php.


Member Function Documentation

Utility::call ( operation,
options = array() 
)

call a specific utility operation and eventually log errors

Parameters:
string $operation, the name of the operation. It is also the name of the method called and the name of log file written
array $options, default 'log' => false, no file log written other options can be seen in the relative utility operation
Returns:
array of response (Utility::response)
Exceptions:
BeditaException 

Definition at line 55 of file utility.php.

Utility::cleanupCache ( options = array()  )  [protected]

utility operation cleanup cached files according to BeSystem::cleanupCache()

Parameters:
array $options 'basePath' => TMP (default) the path on which search and clear cache 'frontendsToo' => true (default) to clean also frontends cache 'cleanAll' => false (default) clean all folders in tmp/cache not just 'models', 'persistent' and 'views'

Definition at line 165 of file utility.php.

References BeLib::getObject().

Utility::clearMediaCache ( options  )  [protected]

utility operation clear media cache, remove image thumbs according to Stream::clearMediaCache()

Parameters:
array $options 'log' => true to log errors

Definition at line 125 of file utility.php.

Utility::emptyLogs ( options  )  [protected]

utility operation delete log files according to BeSystem::emptyLogs()

Parameters:
array $options 'filename' => null (default delete all log files) the log file to delete, 'basePath' => LOGS (default) the log directory path 'log' => true to log errors

Definition at line 148 of file utility.php.

References BeLib::getObject().

Utility::rebuildIndex ( options  )  [protected]

utility operation rebuild index for search text according to SearchText::rebuildIndex()

Parameters:
array $options 'returnOnlyFailed' => true (default) to return only failed results 'delete' => delete index first (default false) 'type' => index object type only (default unset -> all types) 'log' => true to log errors

Definition at line 96 of file utility.php.

Utility::updateStreamFields ( options  )  [protected]

utility operation update stream fields according to Stream::updateStreamFields

Parameters:
array $options

Definition at line 81 of file utility.php.


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:47 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus