PHP Класс PocketsPlugin, addons

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

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

Свойство Тип Описание
$Locations array
$TestMode Whether or not to display test items for all pockets.

Защищенные свойства (Protected)

Свойство Тип Описание
$StateLoaded boolean
$_Counters Counters for the various locations.
$_PocketNames array
$_Pockets All of the pockets indexed by location.

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

Метод Описание
__construct ( ) PocketsPlugin constructor.
addPocket ( Pocket $Pocket ) Add a pocket to the plugin's array of pockets to process.
base_BeforeRenderAsset_Handler ( $Sender )
base_GetAppSettingsMenuItems_Handler ( $Sender ) Adds "Media" menu option to the Forum menu on the dashboard.
base_afterRenderAsset_handler ( $Sender )
base_beforeCommentDisplay_handler ( $Sender )
base_betweenDiscussion_handler ( $Sender )
base_betweenRenderAsset_handler ( $Sender )
base_render_before ( $Sender ) Add test mode to every page.
getLocationsArray ( ) : array
getPockets ( $Name ) : mixed
pocketString ( $Name, null $Data = null ) : mixed | string
pocketStringCb ( null $Match = null, boolean | false $SetArgs = false ) : string
processPockets ( $Sender, $Location, null $CountHint = null )
settingsController_pockets_create ( $Sender, array $Args = [] ) : mixed Main list for a pocket management.
setup ( ) Runs on enable.
structure ( ) Runs on utility/update.
testData ( $Sender ) derp?

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

Метод Описание
_Edit ( $Sender, $PocketID ) : mixed
_add ( $Sender ) : mixed
_addEdit ( $Sender, boolean | false $PocketID = false ) : mixed
_delete ( $Sender, $PocketID ) : boolean
_index ( $Sender, $Args )
_loadState ( boolean | false $Force = false )
_saveState ( ) derp?
_var ( $Name, $Value ) : string

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

_Edit() защищенный Метод

protected _Edit ( $Sender, $PocketID ) : mixed
$Sender
$PocketID
Результат mixed

__construct() публичный Метод

PocketsPlugin constructor.
public __construct ( )

_add() защищенный Метод

protected _add ( $Sender ) : mixed
$Sender
Результат mixed

_addEdit() защищенный Метод

protected _addEdit ( $Sender, boolean | false $PocketID = false ) : mixed
$Sender
$PocketID boolean | false
Результат mixed

_delete() защищенный Метод

protected _delete ( $Sender, $PocketID ) : boolean
$Sender
$PocketID
Результат boolean

_index() защищенный Метод

protected _index ( $Sender, $Args )
$Sender
$Args

_loadState() защищенный Метод

protected _loadState ( boolean | false $Force = false )
$Force boolean | false

_saveState() защищенный Метод

derp?
protected _saveState ( )

_var() защищенный статический Метод

protected static _var ( $Name, $Value ) : string
$Name
$Value
Результат string

addPocket() публичный Метод

Add a pocket to the plugin's array of pockets to process.
public addPocket ( Pocket $Pocket )
$Pocket Pocket

base_BeforeRenderAsset_Handler() публичный Метод

public base_BeforeRenderAsset_Handler ( $Sender )
$Sender

base_GetAppSettingsMenuItems_Handler() публичный Метод

Adds "Media" menu option to the Forum menu on the dashboard.
public base_GetAppSettingsMenuItems_Handler ( $Sender )
$Sender

base_afterRenderAsset_handler() публичный Метод

public base_afterRenderAsset_handler ( $Sender )
$Sender

base_beforeCommentDisplay_handler() публичный Метод

public base_beforeCommentDisplay_handler ( $Sender )
$Sender

base_betweenDiscussion_handler() публичный Метод

public base_betweenDiscussion_handler ( $Sender )
$Sender

base_betweenRenderAsset_handler() публичный Метод

public base_betweenRenderAsset_handler ( $Sender )
$Sender

base_render_before() публичный Метод

Add test mode to every page.
public base_render_before ( $Sender )
$Sender

getLocationsArray() публичный Метод

public getLocationsArray ( ) : array
Результат array

getPockets() публичный Метод

public getPockets ( $Name ) : mixed
$Name
Результат mixed

pocketString() публичный статический Метод

public static pocketString ( $Name, null $Data = null ) : mixed | string
$Name
$Data null
Результат mixed | string

pocketStringCb() публичный статический Метод

public static pocketStringCb ( null $Match = null, boolean | false $SetArgs = false ) : string
$Match null
$SetArgs boolean | false
Результат string

processPockets() публичный Метод

public processPockets ( $Sender, $Location, null $CountHint = null )
$Sender
$Location
$CountHint null

settingsController_pockets_create() публичный Метод

Main list for a pocket management.
public settingsController_pockets_create ( $Sender, array $Args = [] ) : mixed
$Args array
Результат mixed

setup() публичный Метод

Runs on enable.
public setup ( )

structure() публичный Метод

Runs on utility/update.
public structure ( )

testData() публичный Метод

derp?
public testData ( $Sender )
$Sender

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

$Locations публичное свойство

public array $Locations
Результат array

$StateLoaded защищенное свойство

protected bool $StateLoaded
Результат boolean

$TestMode публичное свойство

Whether or not to display test items for all pockets.
public $TestMode

$_Counters защищенное свойство

Counters for the various locations.
protected $_Counters

$_PocketNames защищенное свойство

protected array $_PocketNames
Результат array

$_Pockets защищенное свойство

All of the pockets indexed by location.
protected $_Pockets