Класс Feed

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

Открытые члены
	canAdd ()
	canRead ()
	canEdit ()
	canEditComment ($commentId)
	canDelete ()
	canDeleteComment ($commentId)
	canModerate ()
	canEditOwn ()
	add (array $params)
	edit ($id, array $params)
	delete ($id)
	moderate ($id, $show)
	send ($id, array $params)
	setPermission ($permission)
	setEditOwn ($allow)
	getPermission ()
Открытые члены унаследованные от BaseObject
	__construct ($forumId, $entity, $userId=null)
	getEntity ()
	getTopic ()
	hasErrors ()
	getErrors ()
	getForum ()
	setForumFields (array $params)
	getUser ()
	getUserUnreadMessageId ()
	setUserAsRead ()
	setUserLocation ()
	getApplication ()

Открытые атрибуты
const	ERROR_PARAMS_MESSAGE = 'params0004'
const	ERROR_PERMISSION = 'params0005'
Открытые атрибуты унаследованные от BaseObject
const	ERROR_PARAMS_FORUM_ID = 'params0001'
const	ERROR_PARAMS_TOPIC_ID = 'params0002'
const	ERROR_PARAMS_ENTITY_ID = 'params0003'

Дополнительные унаследованные члены
Защищенные члены унаследованные от BaseObject
	setEntity (array $id)
	setTopic ()
	setForum ($id)
	setUser ($userId)
	getUserName ($userId)
Защищенные статические члены унаследованные от BaseObject
static	checkForumId (&$forumId)
Защищенные данные унаследованные от BaseObject
	$user
	$entity
	$forum
	$topic
	$errorCollection

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

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

Методы

add()

add

(

array

$params

)

Add a comment

Аргументы

array

$params

Fields for new message to add in table b_forum_message.

Возвращает

array|bool

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

canAdd()

canAdd

(

)

Returns true if entity allows adding

Возвращает

bool

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

canDelete()

canDelete

(

)

Returns true if entity allows deleting.

Возвращает

bool

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

canDeleteComment()

canDeleteComment

(

$commentId

)

Аргументы

integer

$commentId

Message ID in b_forum_message to delete.

Возвращает

bool

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

canEdit()

canEdit

(

)

Returns true if entity allows editing

Возвращает

bool

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

canEditComment()

canEditComment

(

$commentId

)

Аргументы

integer

$commentId

Message ID in b_forum_message to edit.

Возвращает

bool

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

canEditOwn()

canEditOwn

(

)

Возвращает

bool

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

canModerate()

canModerate

(

)

Возвращает

bool

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

canRead()

canRead

(

)

Returns true if entity allows reading

Возвращает

bool

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

delete()

delete

(

$id

)

Delete a comment

Аргументы

integer

$id

Message id.

Возвращает

array|bool

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

edit()

edit	(		$id,
		array	$params
	)

Edit a comment

Аргументы

integer	$id	Message id.
array	$params	Fields to edit message.

Возвращает

array|bool

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

getPermission()

getPermission

(

)

Returns permission From list: A < E < I < M < Q < U < Y.

Возвращает

string

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

moderate()

moderate	(		$id,
			$show
	)

Moderate comment with id

Аргументы

integer	$id	Message id.
boolean	$show	State for moderating: true - show, false - hide.

Возвращает

array|bool

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

send()

send	(		$id,
		array	$params
	)

Render comment through the component and send into pull

Аргументы

integer	$id	Message id.
array	$params	Params for component including.

Возвращает

bool

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

setEditOwn()

setEditOwn

(

$allow

)

Аргументы

boolean

$allow

True or false.

Возвращает

$this

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

setPermission()

setPermission

(

$permission

)

Mainly this function for forum entity. In this case params have to from the list: A < E < I < M < Q < U < Y A - NO ACCESS E - READ I - ANSWER M - NEW TOPIC Q - MODERATE U - EDIT Y - FULL_ACCESS

Аргументы

string

$permission

A,E,I,M,Q,U,Y.

Возвращает

$this

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

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

ERROR_PARAMS_MESSAGE

const ERROR_PARAMS_MESSAGE = 'params0004'

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

ERROR_PERMISSION

const ERROR_PERMISSION = 'params0005'

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