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 AppError

BEdita/cake error handler (backends+frontends)

ErrorHandler
Extended by AppError
Located at app_error.php

Methods summary

public
# __construct( $method, $messages, Exception $exception = null )
public
# restoreDebugLevel( )
private
# checkController( )

Check if Controller has basic initialization

Check if Controller has basic initialization

  • Check if params are defined
  • Check if RequestHandler and ResponseHandler components are initialized
  • Add BeFront helper in frontend apps
  • Add $conf to viewVars if missing
protected
# setLayout( string $layout = 'error' )

Set the layout to use If Request is ajax set ajax layout

Set the layout to use If Request is ajax set ajax layout

Parameters

$layout
protected
# setError( array $error = array() )

Set self::error to View vars and add also it to '_serialize' for ResponseHandlerComponent

Set self::error to View vars and add also it to '_serialize' for ResponseHandlerComponent

Parameters

$error
protected string
# getViewFile( )

Return the error template to use The template depends from http status code triggered from Exception

Return the error template to use The template depends from http status code triggered from Exception

First it checks if exists 'views/errors/error' . self::exception::httpCode() . '.tpl' (or .ctp) If it not exists then it return the more general 'views/errors/error.tpl' (or .ctp)

Returns

string
public
# handleException( array $messages )
public
# handleSmartyException( array $messages )
public
# handleBeditaAjaxException( array $messages )

handle ajax exception

handle ajax exception

Parameters

$messages

'msg' => the exception message 'details' => the error detail 'output' => the output type. It can be: 'html' (default) BEdita html standard error message from elements/message.tpl 'json' json object is built in view as: { errorMsg: exception message, htmlMsg: BEdita html standard error message from see elements/message.tpl } 'beditaMsg' output the BEdita html standard error message and trigger it 'reload' javascript: location.reload(); used for example when the session expired in a ajax call 'headers' => server headers (usually header error): if it's not set or === null no headers error will be sent if it's set and empty use "HTTP/1.1 500 Internal Server Error"

public
# handleExceptionRuntime( array $messages )

Deprecated

Parameters

$messages
public
# handleExceptionFrontend( array $messages )

Deprecated

Parameters

$messages
public
# handleExceptionFrontAccess( array $messages )

Deprecated

Parameters

$messages
private
# sendMail( $mailMsg )
public
# _outputMessage( $template )
public
# __outputMessage( $template )
public string|null
# getUrl( )

Return the request url

Return the request url

Returns

string|null
public string
# getMessage( )

Return the error message If an exception has created the error use its message else try to read some View vars set by CakePHP

Return the error message If an exception has created the error use its message else try to read some View vars set by CakePHP

Returns

string

Properties summary

protected array $error404

CakePHP errors that will be treated as 404 http errors All other CakePHP errors will be treated as 500 http errors

CakePHP errors that will be treated as 404 http errors All other CakePHP errors will be treated as 500 http errors

# array('missingController', 'missingAction')
protected string $errorTrace

The exception error trace

The exception error trace

# ''
protected integer $debugLevel

Current app debug level

Current app debug level

#
protected Exception $exception

The Exception that has been thrown

The Exception that has been thrown

# null
protected array $error

Error data set for View It is set also as '_serialize' view var so that ResponseHandlerComponent can use it to send to the client as payload In json/xml requests

Error data set for View It is set also as '_serialize' view var so that ResponseHandlerComponent can use it to send to the client as payload In json/xml requests

Options are

'status' => null, // the http status code
'code' => null, // the error code
'message' => null, // the error message
'details' => null, // the error details
'moreInfo' => null, // other useful information
'url' => null // the url that has caused the error
# array( 'status' => null, 'code' => null, 'message' => null, 'details' => null, 'more_info' => null, 'url' => null )
protected string $layout

The layout to use (default is 'error')

The layout to use (default is 'error')

# 'error'
BEdita API doc | 4-cactus API documentation generated by ApiGen