diff options
| author | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
|---|---|---|
| committer | Andy Chase <asperous2@gmail.com> | 2013-07-22 11:29:36 -0700 |
| commit | e2a769ac79ad408e94935c97a5fc1325fb838c4f (patch) | |
| tree | 5f56bbc9d9290f49a6c88987561f345df49f8a3c /phpBB/phpbb/extension/interface.php | |
| parent | cc1aef47fb4f5d37415436c62067ad2dcde768bb (diff) | |
| parent | b71038486e067daf0c608d73aabeb60a56e86840 (diff) | |
| download | forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.gz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.bz2 forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.tar.xz forums-e2a769ac79ad408e94935c97a5fc1325fb838c4f.zip | |
Merge branch 'develop' into ticket/11620
Diffstat (limited to 'phpBB/phpbb/extension/interface.php')
| -rw-r--r-- | phpBB/phpbb/extension/interface.php | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/phpBB/phpbb/extension/interface.php b/phpBB/phpbb/extension/interface.php new file mode 100644 index 0000000000..7b36a12bf6 --- /dev/null +++ b/phpBB/phpbb/extension/interface.php @@ -0,0 +1,67 @@ +<?php +/** +* +* @package extension +* @copyright (c) 2011 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* The interface extension meta classes have to implement to run custom code +* on enable/disable/purge. +* +* @package extension +*/ +interface phpbb_extension_interface +{ + /** + * enable_step is executed on enabling an extension until it returns false. + * + * Calls to this function can be made in subsequent requests, when the + * function is invoked through a webserver with a too low max_execution_time. + * + * @param mixed $old_state The return value of the previous call + * of this method, or false on the first call + * @return mixed Returns false after last step, otherwise + * temporary state which is passed as an + * argument to the next step + */ + public function enable_step($old_state); + + /** + * Disables the extension. + * + * Calls to this function can be made in subsequent requests, when the + * function is invoked through a webserver with a too low max_execution_time. + * + * @param mixed $old_state The return value of the previous call + * of this method, or false on the first call + * @return mixed Returns false after last step, otherwise + * temporary state which is passed as an + * argument to the next step + */ + public function disable_step($old_state); + + /** + * purge_step is executed on purging an extension until it returns false. + * + * Calls to this function can be made in subsequent requests, when the + * function is invoked through a webserver with a too low max_execution_time. + * + * @param mixed $old_state The return value of the previous call + * of this method, or false on the first call + * @return mixed Returns false after last step, otherwise + * temporary state which is passed as an + * argument to the next step + */ + public function purge_step($old_state); +} |