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 BEObject

BEObject class

Model
Extended by AppModel
Extended by BEAppModel
Extended by BEObject
Located at models/objects/b_e_object.php

Methods summary

public
# afterFind( $result )

Format object data (ObjectProperty, Tag, Category, LangText, Permission)

Format object data (ObjectProperty, Tag, Category, LangText, Permission)

If ObjectProperty is populated a simplified customProperties array (useful in frontend apps) is built as

"customProperties" => array(
"prop_name" => "prop_val",
"prop_name_multiple_choice" => array("prop_val_1", "prop_val_2")

)

public
# beforeSave( )
public
# afterSave( )

Save hasMany relations data

Save hasMany relations data

public
# beforeValidate( )

Define default values.

Define default values.

public
# findObjectTypeId( $id )
public boolean
# isFixed( integer $id )

Is object fixed??

Is object fixed??

Parameters

$id

Returns

boolean
public
# getType( unknown_type $id )

Model name/type from id

Model name/type from id

Parameters

$id
public boolean
# updateTitleDescription( integer $id, string|null $title, string|null $description )

Update title and description only.

Update title and description only.

Parameters

$id
$title
$description

Returns

boolean
private string
# _getDefaultNickname( string $value )

build object unique name

build object unique name

Parameters

$value

Returns

string
private
# _getDefaultLang( )
private
# _getDefaultIP( )
private integer
# _getIDCurrentUser( )

Returns the current user ID. If a unit test is running, the test user ID is returned instead.

Returns the current user ID. If a unit test is running, the test user ID is returned instead.

Returns

integer
Current User's ID, or test User's ID. Defaults to system User's ID.

See

BeSystem::systemUserId()
private boolean
# _isCurrentUserAdmin( )

Checks whether current User is in Group administrator or not.

Checks whether current User is in Group administrator or not.

Returns

boolean
Current User's administrator permissions.
private
# setPublisher( )

Set the publisher to use in object creation.

Set the publisher to use in object creation.

In editing mode (id not empty) no takes action. In frontend no takes action. In backend set editorialContents.defaultPublisher if configured and publisher in data is empty

private
# _value2array( $name, & $val, & $arr )

torna un array con la variabile archiviata in un array

torna un array con la variabile archiviata in un array

public
# objectId( mixed $val )

Get object id from an identifier that could be an id or nickname

Get object id from an identifier that could be an id or nickname

Parameters

$val
public
# getIdFromNickname( string $nickname, $status = null )

Get object id from unique name

Get object id from unique name

Parameters

$nickname
$status
public
# getNicknameFromId( integer $id )

Get object nickname from id

Get object nickname from id

Parameters

$id
public array
# getPoster( integer|string $id = null, array $relations = array('attach') )

Get an image id and uri that can be used as a poster of the one represented by the $id Search in the relations expressed by $relations

Get an image id and uri that can be used as a poster of the one represented by the $id Search in the relations expressed by $relations

Parameters

$id
$relations

Returns

array

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()

Methods inherited from AppModel

apiTransformer()

Properties summary

public array $actsAs
# array('Cacheable')
public string $name
# 'BEObject'
public string $useTable
# "objects"
private string $defaultIp
# "::1"
public array $validate
# array( // 'title' => array( // 'rule' => 'notEmpty' // ), 'object_type_id' => array( 'rule' => 'notEmpty' ), 'nickname' => array( 'rule' => 'notEmpty' ), 'lang' => array( 'rule' => 'notEmpty' ), 'ip_created' => array( 'rule' => 'ip' ), 'status' => array( 'rule' => array('inList', array('on', 'off', 'draft')) ), )
public array $belongsTo
# array( 'ObjectType' => array( 'className' => 'ObjectType', 'foreignKey' => 'object_type_id', 'conditions' => '' ), 'UserCreated' => array( 'className' => 'User', 'fields' => 'id, userid, realname', 'foreignKey' => 'user_created', ), 'UserModified' => array( 'className' => 'User', 'fields' => 'id, userid, realname', 'foreignKey' => 'user_modified', ), )
public array $hasMany
# array( 'Permission', 'Version' => array( 'className' => 'Version', 'foreignKey' => 'object_id', 'dependent' => true ), 'ObjectProperty' => array( 'className' => 'ObjectProperty', 'foreignKey' => 'object_id', 'dependent' => true ), 'SearchText' => array( 'foreignKey' => 'object_id', 'dependent' => true ), 'LangText' => array( 'className' => 'LangText', 'foreignKey' => 'object_id', 'dependent' => true ), 'Annotation' => array( 'foreignKey' => 'object_id', 'dependent' => true ), 'RelatedObject' => array( 'className' => 'ObjectRelation', 'joinTable' => 'object_relations', 'foreignKey' => 'id', 'associationForeignKey' => 'object_id', 'order' => 'priority' ), 'Alias', 'GeoTag' => array( 'foreignKey' => 'object_id', 'dependent' => true ) )
public array $hasAndBelongsToMany
# array( 'Category' => array( 'className' => 'Category', 'joinTable' => 'object_categories', 'foreignKey' => 'object_id', 'associationForeignKey' => 'category_id', 'unique' => true ), 'User' => array( 'className' => 'User', 'joinTable' => 'object_users', 'foreignKey' => 'object_id', 'associationForeignKey' => 'user_id', 'unique' => true, 'with' => 'ObjectUser' ) )

Properties inherited from BEAppModel

$driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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