PHP Class IgnorePlugin, addons

Inheritance: extends Gdn_Plugin
Show file Open project: vanilla/addons

Public Properties

Property Type Description
$allowModeratorIgnore

Public Methods

Method Description
AssetModel_StyleCss_Handler ( $Sender )
Controller_Add ( $Sender ) * API METHODS
Controller_Index ( $Sender )
Controller_Remove ( $Sender )
Controller_Restrict ( $Sender )
DiscussionController_BeforeCommentDisplay_Handler ( $Sender )
DiscussionController_BeforeDiscussionRender_Handler ( $Sender )
IgnoreConversations ( $IgnoreUserID, $SessionUserID = NULL )
IgnoreRestricted ( $UserID, $SessionUserID = NULL )
Ignored ( $UserID = NULL, $SessionUserID = NULL )
MessagesController_BeforeAddConversation_Handler ( MessageController $Sender )
MessagesController_BeforeAddMessage_Handler ( MessageController $Sender ) Add a new message to a conversation.
ProfileController_AfterAddSideMenu_Handler ( $Sender )
ProfileController_BeforeProfileOptions_Handler ( $Sender, $Args ) Add "Ignore" option to profile options.
ProfileController_Ignore_Create ( ProfileController $Sender ) Profile settings
ProfileController_Render_Before ( $Sender )
SimpleApiPlugin_Mapper_Handler ( SimpleApiPlugin $Sender ) Add mapper methods
UserController_IgnoreList_Create ( UserController $Sender )
UserController_Ignore_Create ( Controller $Sender )
__construct ( )
ignoreIsRestricted ( integer | null $userID = NULL ) : boolean | string Is this user forbidden from using ignore?

Protected Methods

Method Description
AddIgnore ( $ForUserID, $IgnoreUserID )
GetUserInfo ( $UserReference = '', $Username = '', $UserID = '' )
RemoveIgnore ( $ForUserID, $IgnoreUserID )

Method Details

AddIgnore() protected method

protected AddIgnore ( $ForUserID, $IgnoreUserID )

AssetModel_StyleCss_Handler() public method

public AssetModel_StyleCss_Handler ( $Sender )

Controller_Add() public method

* API METHODS
public Controller_Add ( $Sender )

Controller_Index() public method

public Controller_Index ( $Sender )

Controller_Remove() public method

public Controller_Remove ( $Sender )

Controller_Restrict() public method

public Controller_Restrict ( $Sender )

DiscussionController_BeforeCommentDisplay_Handler() public method

public DiscussionController_BeforeCommentDisplay_Handler ( $Sender )

DiscussionController_BeforeDiscussionRender_Handler() public method

public DiscussionController_BeforeDiscussionRender_Handler ( $Sender )

GetUserInfo() protected method

protected GetUserInfo ( $UserReference = '', $Username = '', $UserID = '' )

IgnoreConversations() public method

public IgnoreConversations ( $IgnoreUserID, $SessionUserID = NULL )

IgnoreRestricted() public method

public IgnoreRestricted ( $UserID, $SessionUserID = NULL )

Ignored() public method

public Ignored ( $UserID = NULL, $SessionUserID = NULL )

MessagesController_BeforeAddConversation_Handler() public method

public MessagesController_BeforeAddConversation_Handler ( MessageController $Sender )
$Sender MessageController

MessagesController_BeforeAddMessage_Handler() public method

Add a new message to a conversation.
public MessagesController_BeforeAddMessage_Handler ( MessageController $Sender )
$Sender MessageController

ProfileController_AfterAddSideMenu_Handler() public method

public ProfileController_AfterAddSideMenu_Handler ( $Sender )

ProfileController_BeforeProfileOptions_Handler() public method

Add "Ignore" option to profile options.
public ProfileController_BeforeProfileOptions_Handler ( $Sender, $Args )

ProfileController_Ignore_Create() public method

Profile settings
public ProfileController_Ignore_Create ( ProfileController $Sender )
$Sender ProfileController

ProfileController_Render_Before() public method

public ProfileController_Render_Before ( $Sender )

RemoveIgnore() protected method

protected RemoveIgnore ( $ForUserID, $IgnoreUserID )

SimpleApiPlugin_Mapper_Handler() public method

Add mapper methods
public SimpleApiPlugin_Mapper_Handler ( SimpleApiPlugin $Sender )
$Sender SimpleApiPlugin

UserController_IgnoreList_Create() public method

public UserController_IgnoreList_Create ( UserController $Sender )
$Sender UserController

UserController_Ignore_Create() public method

public UserController_Ignore_Create ( Controller $Sender )
$Sender Controller

__construct() public method

public __construct ( )

ignoreIsRestricted() public method

Is this user forbidden from using ignore?
public ignoreIsRestricted ( integer | null $userID = NULL ) : boolean | string
$userID integer | null ID for the user to verify ignore permissions for. Current user if none specified.
return boolean | string IgnorePlugin::IGNORE_RESTRICTED if user cannot ignore, otherwise false.

Property Details

$allowModeratorIgnore public property

public $allowModeratorIgnore