PHPXRef 0.7.1 : phpBB-3.1.12-deutsch : Detail view of manager.php

The extension manager provides means to activate/deactivate extensions.

__construct(ContainerInterface $container, \phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\filesystem $filesystem, \phpbb\user $user, $extension_table, $phpbb_root_path, $php_ext = 'php', \phpbb\cache\driver\driver_interface $cache = null, $cache_name = '_ext') X-Ref

Creates a manager and loads information from database

param: ContainerInterface $container A container
param: \phpbb\db\driver\driver_interface $db A database connection
param: \phpbb\config\config $config Config object
param: \phpbb\filesystem $filesystem
param: \phpbb\user $user User object
param: string $extension_table The name of the table holding extensions
param: string $phpbb_root_path Path to the phpbb includes directory.
param: string $php_ext php file extension, defaults to php
param: \phpbb\cache\driver\driver_interface $cache A cache instance or null
param: string $cache_name The name of the cache variable, defaults to _ext

load_extensions() X-Ref

Loads all extension information from the database

return: null

get_extension_path($name, $phpbb_relative = false) X-Ref

Generates the path to an extension

param: string $name The name of the extension
param: bool $phpbb_relative Whether the path should be relative to phpbb root
return: string Path to an extension

get_extension($name) X-Ref

Instantiates the extension meta class for the extension with the given name

param: string $name The extension name
return: \phpbb\extension\extension_interface Instance of the extension meta class or

create_extension_metadata_manager($name, \phpbb\template\template $template = null) X-Ref

Instantiates the metadata manager for the extension with the given name

param: string $name The extension name
param: \phpbb\template\template $template The template manager or null
return: \phpbb\extension\metadata_manager Instance of the metadata manager

enable_step($name) X-Ref

Runs a step of the extension enabling process.

Allows the exentension to enable in a long running script that works
in multiple steps across requests. State is kept for the extension
in the extensions table.

param: string $name The extension's name
return: bool False if enabling is finished, true otherwise

enable($name) X-Ref

Enables an extension

This method completely enables an extension. But it could be long running
so never call this in a script that has a max_execution time.

param: string $name The extension's name
return: null

disable_step($name) X-Ref

Disables an extension

Calls the disable method on the extension's meta class to allow it to
process the event.

param: string $name The extension's name
return: bool False if disabling is finished, true otherwise

disable($name) X-Ref

Disables an extension

Disables an extension completely at once. This process could run for a
while so never call this in a script that has a max_execution time.

param: string $name The extension's name
return: null

purge_step($name) X-Ref

Purge an extension

Disables the extension first if active, and then calls purge on the
extension's meta class to delete the extension's database content.

param: string $name The extension's name
return: bool False if purging is finished, true otherwise

purge($name) X-Ref

Purge an extension

Purges an extension completely at once. This process could run for a while
so never call this in a script that has a max_execution time.

param: string $name The extension's name
return: null

all_available() X-Ref

Retrieves a list of all available extensions on the filesystem

return: array An array with extension names as keys and paths to the

all_configured() X-Ref

Retrieves all configured extensions.

All enabled and disabled extensions are considered configured. A purged
extension that is no longer in the database is not configured.

return: array An array with extension names as keys and and the

all_enabled() X-Ref

Retrieves all enabled extensions.

return: array An array with extension names as keys and and the

all_disabled() X-Ref

Retrieves all disabled extensions.

return: array An array with extension names as keys and and the

is_available($name) X-Ref

Check to see if a given extension is available on the filesystem

param: string $name Extension name to check NOTE: Can be user input
return: bool Depending on whether or not the extension is available

is_enabled($name) X-Ref

Check to see if a given extension is enabled

param: string $name Extension name to check
return: bool Depending on whether or not the extension is enabled

is_disabled($name) X-Ref

Check to see if a given extension is disabled

param: string $name Extension name to check
return: bool Depending on whether or not the extension is disabled

is_configured($name) X-Ref

Check to see if a given extension is configured

All enabled and disabled extensions are considered configured. A purged
extension that is no longer in the database is not configured.

param: string $name Extension name to check
return: bool Depending on whether or not the extension is configured

is_purged($name) X-Ref

Check to see if a given extension is purged

An extension is purged if it is available, not enabled and not disabled.

param: string $name Extension name to check
return: bool Depending on whether or not the extension is purged

get_finder($use_all_available = false) X-Ref

Instantiates a \phpbb\finder.

param: bool $use_all_available Should we load all extensions, or just enabled ones
return: \phpbb\finder An extension finder instance

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	592 lines (16 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of phpBB-3.1.12-deutsch

/phpbb/extension/ -> manager.php (summary)

Defines 1 class