Класс Entity

Граф наследования:Entity:

Открытые члены
	__construct (array $entity, array $storage)
	getId ()
	getType ()
	getXmlId ()
	getFullId ()
	canRead ($userId)
	canAdd ($userId)
	canEdit ($userId)
	canEditOwn ($userId)
	canModerate ($userId)
	setPermission ($userId, $permission)
	setEditOwn ($permission)
	getPermission ($userId)

Открытые статические члены
static	className ()
static	getModule ()
static	getEntityType ()
static	getXmlIdPrefix ()
static	getEntityByType ($type="")
static	getEntityByXmlId ($xmlId="")
static	onMessageIsIndexed ($id, array $message, array &$index)

Открытые атрибуты
const	ENTITY_TYPE = 'default'
const	MODULE_ID = 'forum'
const	XML_ID_PREFIX = 'TOPIC_'

Защищенные данные
	$entity
	$forum

Статические защищенные данные
static	$permissions = array()
static	$pathToUser = '/company/personal/user/#user_id#/'
static	$pathToGroup = '/workgroups/group/#group_id#/'
static	$entities

Подробное описание

См. определение в файле entity.php строка 10

Конструктор(ы)

__construct()

__construct	(	array	$entity,
		array	$storage )

Аргументы

array	$entity
array	$storage

См. определение в файле entity.php строка 34

Методы

canAdd()

canAdd

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

bool

Переопределяется в CalendarEntity, TaskEntity, TimemanEntryEntity и WorkflowEntity.

См. определение в файле entity.php строка 102

canEdit()

canEdit

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

bool

Переопределяется в CalendarEntity, TaskEntity, TimemanEntryEntity и WorkflowEntity.

См. определение в файле entity.php строка 111

canEditOwn()

canEditOwn

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

bool

Переопределяется в CalendarEntity, TaskEntity и TimemanEntryEntity.

См. определение в файле entity.php строка 119

canModerate()

canModerate

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

bool

См. определение в файле entity.php строка 127

canRead()

canRead

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

bool

Переопределяется в CalendarEntity, TaskEntity, TimemanEntryEntity и WorkflowEntity.

См. определение в файле entity.php строка 94

className()

static className ( )

static

См. определение в файле entity.php строка 70

getEntityByType()

static getEntityByType ( $type = "" )

static

Аргументы

string

$type

Type entity.

Возвращает

array|null

См. определение в файле entity.php строка 214

getEntityByXmlId()

static getEntityByXmlId ( $xmlId = "" )

static

Аргументы

string

$xmlId

Type entity.

Возвращает

array|null

См. определение в файле entity.php строка 225

getEntityType()

static getEntityType ( )

static

См. определение в файле entity.php строка 80

getFullId()

getFullId

(

)

Возвращает

array

См. определение в файле entity.php строка 65

getId()

getId

(

)

См. определение в файле entity.php строка 45

getModule()

static getModule ( )

static

См. определение в файле entity.php строка 75

getPermission()

getPermission

(

$userId

)

Аргументы

integer

$userId

User id.

Возвращает

$this

См. определение в файле entity.php строка 164

getType()

getType

(

)

См. определение в файле entity.php строка 50

getXmlId()

getXmlId

(

)

См. определение в файле entity.php строка 55

getXmlIdPrefix()

static getXmlIdPrefix ( )

static

См. определение в файле entity.php строка 85

onMessageIsIndexed()

static onMessageIsIndexed ( $id, array $message, array & $index )

static

Event before indexing message.

Аргументы

integer	$id	Message ID.
array	$message	Message data.
array	&$index	Search index array.

Возвращает

boolean

Переопределяется в CalendarEntity и TaskEntity.

См. определение в файле entity.php строка 330

setEditOwn()

setEditOwn

(

$permission

)

Аргументы

bool

$permission

Возвращает

$this

См. определение в файле entity.php строка 154

setPermission()

setPermission	(		$userId,
			$permission )

   @param integer $userId User id.
   @param string $permission A < E < I < M < Q < U < Y

A - NO ACCESS E - READ I - ANSWER M - NEW TOPIC Q - MODERATE U - EDIT Y - FULL_ACCESS.

Возвращает

$this

См. определение в файле entity.php строка 139

Данные класса

$entities

$entities

staticprotected

См. определение в файле entity.php строка 28

$entity

$entity

protected

См. определение в файле entity.php строка 17

$forum

$forum

protected

См. определение в файле entity.php строка 19

$pathToGroup

$pathToGroup = '/workgroups/group/#group_id#/'

staticprotected

См. определение в файле entity.php строка 25

$pathToUser

$pathToUser = '/company/personal/user/#user_id#/'

staticprotected

См. определение в файле entity.php строка 24

$permissions

$permissions = array()

staticprotected

См. определение в файле entity.php строка 21

ENTITY_TYPE

const ENTITY_TYPE = 'default'

См. определение в файле entity.php строка 12

MODULE_ID

const MODULE_ID = 'forum'

См. определение в файле entity.php строка 13

XML_ID_PREFIX

const XML_ID_PREFIX = 'TOPIC_'

См. определение в файле entity.php строка 14