<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\extension;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* A base class for extensions without custom enable/disable/purge code.
*/
class base implements \phpbb\extension\extension_interface
{
/** @var ContainerInterface */
protected $container;
/** @var \phpbb\finder */
protected $extension_finder;
/** @var \phpbb\db\migrator */
protected $migrator;
/** @var string */
protected $extension_name;
/** @var string */
protected $extension_path;
/** @var string[] */
private $migrations = false;
/**
* 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
*/
public function __construct(ContainerInterface $container, \phpbb\finder $extension_finder, \phpbb\db\migrator $migrator, $extension_name, $extension_path)
{
$this->container = $container;
$this->extension_finder = $extension_finder;
$this->migrator = $migrator;
$this->extension_name = $extension_name;
$this->extension_path = $extension_path;
}
/**
* {@inheritdoc}
*/
public function is_enableable()
{
return true;
}
/**
* 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
*/
public function enable_step($old_state)
{
$this->get_migration_file_list();
$this->migrator->update();
return !$this->migrator->finished();
}
/**
* 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
*/
public function disable_step($old_state)
{
return false;
}
/**
* 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
*/
public function purge_step($old_state)
{
$migrations = $this->get_migration_file_list();
foreach ($migrations as $migration)
{
while ($this->migrator->migration_state($migration) !== false)
{
$this->migrator->revert($migration);
return true;
}
}
return false;
}
/**
* Get the list of migration files from this extension
*
* @return array
*/
protected function get_migration_file_list()
{
if ($this->migrations !== false)
{
return $this->migrations;
}
// Only have the finder search in this extension path directory
$migrations = $this->extension_finder
->extension_directory('/migrations')
->find_from_extension($this->extension_name, $this->extension_path);
$migrations = $this->extension_finder->get_classes_from_files($migrations);
$this->migrator->set_migrations($migrations);
$migrations = $this->migrator->get_migrations();
return $migrations;
}
}