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 BeditaException

Bedita exceptions definitions, loaded from bootstrap.php

In general BEdita errors are interpreted as 500 http code errors.

Exception
Extended by BeditaException

Direct known subclasses

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

Located at bedita_exception.php

Methods summary

public
# __construct( string $message = NULL, mixed $details = NULL, $res = self::ERROR, integer $code = 500 )

Constructor

Constructor

$details can contain some special keys:

  • cause: the cause that has caused the error
  • errorCode: the internal error code

Parameters

$message
If no message is given 'Unexpected error, operation failed' will be the message
$details
The exception details
$res
result status
$code
Status code, defaults to 500

Overrides

Exception::__construct
public BeErrorCode|null
# setErrorCode( array|string $errorCode )

Set a BeErrorCode defined by $errorCode.

Set a BeErrorCode defined by $errorCode.

$errorCode can be a string as 'UPLOAD_QUOTA_EXCEEDED' or an array with the error code as key and details as value. If it's a string or an array with empty values the default details defined in config/error.codes.php is used.

Parameters

$errorCode
The error code configuration

Returns

BeErrorCode|null

See

libs/errors/codes/be_error_code.php
BeLib::errorCode()
public BeErrorCode|null
# getErrorCode( )

Return the instance of BeErrorCode or null if error code is not been set.

Return the instance of BeErrorCode or null if error code is not been set.

Returns

BeErrorCode|null

See

libs/errors/codes/be_error_code.php
public
# getDetails( )
public
# errorTrace( )
public number
# getHttpCode( )

Return httpCode for exception (null, if not set)

Return httpCode for exception (null, if not set)

Returns

number
public string|null
# getHeader( )

Handling http status code header, according to $this->httpCode (if not set or code not handled, return null) Http codes handled: 401, 403, 404, 500

Handling http status code header, according to $this->httpCode (if not set or code not handled, return null) Http codes handled: 401, 403, 404, 500

Deprecated

Returns

string|null
public string|null
# getCause( )

Return the reason why the Exception was thrown

Return the reason why the Exception was thrown

Returns

string|null

Methods inherited from Exception

__toString(), __wakeup(), getCode(), getFile(), getLine(), getMessage(), getPrevious(), getTrace(), getTraceAsString()

Constants summary

string ERROR
# 'ERROR'
string WARN
# 'WARN'

Properties summary

public $result
#
protected integer $httpCode

The http status code (if any)

The http status code (if any)

# null
protected $errorDetails
#
protected string $cause

the reason why the Exception was thrown

the reason why the Exception was thrown

# null
protected BeErrorCode $errorCode

The instance of the error code thrown

The instance of the error code thrown

See

libs/errors/codes/be_error_code.php
# null

Properties inherited from Exception

$code, $file, $line, $message

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