PHP Класс Grav\Plugin\AdminPlugin

Наследование: extends Grav\Common\Plugin
Показать файл Открыть проект

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

Свойство Тип Описание
$features

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

Свойство Тип Описание
$active boolean
$admin Grav\Plugin\Admin\Admin
$admin_route string
$base string
$popularity Grav\Plugin\Admin\Popularity
$route string
$session RocketTheme\Toolbox\Session\Session
$template string
$theme string
$uri Grav\Common\Uri
$version

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

Метод Описание
getFormFieldTypes ( ) : array Get list of form field types specified in this plugin. Only special types needs to be listed.
getSubscribedEvents ( ) : array
isAdminPath ( ) : boolean Check if the current route is under the admin path
onAdminDashboard ( )
onAdminRegisterPermissions ( RocketTheme\Toolbox\Event\Event $e ) Initial stab at registering permissions (WIP)
onAssetsInitialized ( ) Handles initializing the assets
onFormProcessed ( RocketTheme\Toolbox\Event\Event $event ) Process the admin registration form.
onOutputGenerated ( )
onPagesInitialized ( ) Sets longer path to the home page allowing us to have list of pages when we enter to pages section.
onPluginsInitialized ( ) If the admin plugin is set as active, initialize the admin
onShutdown ( ) Handles the shutdown
onTaskGPM ( ) Handles getting GPM updates
onTwigExtensions ( ) Add the Admin Twig Extensions
onTwigSiteVariables ( ) Set all twig variables for generating output.
onTwigTemplatePaths ( ) Add twig paths to plugin templates.
setup ( ) If the admin path matches, initialize the Login plugin configuration and set the admin as active.

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

Метод Описание
initializeAdmin ( ) Initialize the admin.
initializeController ( $task, $post )
validate ( string $type, string $value, string $extra = '' ) : boolean Validate a value. Currently validates

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

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

Get list of form field types specified in this plugin. Only special types needs to be listed.
public getFormFieldTypes ( ) : array
Результат array

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

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

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

Initialize the admin.
protected initializeAdmin ( )

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

protected initializeController ( $task, $post )

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

Check if the current route is under the admin path
public isAdminPath ( ) : boolean
Результат boolean

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

public onAdminDashboard ( )

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

Initial stab at registering permissions (WIP)
public onAdminRegisterPermissions ( RocketTheme\Toolbox\Event\Event $e )
$e RocketTheme\Toolbox\Event\Event

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

Handles initializing the assets
public onAssetsInitialized ( )

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

Process the admin registration form.
public onFormProcessed ( RocketTheme\Toolbox\Event\Event $event )
$event RocketTheme\Toolbox\Event\Event

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

public onOutputGenerated ( )

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

Sets longer path to the home page allowing us to have list of pages when we enter to pages section.
public onPagesInitialized ( )

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

If the admin plugin is set as active, initialize the admin
public onPluginsInitialized ( )

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

Handles the shutdown
public onShutdown ( )

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

Handles getting GPM updates
public onTaskGPM ( )

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

Add the Admin Twig Extensions
public onTwigExtensions ( )

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

Set all twig variables for generating output.
public onTwigSiteVariables ( )

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

Add twig paths to plugin templates.
public onTwigTemplatePaths ( )

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

If the admin path matches, initialize the Login plugin configuration and set the admin as active.
public setup ( )

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

- 'user' for username format and username availability. - 'password1' for password format - 'password2' for equality to password1
protected validate ( string $type, string $value, string $extra = '' ) : boolean
$type string The field type
$value string The field value
$extra string Any extra value required
Результат boolean

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

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

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

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

protected Admin,Grav\Plugin\Admin $admin
Результат Grav\Plugin\Admin\Admin

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

protected string $admin_route
Результат string

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

protected string $base
Результат string

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

public $features

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

protected Popularity,Grav\Plugin\Admin $popularity
Результат Grav\Plugin\Admin\Popularity

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

protected string $route
Результат string

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

protected Session,RocketTheme\Toolbox\Session $session
Результат RocketTheme\Toolbox\Session\Session

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

protected string $template
Результат string

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

protected string $theme
Результат string

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

protected Uri,Grav\Common $uri
Результат Grav\Common\Uri

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

protected $version