[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/phpbb/db/migration/tool/ -> module.php (summary)

This file is part of the phpBB Forum Software package.

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

Defines 1 class

module:: (9 methods):
  __construct()
  get_name()
  exists()
  add()
  remove()
  reverse()
  get_module_info()
  get_categories_list()
  get_parent_module_id()


Class: module  - X-Ref

Migration module management tool

__construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, \phpbb\user $user, \phpbb\module\module_manager $module_manager, $phpbb_root_path, $php_ext, $modules_table)   X-Ref
Constructor

param: \phpbb\db\driver\driver_interface $db
param: \phpbb\cache\service $cache
param: \phpbb\user $user
param: \phpbb\module\module_manager    $module_manager
param: string $phpbb_root_path
param: string $php_ext
param: string $modules_table

get_name()   X-Ref
{@inheritdoc}


exists($class, $parent, $module, $lazy = false)   X-Ref
Module Exists

Check if a module exists

param: string $class The module class(acp|mcp|ucp)
param: int|string|bool $parent The parent module_id|module_langname (0 for no parent).
param: int|string $module The module_id|module_langname you would like to
param: bool $lazy Checks lazily if the module exists. Returns true if it exists in at
return: bool true if module exists in *all* given parents, false if not in any given parent;

add($class, $parent = 0, $data = array()   X-Ref
Module Add

Add a new module

param: string $class The module class(acp|mcp|ucp)
param: int|string $parent The parent module_id|module_langname (0 for no parent)
param: array $data an array of the data on the new \module.
return: null

remove($class, $parent = 0, $module = '')   X-Ref
Module Remove

Remove a module

param: string $class The module class(acp|mcp|ucp)
param: int|string|bool $parent The parent module_id|module_langname(0 for no parent).
param: int|string $module The module id|module_langname
return: null

reverse()   X-Ref
{@inheritdoc}


get_module_info($class, $basename)   X-Ref
Wrapper for \acp_modules::get_module_infos()

param: string $class Module Class
param: string $basename Module Basename
return: array Module Information

get_categories_list()   X-Ref
Get the list of installed module categories
key - module_id
value - module_langname

return: null

get_parent_module_id($parent_id, $data = '', $throw_exception = true)   X-Ref
Get parent module id

param: string|int $parent_id The parent module_id|module_langname
param: int|string|array $data The module_id, module_langname for existance checking or module data array for adding
param: bool $throw_exception The flag indicating if exception should be thrown on error
return: mixed The int parent module_id, an array of int parent module_id values or false



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1