[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/phpbb/extension/ -> base.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: 142 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

base:: (6 methods):
  __construct()
  is_enableable()
  enable_step()
  disable_step()
  purge_step()
  get_migration_file_list()


Class: base  - X-Ref

A base class for extensions without custom enable/disable/purge code.

__construct(ContainerInterface $container, \phpbb\finder $extension_finder, \phpbb\db\migrator $migrator, $extension_name, $extension_path)   X-Ref
Constructor

param: ContainerInterface $container Container object
param: \phpbb\finder $extension_finder
param: \phpbb\db\migrator $migrator
param: string $extension_name Name of this extension (from ext.manager)
param: string $extension_path Relative path to this extension

is_enableable()   X-Ref
{@inheritdoc}


enable_step($old_state)   X-Ref
Single enable step that installs any included migrations

param: mixed $old_state State returned by previous call of this method
return: false Indicates no further steps are required

disable_step($old_state)   X-Ref
Single disable step that does nothing

param: mixed $old_state State returned by previous call of this method
return: false Indicates no further steps are required

purge_step($old_state)   X-Ref
Single purge step that reverts any included and installed migrations

param: mixed $old_state State returned by previous call of this method
return: false Indicates no further steps are required

get_migration_file_list()   X-Ref
Get the list of migration files from this extension

return: array



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1