BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException

Class Utility

Utility model class Execute utility operations

Model
Extended by AppModel
Extended by Utility
Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$


Located at models/utility.php

Methods summary

public array
# call( string $operation, array $options = array() )

call a specific utility operation and eventually log errors

call a specific utility operation and eventually log errors

Parameters

$operation

$operation, the name of the operation. It is also the name of the method called and the name of log file written

$options

$options, default 'log' => false, no file log written other options can be seen in the relative utility operation

Returns

array
of response (Utility::response)

Throws

BeditaException
protected
# updateStreamFields( array $options )

utility operation update stream fields according to Stream::updateStreamFields

utility operation update stream fields according to Stream::updateStreamFields

Parameters

$options
protected
# rebuildIndex( array $options )

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

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

Parameters

$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 'min' => min ID to index 'max' => max ID to index

protected
# clearMediaCache( array $options )

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

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

Parameters

$options
'log' => true to log errors
protected
# emptyLogs( array $options )

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

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

Parameters

$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

protected
# cleanupCache( array $options = array() )

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

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

Parameters

$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'

private string
# buildLogItems( array $data = array() )

build an array of log items loop the $data array and build an array of string built with all key => value pairs

build an array of log items loop the $data array and build an array of string built with all key => value pairs

Parameters

$data

$data, multidimensional array as 0 => array('id' => 1, '.....'fieldname' => 'value_1', ...), 1 => array('id' => 2, '.....'fieldname' => 'value_2', ...)

Returns

string
private
# clearResponse( )

clear Utility::response

clear Utility::response

Methods inherited from AppModel

apiTransformer()

Properties summary

public boolean $useTable
# false
protected array, $response

response of Utility::call()

response of Utility::call()

# array('results' => null, 'message' => null, 'log' => null)

Properties inherited from AppModel

$actsAs, $apiTransformerOptions

BEdita API doc | 4-cactus API documentation generated by ApiGen