• Главная
• Gdn_PluginManager

PHP Класс Gdn_PluginManager, vanilla

A singleton class used to identify extensions, register them in a central location, and instantiate/call them when necessary. Показать файл Открыть проект Примеры использования класса

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

Свойство	Тип	Описание
$trace		Whether or not to trace some event information.

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

Свойство	Тип	Описание
$alternatePluginSearchPaths
$enabledPlugins		A simple list of enabled plugins.
$instances		An array of the instances of plugins.
$pluginCache		Available plugins. Never access this directly, instead use $this->AvailablePlugins();
$pluginFoldersByPath	array
$pluginSearchPaths		Search paths for plugins and their files.
$pluginsByClass	array

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

Метод	Описание
__construct ( AddonManager $addonManager = null )	Initialize a new instance of the {@link Gdn_PluginManager} class.
addSearchPath ( ) : boolean	TODO: Remove this.
availablePluginFolders ( null $SearchPath = null ) : array | mixed
availablePlugins ( )	Get a list of available plugins.
calcOldInfoArray ( Addon $addon ) : array	Calculate an old info array from a new {@link Addon}.
callEventHandler ( object $Sender, string $EventClassName, string $EventName, string $EventHandlerType = 'Handler', array $Options = [] ) : mixed	Call a single event handler.
callEventHandlers ( object $Sender, string $EventClassName, string $EventName, string $EventHandlerType = 'Handler' ) : boolean	Transfer control to the plugins.
callMethodOverride ( object $Sender, string $ClassName, string $MethodName ) : mixed	Looks through $this->_MethodOverrideCollection for a matching method signature to override.
callNewMethod ( object $Sender, string $ClassName, string $MethodName ) : mixed	Looks through the registered new methods for a matching method signature to call.
checkPlugin ( string $pluginName ) : boolean	Check whether a plugin is enabled.
clearPluginCache ( )	The {@link AddonManager} does all this now.
disablePlugin ( string $pluginName ) : boolean	Disable a plugin.
enablePlugin ( $pluginName, Gdn_Validation $validation, boolean $setup = true ) : boolean
enabledPluginFolders ( null $SearchPath = null ) : array
enabledPlugins ( ) : array	Get a list of all of the enabled plugins.
findPluginFile ( string $path ) : string | false	Deprecated.
forceAutoloaderIndex ( )	The {@link AddonManager} does all this now.
getCallback ( string $ClassName, string $MethodName, string $Type = 'Create' ) : callback	Get the callback for an event handler.
getEventHandlers ( $Sender, $EventName, string $HandlerType = 'Handler', array $Options = [] ) : array
getPluginInfo ( string $name, string $accessType = self::ACCESS_PLUGINNAME ) : boolean | array	Get the information array for a plugin.
getPluginInstance ( string $name, string $accessType = self::ACCESS_CLASSNAME, mixed $sender = null ) : Gdn_IPlugin	Gets an instance of a given plugin.
hasMethodOverride ( string $ClassName, string $MethodName ) : boolean	Checks to see if there are any plugins that override the method being executed.
hasNewMethod ( string $ClassName, string $MethodName ) : boolean	Checks to see if there are any plugins that create the method being executed.
includePlugins ( )	Includes all of the plugin files for enabled plugins.
indexSearchPath ( string $SearchPath, &$PluginInfo, &$ClassInfo, array | null $PathListing = null ) : boolean | string	TODO: Remove this method.
isEnabled ( string $Name ) : boolean	Returns whether or not a plugin is enabled.
registerCallback ( string $eventName, callable $callback )	Register a a callback to handle an event.
registerHandler ( string $HandlerClassName, string $HandlerMethodName, string $EventClassName = '', string $EventName = '', string $EventHandlerType = '' )	Registers a plugin method name as a handler.
registerNewMethod ( string $NewMethodClassName, string $NewMethodName, string $EventClassName = '', string $EventName = '' )	Registers a plugin new method.
registerOverride ( string $OverrideClassName, string $OverrideMethodName, string $EventClassName = '', string $EventName = '' )	Registers a plugin override method.
registerPlugin ( $ClassName )
registerPlugins ( )	Register all enabled plugins' event handlers and overrides.
registeredPlugins ( ) : array
removeMobileUnfriendlyPlugins ( )	Removes all plugins that are marked as mobile unfriendly.
removeSearchPath ( ) : boolean	TODO: Remove this.
scanPluginFile ( $PluginFile, null $VariableName = null ) : null | void
searchPaths ( boolean $OnlyCustom = false ) : array	Get the current search paths
splitAuthors ( string $authorsString, string $format = 'html' ) : array | string	Split a string containing several authors.
start ( )	Set up the plugin framework.
started ( ) : boolean	Is the plugin manager started?
testPlugin ( string $PluginName )	Test to see if a plugin throws fatal errors.
unregisterPlugin ( $PluginClassName ) : boolean

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

Метод	Описание
enableAddon ( Addon $addon, boolean $setup )	Enable an addon and do all the stuff that's entailed there.
findPluginFileOld ( string $path ) : string | false	Find a plugin file using the old plugin manager method.
pluginHook ( string $pluginName, string $forAction, boolean $callback = false ) : void	Hooks to the various actions, i.e. enable, disable and load.
removeFromCollectionByPrefix ( $Prefix, &$Collection )
trace ( string $Message, string $Type = TRACE_INFO )	Trace a message when tracing is turned on.

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

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