• Главная
• ActivityModel

PHP Класс ActivityModel, vanilla

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$ActivityTypes		Allowed activity types.
$MaxMergeCount		Limit on number of activity to combine.
$Queue		Activity to be saved.

Открытые методы

Метод	Описание
__construct ( )	Defines the related database table name.
activityQuery ( boolean $Join = true )	Build basis of common activity SQL query.
add ( integer $ActivityUserID, string $ActivityType, string $Story = null, integer | null $RegardingUserID = null, integer $CommentActivityID = null, string $Route = null, string | boolean $SendEmail = '' ) : integer	Add a new activity item.
calculateData ( &$Data )
calculateRow ( &$Row )
canDelete ( $activity ) : boolean
clearNotificationQueue ( )	Clear notification queue.
comment ( array $Comment ) : integer | boolean | string	Save a comment on an activity.
defineType ( string $Name, array $Activity = [] )	Define a new activity type.
delete ( $where = [], $options = [] )
deleteComment ( integer $ID ) : Gdn_DataSet	Delete an activity comment.
deleteID ( integer $ActivityID, array $Options = [] ) : boolean	Delete a particular activity item.
email ( &$Activity, boolean $NoDelete = false ) : boolean
getActivityType ( $ActivityType ) : boolean
getByUser ( integer | boolean $NotifyUserID = false, integer $Offset, integer $Limit = 30 ) : Gdn_DataSet	Modifies standard Gdn_Model->Get to use AcitivityQuery.
getComment ( integer $ID ) : array | false
getComments ( array $ActivityIDs ) : Gdn_DataSet	Get comments related to designated activity items.
getCount ( string $UserID = '' ) : integer	Get number of activity related to a user.
getCountForRole ( integer | string $RoleID = '' ) : integer	Get number of activity related to a particular role.
getForRole ( string $RoleID = '', integer $Offset, integer $Limit = 50 ) : Gdn_DataSet	Get activity related to a particular role.
getID ( integer $activityID, boolean | string $dataSetType = false, array $options = [] ) : array | object	Get a particular activity record.
getNotifications ( integer $NotifyUserID, integer $Offset, integer $Limit = 30 ) : Gdn_DataSet	Get notifications for a user.
getNotificationsSince ( integer $UserID, integer $LastActivityID, array | string $FilterToActivityTypeIDs = '', integer $Limit = 5 ) : Gdn_DataSet	Get notifications for a user since designated ActivityID.
getPruneAfter ( ) : string	Get the delete after time.
getUsers ( &$Data )
getWhere ( array $Where = [], string $orderFields = '', string $orderDirection = '', integer | boolean $Limit = false, integer | boolean $Offset = false ) : Gdn_DataSet	Modifies standard Gdn_Model->GetWhere to use AcitivityQuery.
getWhereRecent ( array $where, integer $limit, integer $offset ) : Gdn_DataSet	Get the recent activities.
joinComments ( &$Activities )
joinUsers ( &$Activities )	Join the users to the activities.
markRead ( $UserID )
mergeActivities ( $OldActivity, $NewActivity, array $Options = [] ) : array
notificationPreference ( string $ActivityType, array $Preferences, string $Type = null ) : boolean | bool[]	Get default notification preference for an activity type.
queue ( array $Data, string | boolean $Preference = false, array $Options = [] )	Queue an activity for saving later.
queueNotification ( integer $ActivityID, string $Story = '', string $Position = 'last', boolean $Force = false )	Queue a notification for sending.
save ( array $Data, boolean $Preference = false, array $Options = [] ) : array | boolean | string | null
saveQueue ( ) : array
sendNotification ( integer $ActivityID, array | string $Story = '', boolean $Force = false )	Send notification.
sendNotificationQueue ( )	Send all notifications in the queue.
setNotified ( $ActivityIDs )
setPruneAfter ( string $pruneAfter ) : ActivityModel	Set the prune after date.
share ( &$Activity )

Защищенные методы

Метод	Описание
_touch ( &$Data )
notifyWallComment ( array $Comment, $WallPost )	Notify the user of wall comments.
notifyWallPost ( $WallPost )

Приватные методы

Метод	Описание
getEmailMessage ( array | object $activity ) : string	Takes an array representing an activity and builds the email message based on the activity's story and the contents of the global config Garden.Email.Prefix.
getPruneDate ( ) : DateTime | null	Get the exact timestamp to prune.
prune ( )	Prune old activities.

Описание методов

Описание свойств