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 RelationStats

Class that provides relation statistics

Model
Extended by AppModel
Extended by BEAppModel
Extended by RelationStats
Located at models/business/relation_stats.php

Methods summary

public
# __construct( )

Constructor: retrieve all relations data

Constructor: retrieve all relations data

public array
# getRelation( string $relationName )

Return relation data by relation name

Return relation data by relation name

Parameters

$relationName
relation name

Returns

array
relation data
public array
# getRelations( )

Return all relations

Return all relations

Returns

array
relations
public
# getRelationNames( )
public string
# getDescription( string $relationName )

Return relation data as string

Return relation data as string

Parameters

$relationName
relation name

Returns

string
relation data
public array
# getObjectRelationsByNameAndObjectTypes( string $relationName, array $leftObjectTypes, array $rightObjectTypes )

Return ObjectRelation records by relation $relationName, for specific objects types: left side of relation object types => $leftObjectTypes right side of relation object types => $rightObjectTypes

Return ObjectRelation records by relation $relationName, for specific objects types: left side of relation object types => $leftObjectTypes right side of relation object types => $rightObjectTypes

Parameters

$relationName
relation name
$leftObjectTypes
int representing object types for left side of relation $relationName
$rightObjectTypes
int representing object types for right side of relation $relationName

Returns

array
ObjectRelation relations
public array
# getObjectRelationsByName( string $relationName )

Return ObjectRelation records by relation $relationName

Return ObjectRelation records by relation $relationName

Parameters

$relationName
relation name

Returns

array
ObjectRelation relations
public integer
# getObjectRelationsCount( string $relationName, $objectTypesFilter = null )

Return ObjectRelation count by $relationName relation. If $objectTypesFilter is specified, return count by object_type_id in $objectTypesFilter.

Return ObjectRelation count by $relationName relation. If $objectTypesFilter is specified, return count by object_type_id in $objectTypesFilter.

Parameters

$relationName
relation name
$objectTypesFilter

Returns

integer
count of ObjectRelation by $relationName relation (and object types in $objectTypesFilter, if specified)
public array
# getObjectRelationsCountGroupByType( string $relationName )

Return ObjectRelation array count by $relationName relation group by object_type_id

Return ObjectRelation array count by $relationName relation group by object_type_id

Parameters

$relationName
relation name

Returns

array
count of ObjectRelation by $relationName relation group by object_type_id
public array
# objectTypesIdsForObjectNames( array $relationData, string $side = 'left' )

Return object type ids for relation by $side (can be 'left' or 'right') If $side array is empty, return configure objectTypes.related.id array

Return object type ids for relation by $side (can be 'left' or 'right') If $side array is empty, return configure objectTypes.related.id array

Parameters

$relationData
relation data
$side
can be 'left' or 'right'

Returns

array
int object type ids
private array
# objectTypesRelatedNames( )

Return ordered object types related names, getting them from config keys objectTypes.related.id

Return ordered object types related names, getting them from config keys objectTypes.related.id

Returns

array
related object types names

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 boolean $useTable
# false
public array $relations
# array()
public array $relationNames
# array()

Properties inherited from BEAppModel

$actsAs, $driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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