*

*/

class phpbb_db_migration_tool_module implements phpbb_db_migration_tool_interface

{

/** @var phpbb_cache_service */

/** @var dbal */

/** @var phpbb_user */

/** @var string */

/** @var string */

/** @var string */

{

$this->db = $db;

$this->cache = $cache;

* @param string $class The module class(acp|mcp|ucp)

* @param int|string|bool $parent The parent module_id|module_langname (0 for no parent). Use false to ignore the parent check and check class wide.

* @param int|string $module The module_id|module_langname you would like to check for to see if it exists

* @return bool true/false if module exists

*/

public function exists($class, $parent, $module)

return true;

}

$parent_sql = '';

if ($parent !== false)

{

// Allows '' to be sent as 0

if (!is_numeric($parent))

{

$sql = 'SELECT module_id

FROM ' . $this->modules_table . "

WHERE module_langname = '" . $this->db->sql_escape($parent) . "'

$result = $this->db->sql_query($sql);

$this->db->sql_freeresult($result);

{

return false;

}

}

else

{

$sql = 'SELECT module_id

FROM ' . $this->modules_table . "

$parent_sql

$result = $this->db->sql_query($sql);

$this->db->sql_freeresult($result);

{

return true;

}

* @param array $data an array of the data on the new module. This can be setup in two different ways.

* 1. The "manual" way. For inserting a category or one at a time. It will be merged with the base array shown a bit below,

* but at the least requires 'module_langname' to be sent, and, if you want to create a module (instead of just a category) you must send module_basename and module_mode.

* 2. The "automatic" way. For inserting multiple at a time based on the specs in the info file for the module(s). For this to work the modules must be correctly setup in the info file.

* An example follows (this would insert the settings, log, and flag modes from the includes/acp/info/acp_asacp.php file):

* Optionally you may not send 'modes' and it will insert all of the modules in that info file.

*/

public function add($class, $parent = 0, $data = array(), $include_path = false)

{

// allow sending the name as a string in $data to create a category

if (!is_array($data))

if (!isset($data['module_langname']))

{

// The "automatic" way

$basename = (isset($data['module_basename'])) ? $data['module_basename'] : '';

$basename = str_replace(array('/', '\\'), '', $basename);

$class = str_replace(array('/', '\\'), '', $class);

$info_file = "$class/info/$basename.{$this->php_ext}";

// The manual and automatic ways both failed...

{

throw new phpbb_db_migration_exception('MODULE_INFO_FILE_NOT_EXIST', $class, $info_file);

}

if (!class_exists($classname))

{

}

$info = new $classname;

}

// The "manual" way

if (!is_numeric($parent))

{

$sql = 'SELECT module_id

FROM ' . $this->modules_table . "

WHERE module_langname = '" . $this->db->sql_escape($parent) . "'

$result = $this->db->sql_query($sql);

$this->db->sql_freeresult($result);

{

throw new phpbb_db_migration_exception('MODULE_PARENT_NOT_EXIST', $parent);

}

}

else if (!$this->exists($class, false, $parent))

{

if (isset($data['before']) && $data['before'])

{

$sql = 'SELECT left_id

$this->db->sql_query($sql);

$sql = 'UPDATE ' . $this->modules_table . "

SET left_id = left_id + 2, right_id = right_id + 2

AND left_id >= $to_left

AND left_id < {$module_data['left_id']}";

$this->db->sql_query($sql);

$sql = 'UPDATE ' . $this->modules_table . "

SET left_id = $to_left, right_id = " . ($to_left + 1) . "

AND module_id = {$module_data['module_id']}";

$this->db->sql_query($sql);

}

else if (isset($data['after']) && $data['after'])

{

$sql = 'SELECT right_id

$this->db->sql_query($sql);

$sql = 'UPDATE ' . $this->modules_table . "

SET left_id = left_id + 2, right_id = right_id + 2

AND left_id >= $to_right

AND left_id < {$module_data['left_id']}";

$this->db->sql_query($sql);

$sql = 'UPDATE ' . $this->modules_table . '

SET left_id = ' . ($to_right + 1) . ', right_id = ' . ($to_right + 2) . "

AND module_id = {$module_data['module_id']}";

$this->db->sql_query($sql);

}

// Clear the Modules Cache

$this->cache->destroy("_modules_$class");

}

/**

* @param int|string|bool $parent The parent module_id|module_langname (0 for no parent). Use false to ignore the parent check and check class wide.

* @param int|string $module The module id|module_langname

* @param string|bool $include_path If you would like to use a custom include path, specify that here

*/

public function remove($class, $parent = 0, $module = '', $include_path = false)

{

// Automatic method

$basename = str_replace(array('/', '\\'), '', $module['module_basename']);

$class = str_replace(array('/', '\\'), '', $class);

$info_file = "$class/info/$basename.{$this->php_ext}";

{

throw new phpbb_db_migration_exception('MODULE_NOT_EXIST', $info_file);

}

if (!class_exists($classname))

{

}

$info = new $classname;

$this->remove($class, $parent, $info['title']) . '<br />';

}

}

}

else

{

if (!$this->exists($class, $parent, $module))

{

throw new phpbb_db_migration_exception('MODULE_NOT_EXIST', ((isset($this->user->lang[$module])) ? $this->user->lang[$module] : $module));

if ($parent !== false)

{

// Allows '' to be sent as 0

if (!is_numeric($parent))

{

$sql = 'SELECT module_id

FROM ' . $this->modules_table . "

WHERE module_langname = '" . $this->db->sql_escape($parent) . "'

$result = $this->db->sql_query($sql);

$this->db->sql_freeresult($result);

// we know it exists from the module_exists check

}

else

{

$module_ids = array();

if (!is_numeric($module))

{

$sql = 'SELECT module_id

FROM ' . $this->modules_table . "

$result = $this->db->sql_query($sql);

{

}

$this->db->sql_freeresult($result);

$sql = 'SELECT module_langname

FROM ' . $this->modules_table . "

WHERE module_id = $module

$result = $this->db->sql_query($sql);

$this->db->sql_freeresult($result);

$module_ids[] = $module;

}

}

$this->cache->destroy("_modules_$class");

}

}

}