BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • AnnotationsTable
  • ApplicationsTable
  • AsyncJobsTable
  • AuthProvidersTable
  • CategoriesTagsBaseTable
  • EndpointsTable
  • FoldersTable
  • HistoryTable
  • LocationsTable
  • MediaTable
  • ObjectCategoriesTable
  • ObjectPermissionsTable
  • ObjectPropertiesTable
  • ObjectRelationsTable
  • ObjectsBaseTable
  • ObjectTagsTable
  • ObjectTypesTable
  • PropertiesTable
  • PropertyTypesTable
  • RelationTypesTable
  • RolesTable
  • RolesUsersTable
  • StaticPropertiesTable
  • StreamsTable
  • TagsTable
  • TranslationsTable
  • TreesTable
  • UserTokensTable

Class ApplicationsTable

Applications Model

Cake\ORM\Table
Extended by BEdita\Core\Model\Table\ApplicationsTable
Namespace: BEdita\Core\Model\Table
Mixin: \Cake\ORM\Behavior\TimestampBehavior
Since: 4.0.0
Located at Core/src/Model/Table/ApplicationsTable.php

Methods summary

public
# initialize( array $config )

Codecoverageignore

public
# validationDefault( Cake\Validation\Validator $validator )

Codecoverageignore

public
# buildRules( Cake\ORM\RulesChecker $rules )

Codecoverageignore

public
# beforeSave( Cake\Event\Event $event, Cake\Datasource\EntityInterface $entity )

Generate the api key on application creation.

Generate the api key on application creation.

If applications is DEFAULT_APPLICATION or current invoking application and enabled is false raise an ImmutableResourceException

Parameters

$event
The event dispatched
$entity
The entity to save

Throws

BEdita\Core\Exception\ImmutableResourceException
if entity is not disableable
public static string
# generateApiKey( )

Generate a unique api key

Generate a unique api key

Returns

string
protected Cake\ORM\Query
# findApiKey( Cake\ORM\Query $query, array $options )

Find an active application by its API key.

Find an active application by its API key.

Parameters

$query
Query object instance.
$options
Options array. It requires an apiKey key.

Returns

Cake\ORM\Query
public
# beforeDelete( Cake\Event\Event $event, Cake\Datasource\EntityInterface $entity )

Before delete checks: if applications is DEFAULT_APPLICATION or current raise a ImmutableResourceException

Before delete checks: if applications is DEFAULT_APPLICATION or current raise a ImmutableResourceException

Parameters

$event
The beforeSave event that was fired
$entity
the entity that is going to be saved

Throws

BEdita\Core\Exception\ImmutableResourceException
if entity is not deletable

Magic methods summary

public BEdita\Core\Model\Entity\Application
# get( $primaryKey, $options = [] )

Parameters

$primaryKey
$options

Returns

BEdita\Core\Model\Entity\Application
public BEdita\Core\Model\Entity\Application
# newEntity( $data = null, array $options = [] )

Parameters

$data
$options

Returns

BEdita\Core\Model\Entity\Application
public BEdita\Core\Model\Entity\Application[]
# newEntities( array $data, array $options = [] )

Parameters

$data
$options

Returns

BEdita\Core\Model\Entity\Application[]
public BEdita\Core\Model\Entity\Application|boolean
# save( Cake\Datasource\EntityInterface $entity, $options = [] )

Parameters

$entity
$options

Returns

BEdita\Core\Model\Entity\Application|boolean
public BEdita\Core\Model\Entity\Application
# patchEntity( Cake\Datasource\EntityInterface $entity, array $data, array $options = [] )

Parameters

$entity
$data
$options

Returns

BEdita\Core\Model\Entity\Application
public BEdita\Core\Model\Entity\Application[]
# patchEntities( $entities, array $data, array $options = [] )

Parameters

$entities
$data
$options

Returns

BEdita\Core\Model\Entity\Application[]
public BEdita\Core\Model\Entity\Application
# findOrCreate( $search, callable $callback = null, $options = [] )

Parameters

$search
$callback
$options

Returns

BEdita\Core\Model\Entity\Application

Constants summary

integer DEFAULT_APPLICATION

Default application id

Default application id

# 1

Properties summary

Magic properties

public Cake\ORM\Association\HasMany $EndpointPermissions
BEdita API doc | 4-cactus API documentation generated by ApiGen