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 BEAppObjectModel

BEdita base app object class. BEdita objects should extend BEAppObjectModel

Model
Extended by AppModel
Extended by BEAppModel
Extended by BEAppObjectModel

Direct known subclasses

BeditaAnnotationModel, BeditaCollectionModel, BeditaContentModel, BeditaProductModel, BeditaSimpleObjectModel, BeditaSimpleStreamModel, BeditaStreamModel, Card, Link

Indirect known subclasses

Application, Area, Gallery, Image, MailMessage, MailTemplate, Section, ShortNews, Video, Audio, BeditaObjectModel, BEFile, Caption, Comment, Document, EditorNote, Event

Located at app_model.php

Methods summary

public
# field( string $name, array $conditions = null, string $order = null )

Overrides field, don't use CompactResult in field()

Overrides field, don't use CompactResult in field()

Parameters

$name
$conditions
$order
public
# saveField( string $name, array $value, string $validate = false )

Overrides saveField, don't use CompactResult in saveField()

Overrides saveField, don't use CompactResult in saveField()

Parameters

$name
$value
$conditions
$validate
$order
public
# save( $data = null, $validate = true, $fieldList = array() )
public type
# cloneObject( integer $id, array $options = array() )

Clone a BEdita object starting from object id It should be called from a BEdita object model as Document, Section, etc...

Clone a BEdita object starting from object id It should be called from a BEdita object model as Document, Section, etc...

Parameters

$id
$id, the BEdita object id
$options
$options, see BEAppObjectModel::arrangeDataForClone

Returns

type
public
# arrangeDataForClone( array & $data, array $options = array() )

Arrange an array to cloning a BEdita object

Arrange an array to cloning a BEdita object

Parameters

$data
$data, should come from a find
$options

$options, default values are: "nicknameSuffix" => "", suffix to append at the original object nickname "keepTitle" => false, true to keep the original object title "keepUserCreated" => false, true to keep the original user created

protected boolean
# updateHasManyAssoc( )

Updates hasMany model rows: * delete all rows of hasMany models except ones with "id" set in $data array * saves/updates all hasMany data rows from $data array

Updates hasMany model rows: * delete all rows of hasMany models except ones with "id" set in $data array * saves/updates all hasMany data rows from $data array

Returns

boolean

Throws

BeditaException
protected
# validateContent( )

default values for Contents

default values for Contents

public
# checkType( $objTypeId )
public
# getTypeId( )
public array
# apiTransformer( array $options = array() )

Return an array of column types to transform (cast) for generic BEdita object type Used to build consistent REST APIs

Return an array of column types to transform (cast) for generic BEdita object type Used to build consistent REST APIs

In general it returns all castable fields from: - main Model table - tables that extend the object (ForeignDependenceSave) - GetTag, Category, Tag

Possible options are: - 'castable' an array of fields that the REST APIs should cast to

Parameters

$options

Returns

array

Overrides

AppModel::apiTransformer

Methods inherited from BEAppModel

am(), buildQueryStatement(), checkDate(), checkDuration(), checkFloat(), checkNumber(), containLevel(), email(), fieldsString(), findObjects(), findObjectsAfterFilter(), findObjectsClauses(), findObjectsCount(), getBindingsLevel(), getDefaultDateFormat(), getDriver(), getEndQuote(), getLimitClausole(), getStartQuote(), setBindingsLevel(), setupDbParams(), toolbar()

Properties summary

public integer $recursive
# 2
public array $actsAs
# array( 'Callback', 'CompactResult' => array(), 'SearchTextSave', 'RevisionObject', 'ForeignDependenceSave' => array('BEObject'), 'DeleteObject' => 'objects', 'Notify' )
public array $hasOne
# array( 'BEObject' => array( 'className' => 'BEObject', 'conditions' => '', 'foreignKey' => 'id', 'dependent' => true ) )
public array $objectTypesGroups
# array()

Properties inherited from BEAppModel

$driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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