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 Area

Publication data

Model
Extended by AppModel
Extended by BEAppModel
Extended by BEAppObjectModel
Extended by BeditaCollectionModel
Extended by Area
Located at models/objects/collection/area.php

Methods summary

public
# afterSave( $created )
public array
# getArea( integer $areaId, boolean $details = false )

Return area data (id, title, status) by $areaId id. If $details param is true, extra data is retrieved: count (objects inside area by type)

Return area data (id, title, status) by $areaId id. If $details param is true, extra data is retrieved: count (objects inside area by type)

Parameters

$areaId
area id
$details
load details

Returns

array
area data
public array
# getAreas( boolean $details = false )

Return areas data (id, title, status). If $details param is true, extra data is retrieved: count (objects inside area by type)

Return areas data (id, title, status). If $details param is true, extra data is retrieved: count (objects inside area by type)

Parameters

$details
load details

Returns

array
areas
public array
# treeCountArea( integer $areaId )

Return count of objects in area $areaId or its descendant: group by type ('byType') and total ('allTypes').

Return count of objects in area $areaId or its descendant: group by type ('byType') and total ('allTypes').

Parameters

$areaId
area id

Returns

array
summary data about area $areaId
private integer
# treeCountAreaPerType( integer $areaId, integer $objectTypeId )

Return count of objects (descendants) in $areaId by type $objectTypeId

Return count of objects (descendants) in $areaId by type $objectTypeId

Parameters

$areaId
area id
$objectTypeId
object type id

Returns

integer
count of objects

Methods inherited from BeditaCollectionModel

deleteCollection()

Methods inherited from BEAppObjectModel

apiTransformer(), arrangeDataForClone(), checkType(), cloneObject(), field(), getTypeId(), save(), saveField(), updateHasManyAssoc(), validateContent()

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 array $actsAs
# array( 'ForeignDependenceSave' => array('SectionDummy'), 'RemoveDummyName' )
public array $searchFields
# array( "title" => 10, "nickname" => 8, "description" => 6, "public_name" => 10, "public_url" => 8, "note" => 2 )
protected array $modelBindings
# array( 'detailed' => array( 'BEObject' => array( 'ObjectType', 'UserCreated', 'UserModified', 'Permission', 'ObjectProperty', 'LangText', 'RelatedObject', 'Annotation', 'Version' => array('User.realname', 'User.userid') ), 'SectionDummy' ), 'default' => array( 'BEObject' => array( 'ObjectProperty', 'LangText', 'RelatedObject', 'ObjectType' ), 'SectionDummy' ), 'minimum' => array('BEObject' => array('ObjectType')), 'frontend' => array( 'BEObject' => array( 'LangText', 'RelatedObject', 'ObjectProperty' ) ), 'api' => array( 'BEObject' => array( 'LangText', 'ObjectProperty' ) ) )
public array $hasOne
# array( 'BEObject' => array( 'className' => 'BEObject', 'conditions' => '', 'foreignKey' => 'id', 'dependent' => true ), 'SectionDummy' => array( 'className' => 'SectionDummy', 'foreignKey' => 'id' ), )
public array $validate
# array( 'title' => array( 'rule' => 'notEmpty', 'required' => true ), 'public_url' => array( 'rule' => 'url', 'message' => 'url not valid', 'allowEmpty' => true ), 'staging_url' => array( 'rule' => 'url', 'message' => 'url not valid', 'allowEmpty' => true ), 'email' => array( 'rule' => 'email', 'message' => 'email not valid', 'allowEmpty' => true ), 'stats_provider_url' => array( 'rule' => 'url', 'message' => 'url not valid', 'allowEmpty' => true ) )
public array $objectTypesGroups
# array('related')

Properties inherited from BeditaCollectionModel

$recursive

Properties inherited from BEAppModel

$driver, $eQ, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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