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 Category

Category model

Model
Extended by AppModel
Extended by BEAppModel
Extended by Category
Located at models/category.php

Methods summary

public
# afterFind( $result )
public integer
# paginateCount( array $conditions = null, integer $recursive = 0, array $extra = array() )

Custom pagination count.

Custom pagination count.

Parameters

$conditions
The conditions
$recursive
Recursive option
$extra
Extra options

Returns

integer
public
# tagLabelPresent( $label, $exclude_id = null )
public
# tagLabelFromName( string $name )

Get tag label from unique name

Get tag label from unique name

Parameters

$name
public
# uniqueLabelName( string $label )

Define a unique name from label: lowercase, trimmed, etc...

Define a unique name from label: lowercase, trimmed, etc...

Parameters

$label
public
# beforeValidate( )

Define default values

Define default values

public array( "area"
# getCategoriesByArea( integer $objectType )

Get all categories of some object type and order them by area

Get all categories of some object type and order them by area

Parameters

$objectType

Returns

array( "area"

"area" => array( nomearea => array(categories in that area)), "noarea" => array(categories aren't in any area) )

public array
# objectCategories( integer $objectTypeId )

Get all categories defined for object type id

Get all categories defined for object type id

Parameters

$objectTypeId
$objectType

Returns

array

of ( "area" => array( nomearea => array(categories in that area)), "noarea" => array(categories aren't in any area) )

private
# collateStatment( )
public array
# saveTagList( comma $tagList )

save a list of comma separated tag

save a list of comma separated tag

Parameters

$tagList
string $tagList

Returns

array
of tags' id
public array
# getTags( array $options = array() )

return list of tags with their weight

return list of tags with their weight

Parameters

$options

"showOrphans" => true, show all tags also not associated "status" => null, string or array (on, off, draft). if area_id is setted "status" is used also to related objects "cloud" => false, true to set a css class for cloud view "coeff" => 12, coeffiecient for calculate the distribution "order" => "label", order by field "dir" => 1, asc(1), desc(0) "area_id"=> null get tags only associated to objects that are in "area_id" publication

Returns

array
public
# getContentsByTag( $name )
public mixed,
# checkMediaType( integer $object_type_id, $mediatype )

USED for multimedia objects check if exists $mediatype in categories for an object type. If not, create the category

USED for multimedia objects check if exists $mediatype in categories for an object type. If not, create the category

Parameters

$object_type_id
$mediatype

Returns

mixed,
false if not mediatype in the form else return array of Category
private static integer
# reorderTag( array $e1, array $e2 )

compare two array elements defined by $orderTag var and return -1,0,1 $dirTag is used for define order of comparison

compare two array elements defined by $orderTag var and return -1,0,1 $dirTag is used for define order of comparison

Parameters

$e1
$e2

Returns

integer
(-1,0,1)
public array
# findCreateCategories( array & $names, integer $objTypeId )

Search for category names, create if not already present, and return array of corresponding id

Search for category names, create if not already present, and return array of corresponding id

Parameters

$names
$names, category names to search/create
$objTypeId
$objTypeId, category object type id

Returns

array
of corresponding id-category
public true
# addObjectCategory( $categoryId, $objectId )

Add category to object usgin both category and object id

Add category to object usgin both category and object id

Returns

true
on success, false on failure
public
# appendMediatype( array $objects, array $options = array() )

append mediatype to objects array

append mediatype to objects array

Parameters

$objects
$options
public proerty
# categoryId( $name, $objectTypeId )

Get category id from name and object type id

Get category id from name and object type id

Parameters

$name
unique name of category
$objectTypeId
object type id

Returns

proerty
id on success, null if no proerty id was found

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

Constants summary

string COUNT_DENY_OPTIONS

Special key used in pagination count to remove unwanted options during the count

Special key used in pagination count to remove unwanted options during the count

# '_countDenyOptions'

Properties summary

public array $actsAs
# array( 'CompactResult' => array() )
public array $validate
# array( 'label' => array( 'rule' => 'notEmpty' ), 'status' => array( 'rule' => 'notEmpty' ), 'name' => array( 'rule' => 'notEmpty' ) )
public static $dirTag
#
public static $orderTag
#

Properties inherited from BEAppModel

$driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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