mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-23 03:25:18 +02:00
Code Issues Releases Wiki Activity

[ticket/11306] Add docblocks to all container related functions

Browse Source 
PHPBB3-11306
This commit is contained in:
Igor Wiedler
2013-01-02 06:41:20 +01:00
parent ea24de8de3
commit 21eb8d842b
1 changed files with 41 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
phpBB/includes/functions_container.php
View File

@ -105,6 +105,15 @@ function phpbb_create_compiled_container(array $extensions, array $passes, $phpb
return $container; return $container;
} }
/**
* Create a compiled and dumped ContainerBuilder object
*
* @param array $extensions Array of Container extension objects
* @param array $passes Array of Compiler Pass objects
* @param string $phpbb_root_path Root path
* @param string $php_ext PHP Extension
* @return ContainerBuilder object (compiled)
*/
function phpbb_create_dumped_container(array $extensions, array $passes, $phpbb_root_path, $php_ext) function phpbb_create_dumped_container(array $extensions, array $passes, $phpbb_root_path, $php_ext)
{ {
// Check for our cached container; if it exists, use it // Check for our cached container; if it exists, use it
@ -129,12 +138,37 @@ function phpbb_create_dumped_container(array $extensions, array $passes, $phpbb_
return $container; return $container;
} }
/**
* Create an environment-specific ContainerBuilder object
*
* If debug is enabled, the container is re-compiled every time.
* This ensures that the latest changes will always be reflected
* during development.
*
* Otherwise it will get the existing dumped container and use
* that one instead.
*
* @param array $extensions Array of Container extension objects
* @param array $passes Array of Compiler Pass objects
* @param string $phpbb_root_path Root path
* @param string $php_ext PHP Extension
* @return ContainerBuilder object (compiled)
*/
function phpbb_create_dumped_container_unless_debug(array $extensions, array $passes, $phpbb_root_path, $php_ext) function phpbb_create_dumped_container_unless_debug(array $extensions, array $passes, $phpbb_root_path, $php_ext)
{ {
$container_factory = defined('DEBUG') ? 'phpbb_create_compiled_container' : 'phpbb_create_dumped_container'; $container_factory = defined('DEBUG') ? 'phpbb_create_compiled_container' : 'phpbb_create_dumped_container';
return $container_factory($extensions, $passes, $phpbb_root_path, $php_ext); return $container_factory($extensions, $passes, $phpbb_root_path, $php_ext);
} }
/**
* Create a default ContainerBuilder object
*
* Contains the default configuration of the phpBB container.
*
* @param array $extensions Array of Container extension objects
* @param array $passes Array of Compiler Pass objects
* @return ContainerBuilder object (compiled)
*/
function phpbb_create_default_container($phpbb_root_path, $php_ext) function phpbb_create_default_container($phpbb_root_path, $php_ext)
{ {
return phpbb_create_dumped_container_unless_debug( return phpbb_create_dumped_container_unless_debug(
@ -151,6 +185,13 @@ function phpbb_create_default_container($phpbb_root_path, $php_ext)
); );
} }
/**
* Get the filename under which the dumped container will be stored.
*
* @param string $phpbb_root_path Root path
* @param string $php_ext PHP Extension
* @return Path for dumped container
*/
function phpbb_container_filename($phpbb_root_path, $php_ext) function phpbb_container_filename($phpbb_root_path, $php_ext)
{ {
$filename = str_replace(array('/', '.'), array('slash', 'dot'), $phpbb_root_path); $filename = str_replace(array('/', '.'), array('slash', 'dot'), $phpbb_root_path);