mirror of
https://github.com/phpbb/phpbb.git
synced 2025-08-07 01:06:48 +02:00
Merge branch 'develop' of git://github.com/phpbb/phpbb3 into ticket/11103
Conflicts: phpBB/config/services.yml phpBB/index.php
This commit is contained in:
3
phpBB/includes/cache/driver/file.php
vendored
3
phpBB/includes/cache/driver/file.php
vendored
@@ -214,7 +214,8 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
|
||||
|
||||
while (($entry = readdir($dir)) !== false)
|
||||
{
|
||||
if (strpos($entry, 'container') !== 0 &&
|
||||
if (strpos($entry, 'container_') !== 0 &&
|
||||
strpos($entry, 'url_matcher') !== 0 &&
|
||||
strpos($entry, 'sql_') !== 0 &&
|
||||
strpos($entry, 'data_') !== 0 &&
|
||||
strpos($entry, 'ctpl_') !== 0 &&
|
||||
|
3
phpBB/includes/cache/driver/memory.php
vendored
3
phpBB/includes/cache/driver/memory.php
vendored
@@ -162,7 +162,8 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base
|
||||
|
||||
while (($entry = readdir($dir)) !== false)
|
||||
{
|
||||
if (strpos($entry, 'container') !== 0 &&
|
||||
if (strpos($entry, 'container_') !== 0 &&
|
||||
strpos($entry, 'url_matcher') !== 0 &&
|
||||
strpos($entry, 'sql_') !== 0 &&
|
||||
strpos($entry, 'data_') !== 0 &&
|
||||
strpos($entry, 'ctpl_') !== 0 &&
|
||||
|
24
phpBB/includes/controller/exception.php
Normal file
24
phpBB/includes/controller/exception.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package controller
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Controller exception class
|
||||
* @package phpBB3
|
||||
*/
|
||||
class phpbb_controller_exception extends RuntimeException
|
||||
{
|
||||
}
|
117
phpBB/includes/controller/helper.php
Normal file
117
phpBB/includes/controller/helper.php
Normal file
@@ -0,0 +1,117 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package controller
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
|
||||
/**
|
||||
* Controller helper class, contains methods that do things for controllers
|
||||
* @package phpBB3
|
||||
*/
|
||||
class phpbb_controller_helper
|
||||
{
|
||||
/**
|
||||
* Template object
|
||||
* @var phpbb_template
|
||||
*/
|
||||
protected $template;
|
||||
|
||||
/**
|
||||
* User object
|
||||
* @var phpbb_user
|
||||
*/
|
||||
protected $user;
|
||||
|
||||
/**
|
||||
* phpBB root path
|
||||
* @var string
|
||||
*/
|
||||
protected $phpbb_root_path;
|
||||
|
||||
/**
|
||||
* PHP extension
|
||||
* @var string
|
||||
*/
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param phpbb_template $template Template object
|
||||
* @param phpbb_user $user User object
|
||||
* @param string $phpbb_root_path phpBB root path
|
||||
* @param string $php_ext PHP extension
|
||||
*/
|
||||
public function __construct(phpbb_template $template, phpbb_user $user, $phpbb_root_path, $php_ext)
|
||||
{
|
||||
$this->template = $template;
|
||||
$this->user = $user;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Automate setting up the page and creating the response object.
|
||||
*
|
||||
* @param string $handle The template handle to render
|
||||
* @param string $page_title The title of the page to output
|
||||
* @param int $status_code The status code to be sent to the page header
|
||||
* @return Response object containing rendered page
|
||||
*/
|
||||
public function render($template_file, $page_title = '', $status_code = 200)
|
||||
{
|
||||
page_header($page_title);
|
||||
|
||||
$this->template->set_filenames(array(
|
||||
'body' => $template_file,
|
||||
));
|
||||
|
||||
page_footer(true, false, false);
|
||||
|
||||
return new Response($this->template->assign_display('body'), $status_code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Easily generate a URL
|
||||
*
|
||||
* @param array $url_parts Each array element is a 'folder'
|
||||
* i.e. array('my', 'ext') maps to ./app.php/my/ext
|
||||
* @param mixed $query The Query string, passed directly into the second
|
||||
* argument of append_sid()
|
||||
* @return string A URL that has already been run through append_sid()
|
||||
*/
|
||||
public function url(array $url_parts, $query = '')
|
||||
{
|
||||
return append_sid($this->phpbb_root_path . implode('/', $url_parts), $query);
|
||||
}
|
||||
|
||||
/**
|
||||
* Output an error, effectively the same thing as trigger_error
|
||||
*
|
||||
* @param string $message The error message
|
||||
* @param string $code The error code (e.g. 404, 500, 503, etc.)
|
||||
* @return Response A Reponse instance
|
||||
*/
|
||||
public function error($message, $code = 500)
|
||||
{
|
||||
$this->template->assign_vars(array(
|
||||
'MESSAGE_TEXT' => $message,
|
||||
'MESSAGE_TITLE' => $this->user->lang('INFORMATION'),
|
||||
));
|
||||
|
||||
return $this->render('message_body.html', $this->user->lang('INFORMATION'), $code);
|
||||
}
|
||||
}
|
82
phpBB/includes/controller/provider.php
Normal file
82
phpBB/includes/controller/provider.php
Normal file
@@ -0,0 +1,82 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package controller
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
use Symfony\Component\Routing\Loader\YamlFileLoader;
|
||||
use Symfony\Component\Config\FileLocator;
|
||||
|
||||
/**
|
||||
* Controller interface
|
||||
* @package phpBB3
|
||||
*/
|
||||
class phpbb_controller_provider
|
||||
{
|
||||
/**
|
||||
* YAML file(s) containing route information
|
||||
* @var array
|
||||
*/
|
||||
protected $routing_paths;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param array() $routing_paths Array of strings containing paths
|
||||
* to YAML files holding route information
|
||||
*/
|
||||
public function __construct($routing_paths = array())
|
||||
{
|
||||
$this->routing_paths = $routing_paths;
|
||||
}
|
||||
|
||||
/**
|
||||
* Locate paths containing routing files
|
||||
* This sets an internal property but does not return the paths.
|
||||
*
|
||||
* @return The current instance of this object for method chaining
|
||||
*/
|
||||
public function import_paths_from_finder(phpbb_extension_finder $finder)
|
||||
{
|
||||
// We hardcode the path to the core config directory
|
||||
// because the finder cannot find it
|
||||
$this->routing_paths = array_merge(array('config'), array_map('dirname', array_keys($finder
|
||||
->directory('config')
|
||||
->prefix('routing')
|
||||
->suffix('yml')
|
||||
->find()
|
||||
)));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of controllers and return it
|
||||
*
|
||||
* @param string $base_path Base path to prepend to file paths
|
||||
* @return array Array of controllers and their route information
|
||||
*/
|
||||
public function find($base_path = '')
|
||||
{
|
||||
$routes = new RouteCollection;
|
||||
foreach ($this->routing_paths as $path)
|
||||
{
|
||||
$loader = new YamlFileLoader(new FileLocator($base_path . $path));
|
||||
$routes->addCollection($loader->load('routing.yml'));
|
||||
}
|
||||
|
||||
return $routes;
|
||||
}
|
||||
}
|
128
phpBB/includes/controller/resolver.php
Normal file
128
phpBB/includes/controller/resolver.php
Normal file
@@ -0,0 +1,128 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package controller
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
|
||||
/**
|
||||
* Controller manager class
|
||||
* @package phpBB3
|
||||
*/
|
||||
class phpbb_controller_resolver implements ControllerResolverInterface
|
||||
{
|
||||
/**
|
||||
* User object
|
||||
* @var phpbb_user
|
||||
*/
|
||||
protected $user;
|
||||
|
||||
/**
|
||||
* ContainerInterface object
|
||||
* @var ContainerInterface
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param phpbb_user $user User Object
|
||||
* @param ContainerInterface $container ContainerInterface object
|
||||
*/
|
||||
public function __construct(phpbb_user $user, ContainerInterface $container)
|
||||
{
|
||||
$this->user = $user;
|
||||
$this->container = $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load a controller callable
|
||||
*
|
||||
* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
|
||||
* @return bool|Callable Callable or false
|
||||
* @throws phpbb_controller_exception
|
||||
*/
|
||||
public function getController(Request $request)
|
||||
{
|
||||
$controller = $request->attributes->get('_controller');
|
||||
|
||||
if (!$controller)
|
||||
{
|
||||
throw new phpbb_controller_exception($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
|
||||
}
|
||||
|
||||
// Require a method name along with the service name
|
||||
if (stripos($controller, ':') === false)
|
||||
{
|
||||
throw new phpbb_controller_exception($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
|
||||
}
|
||||
|
||||
list($service, $method) = explode(':', $controller);
|
||||
|
||||
if (!$this->container->has($service))
|
||||
{
|
||||
throw new phpbb_controller_exception($this->user->lang('CONTROLLER_SERVICE_UNDEFINED', $service));
|
||||
}
|
||||
|
||||
$controller_object = $this->container->get($service);
|
||||
|
||||
return array($controller_object, $method);
|
||||
}
|
||||
|
||||
/**
|
||||
* Dependencies should be specified in the service definition and can be
|
||||
* then accessed in __construct(). Arguments are sent through the URL path
|
||||
* and should match the parameters of the method you are using as your
|
||||
* controller.
|
||||
*
|
||||
* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
|
||||
* @param mixed $controller A callable (controller class, method)
|
||||
* @return bool False
|
||||
* @throws phpbb_controller_exception
|
||||
*/
|
||||
public function getArguments(Request $request, $controller)
|
||||
{
|
||||
// At this point, $controller contains the object and method name
|
||||
list($object, $method) = $controller;
|
||||
$mirror = new ReflectionMethod($object, $method);
|
||||
|
||||
$arguments = array();
|
||||
$parameters = $mirror->getParameters();
|
||||
$attributes = $request->attributes->all();
|
||||
foreach ($parameters as $param)
|
||||
{
|
||||
if (array_key_exists($param->name, $attributes))
|
||||
{
|
||||
$arguments[] = $attributes[$param->name];
|
||||
}
|
||||
else if ($param->getClass() && $param->getClass()->isInstance($request))
|
||||
{
|
||||
$arguments[] = $request;
|
||||
}
|
||||
else if ($param->isDefaultValueAvailable())
|
||||
{
|
||||
$arguments[] = $param->getDefaultValue();
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new phpbb_controller_exception($this->user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
|
||||
}
|
||||
}
|
||||
|
||||
return $arguments;
|
||||
}
|
||||
}
|
@@ -49,7 +49,7 @@ class phpbb_di_extension_ext extends Extension
|
||||
{
|
||||
if (file_exists($path . '/config/services.yml'))
|
||||
{
|
||||
$loader = new YamlFileLoader($container, new FileLocator(phpbb_real_path($path . '/config')));
|
||||
$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($path . '/config')));
|
||||
$loader->load('services.yml');
|
||||
}
|
||||
}
|
||||
|
68
phpBB/includes/di/pass/kernel_pass.php
Normal file
68
phpBB/includes/di/pass/kernel_pass.php
Normal file
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
|
||||
|
||||
class phpbb_di_pass_kernel_pass implements CompilerPassInterface
|
||||
{
|
||||
/**
|
||||
* Modify the container before it is passed to the rest of the code
|
||||
*
|
||||
* @param ContainerBuilder $container ContainerBuilder object
|
||||
* @return null
|
||||
*/
|
||||
public function process(ContainerBuilder $container)
|
||||
{
|
||||
$definition = $container->getDefinition('dispatcher');
|
||||
|
||||
foreach ($container->findTaggedServiceIds('kernel.event_listener') as $id => $events)
|
||||
{
|
||||
foreach ($events as $event)
|
||||
{
|
||||
$priority = isset($event['priority']) ? $event['priority'] : 0;
|
||||
|
||||
if (!isset($event['event']))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Service "%1$s" must define the "event" attribute on "kernel.event_listener" tags.', $id));
|
||||
}
|
||||
|
||||
if (!isset($event['method']))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Service "%1$s" must define the "method" attribute on "kernel.event_listener" tags.', $id));
|
||||
}
|
||||
|
||||
$definition->addMethodCall('addListenerService', array($event['event'], array($id, $event['method']), $priority));
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($container->findTaggedServiceIds('kernel.event_subscriber') as $id => $attributes)
|
||||
{
|
||||
// We must assume that the class value has been correctly filled, even if the service is created by a factory
|
||||
$class = $container->getDefinition($id)->getClass();
|
||||
|
||||
$refClass = new ReflectionClass($class);
|
||||
$interface = 'Symfony\Component\EventDispatcher\EventSubscriberInterface';
|
||||
if (!$refClass->implementsInterface($interface))
|
||||
{
|
||||
throw new InvalidArgumentException(sprintf('Service "%1$s" must implement interface "%2$s".', $id, $interface));
|
||||
}
|
||||
|
||||
$definition->addMethodCall('addSubscriberService', array($id, $class));
|
||||
}
|
||||
}
|
||||
}
|
85
phpBB/includes/event/kernel_exception_subscriber.php
Normal file
85
phpBB/includes/event/kernel_exception_subscriber.php
Normal file
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\HttpKernel\KernelEvents;
|
||||
use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
|
||||
use Symfony\Component\HttpKernel\Exception\HttpException;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
|
||||
class phpbb_event_kernel_exception_subscriber implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* Template object
|
||||
* @var phpbb_template
|
||||
*/
|
||||
protected $template;
|
||||
|
||||
/**
|
||||
* User object
|
||||
* @var phpbb_user
|
||||
*/
|
||||
protected $user;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param phpbb_template $template Template object
|
||||
* @param phpbb_user $user User object
|
||||
*/
|
||||
public function __construct(phpbb_template $template, phpbb_user $user)
|
||||
{
|
||||
$this->template = $template;
|
||||
$this->user = $user;
|
||||
}
|
||||
|
||||
/**
|
||||
* This listener is run when the KernelEvents::EXCEPTION event is triggered
|
||||
*
|
||||
* @param GetResponseForExceptionEvent $event
|
||||
* @return null
|
||||
*/
|
||||
public function on_kernel_exception(GetResponseForExceptionEvent $event)
|
||||
{
|
||||
page_header($this->user->lang('INFORMATION'));
|
||||
|
||||
$exception = $event->getException();
|
||||
|
||||
$this->template->assign_vars(array(
|
||||
'MESSAGE_TITLE' => $this->user->lang('INFORMATION'),
|
||||
'MESSAGE_TEXT' => $exception->getMessage(),
|
||||
));
|
||||
|
||||
$this->template->set_filenames(array(
|
||||
'body' => 'message_body.html',
|
||||
));
|
||||
|
||||
page_footer(true, false, false);
|
||||
|
||||
|
||||
$status_code = $exception instanceof HttpException ? $exception->getStatusCode() : 500;
|
||||
$response = new Response($this->template->assign_display('body'), $status_code);
|
||||
$event->setResponse($response);
|
||||
}
|
||||
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
KernelEvents::EXCEPTION => 'on_kernel_exception',
|
||||
);
|
||||
}
|
||||
}
|
83
phpBB/includes/event/kernel_request_subscriber.php
Normal file
83
phpBB/includes/event/kernel_request_subscriber.php
Normal file
@@ -0,0 +1,83 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\HttpKernel\KernelEvents;
|
||||
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
|
||||
use Symfony\Component\HttpKernel\EventListener\RouterListener;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
|
||||
class phpbb_event_kernel_request_subscriber implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* Extension finder object
|
||||
* @var phpbb_extension_finder
|
||||
*/
|
||||
protected $finder;
|
||||
|
||||
/**
|
||||
* PHP extension
|
||||
* @var string
|
||||
*/
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* Root path
|
||||
* @var string
|
||||
*/
|
||||
protected $root_path;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param phpbb_extension_finder $finder Extension finder object
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP extension
|
||||
*/
|
||||
public function __construct(phpbb_extension_finder $finder, $root_path, $php_ext)
|
||||
{
|
||||
$this->finder = $finder;
|
||||
$this->root_path = $root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
}
|
||||
|
||||
/**
|
||||
* This listener is run when the KernelEvents::REQUEST event is triggered
|
||||
*
|
||||
* This is responsible for setting up the routing information
|
||||
*
|
||||
* @param GetResponseEvent $event
|
||||
* @return null
|
||||
*/
|
||||
public function on_kernel_request(GetResponseEvent $event)
|
||||
{
|
||||
$request = $event->getRequest();
|
||||
$context = new RequestContext();
|
||||
$context->fromRequest($request);
|
||||
|
||||
$matcher = phpbb_get_url_matcher($this->finder, $context, $this->root_path, $this->php_ext);
|
||||
$router_listener = new RouterListener($matcher, $context);
|
||||
$router_listener->onKernelRequest($event);
|
||||
}
|
||||
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
KernelEvents::REQUEST => 'on_kernel_request',
|
||||
);
|
||||
}
|
||||
}
|
43
phpBB/includes/event/kernel_terminate_subscriber.php
Normal file
43
phpBB/includes/event/kernel_terminate_subscriber.php
Normal file
@@ -0,0 +1,43 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2012 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\HttpKernel\KernelEvents;
|
||||
use Symfony\Component\HttpKernel\Event\PostResponseEvent;
|
||||
|
||||
class phpbb_event_kernel_terminate_subscriber implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* This listener is run when the KernelEvents::TERMINATE event is triggered
|
||||
* This comes after a Response has been sent to the server; this is
|
||||
* primarily cleanup stuff.
|
||||
*
|
||||
* @param PostResponseEvent $event
|
||||
* @return null
|
||||
*/
|
||||
public function on_kernel_terminate(PostResponseEvent $event)
|
||||
{
|
||||
exit_handler();
|
||||
}
|
||||
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
KernelEvents::TERMINATE => 'on_kernel_terminate',
|
||||
);
|
||||
}
|
||||
}
|
@@ -7,6 +7,8 @@
|
||||
*
|
||||
*/
|
||||
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
@@ -229,7 +231,8 @@ function phpbb_gmgetdate($time = false)
|
||||
/**
|
||||
* Return formatted string for filesizes
|
||||
*
|
||||
* @param int $value filesize in bytes
|
||||
* @param mixed $value filesize in bytes
|
||||
* (non-negative number; int, float or string)
|
||||
* @param bool $string_only true if language string should be returned
|
||||
* @param array $allowed_units only allow these units (data array indexes)
|
||||
*
|
||||
@@ -241,6 +244,12 @@ function get_formatted_filesize($value, $string_only = true, $allowed_units = fa
|
||||
global $user;
|
||||
|
||||
$available_units = array(
|
||||
'tb' => array(
|
||||
'min' => 1099511627776, // pow(2, 40)
|
||||
'index' => 4,
|
||||
'si_unit' => 'TB',
|
||||
'iec_unit' => 'TIB',
|
||||
),
|
||||
'gb' => array(
|
||||
'min' => 1073741824, // pow(2, 30)
|
||||
'index' => 3,
|
||||
@@ -2899,8 +2908,6 @@ function meta_refresh($time, $url, $disable_cd_check = false)
|
||||
*/
|
||||
function send_status_line($code, $message)
|
||||
{
|
||||
global $request;
|
||||
|
||||
if (substr(strtolower(@php_sapi_name()), 0, 3) === 'cgi')
|
||||
{
|
||||
// in theory, we shouldn't need that due to php doing it. Reality offers a differing opinion, though
|
||||
@@ -2908,18 +2915,35 @@ function send_status_line($code, $message)
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($request->server('SERVER_PROTOCOL'))
|
||||
{
|
||||
$version = $request->server('SERVER_PROTOCOL');
|
||||
}
|
||||
else
|
||||
{
|
||||
$version = 'HTTP/1.0';
|
||||
}
|
||||
$version = phpbb_request_http_version();
|
||||
header("$version $code $message", true, $code);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the HTTP version used in the current request.
|
||||
*
|
||||
* Handles the case of being called before $request is present,
|
||||
* in which case it falls back to the $_SERVER superglobal.
|
||||
*
|
||||
* @return string HTTP version
|
||||
*/
|
||||
function phpbb_request_http_version()
|
||||
{
|
||||
global $request;
|
||||
|
||||
if ($request && $request->server('SERVER_PROTOCOL'))
|
||||
{
|
||||
return $request->server('SERVER_PROTOCOL');
|
||||
}
|
||||
else if (isset($_SERVER['SERVER_PROTOCOL']))
|
||||
{
|
||||
return $_SERVER['SERVER_PROTOCOL'];
|
||||
}
|
||||
|
||||
return 'HTTP/1.0';
|
||||
}
|
||||
|
||||
//Form validation
|
||||
|
||||
|
||||
@@ -5276,8 +5300,12 @@ function page_header($page_title = '', $display_online_list = true, $item_id = 0
|
||||
|
||||
/**
|
||||
* Generate page footer
|
||||
*
|
||||
* @param bool $run_cron Whether or not to run the cron
|
||||
* @param bool $display_template Whether or not to display the template
|
||||
* @param bool $exit_handler Whether or not to run the exit_handler()
|
||||
*/
|
||||
function page_footer($run_cron = true)
|
||||
function page_footer($run_cron = true, $display_template = true, $exit_handler = true)
|
||||
{
|
||||
global $db, $config, $template, $user, $auth, $cache, $starttime, $phpbb_root_path, $phpEx;
|
||||
global $request, $phpbb_dispatcher;
|
||||
@@ -5372,10 +5400,17 @@ function page_footer($run_cron = true)
|
||||
}
|
||||
}
|
||||
|
||||
$template->display('body');
|
||||
if ($display_template)
|
||||
{
|
||||
$template->display('body');
|
||||
}
|
||||
|
||||
garbage_collection();
|
||||
exit_handler();
|
||||
|
||||
if ($exit_handler)
|
||||
{
|
||||
exit_handler();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -5393,7 +5428,10 @@ function garbage_collection()
|
||||
* @event core.garbage_collection
|
||||
* @since 3.1-A1
|
||||
*/
|
||||
$phpbb_dispatcher->dispatch('core.garbage_collection');
|
||||
if (!empty($phpbb_dispatcher))
|
||||
{
|
||||
$phpbb_dispatcher->dispatch('core.garbage_collection');
|
||||
}
|
||||
|
||||
// Unload cache, must be done before the DB connection if closed
|
||||
if (!empty($cache))
|
||||
@@ -5479,3 +5517,49 @@ function phpbb_to_numeric($input)
|
||||
{
|
||||
return ($input > PHP_INT_MAX) ? (float) $input : (int) $input;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a Symfony Request object from phpbb_request object
|
||||
*
|
||||
* @param phpbb_request $request Request object
|
||||
* @return Request A Symfony Request object
|
||||
*/
|
||||
function phpbb_create_symfony_request(phpbb_request $request)
|
||||
{
|
||||
// This function is meant to sanitize the global input arrays
|
||||
$sanitizer = function(&$value, $key) {
|
||||
$type_cast_helper = new phpbb_request_type_cast_helper();
|
||||
$type_cast_helper->set_var($value, $value, gettype($value), true);
|
||||
};
|
||||
|
||||
// We need to re-enable the super globals so we can access them here
|
||||
$request->enable_super_globals();
|
||||
$get_parameters = $_GET;
|
||||
$post_parameters = $_POST;
|
||||
$server_parameters = $_SERVER;
|
||||
$files_parameters = $_FILES;
|
||||
$cookie_parameters = $_COOKIE;
|
||||
// And now disable them again for security
|
||||
$request->disable_super_globals();
|
||||
|
||||
array_walk_recursive($get_parameters, $sanitizer);
|
||||
array_walk_recursive($post_parameters, $sanitizer);
|
||||
|
||||
// Until we fix the issue with relative paths, we have to fake path info
|
||||
// to allow urls like app.php?controller=foo/bar
|
||||
$controller = $request->variable('controller', '');
|
||||
$path_info = '/' . $controller;
|
||||
$request_uri = $server_parameters['REQUEST_URI'];
|
||||
|
||||
// Remove the query string from REQUEST_URI
|
||||
if ($pos = strpos($request_uri, '?'))
|
||||
{
|
||||
$request_uri = substr($request_uri, 0, $pos);
|
||||
}
|
||||
|
||||
// Add the path info (i.e. controller route) to the REQUEST_URI
|
||||
$server_parameters['REQUEST_URI'] = $request_uri . $path_info;
|
||||
$server_parameters['SCRIPT_NAME'] = '';
|
||||
|
||||
return new Request($get_parameters, $post_parameters, array(), $cookie_parameters, $files_parameters, $server_parameters);
|
||||
}
|
||||
|
@@ -84,8 +84,13 @@ function phpbb_create_compiled_container(array $extensions, array $passes, $phpb
|
||||
$tmp_container = phpbb_create_container($extensions, $phpbb_root_path, $php_ext);
|
||||
$tmp_container->compile();
|
||||
|
||||
// XXX stop writing to global $cache when
|
||||
// http://tracker.phpbb.com/browse/PHPBB3-11203 is fixed
|
||||
$GLOBALS['cache'] = $tmp_container->get('cache');
|
||||
$installed_exts = $tmp_container->get('ext.manager')->all_enabled();
|
||||
|
||||
// Now pass the enabled extension paths into the ext compiler extension
|
||||
$extensions[] = new phpbb_di_extension_ext($tmp_container->get('ext.manager')->all_enabled());
|
||||
$extensions[] = new phpbb_di_extension_ext($installed_exts);
|
||||
|
||||
// Create the final container to be compiled and cached
|
||||
$container = phpbb_create_container($extensions, $phpbb_root_path, $php_ext);
|
||||
@@ -133,5 +138,5 @@ function phpbb_create_dumped_container_unless_debug(array $extensions, array $pa
|
||||
function phpbb_container_filename($phpbb_root_path, $php_ext)
|
||||
{
|
||||
$filename = str_replace(array('/', '.'), array('slash', 'dot'), $phpbb_root_path);
|
||||
return $phpbb_root_path . 'cache/' . $filename . '_container.' . $php_ext;
|
||||
return $phpbb_root_path . 'cache/container_' . $filename . '.' . $php_ext;
|
||||
}
|
||||
|
106
phpBB/includes/functions_url_matcher.php
Normal file
106
phpBB/includes/functions_url_matcher.php
Normal file
@@ -0,0 +1,106 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* @package phpBB3
|
||||
* @copyright (c) 2005 phpBB Group
|
||||
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
|
||||
*
|
||||
*/
|
||||
|
||||
use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper;
|
||||
use Symfony\Component\Routing\Matcher\UrlMatcher;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
if (!defined('IN_PHPBB'))
|
||||
{
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new UrlMatcher class and dump it into the cache file
|
||||
*
|
||||
* @param phpbb_extension_finder $finder Extension finder
|
||||
* @param RequestContext $context Symfony RequestContext object
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP extension
|
||||
* @return null
|
||||
*/
|
||||
function phpbb_get_url_matcher(phpbb_extension_finder $finder, RequestContext $context, $root_path, $php_ext)
|
||||
{
|
||||
if (defined('DEBUG'))
|
||||
{
|
||||
return phpbb_create_url_matcher($finder, $context);
|
||||
}
|
||||
|
||||
if (!phpbb_url_matcher_dumped($root_path, $php_ext))
|
||||
{
|
||||
phpbb_create_dumped_url_matcher($finder, $root_path, $php_ext);
|
||||
}
|
||||
|
||||
return phpbb_load_url_matcher($context, $root_path, $php_ext);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new UrlMatcher class and dump it into the cache file
|
||||
*
|
||||
* @param phpbb_extension_finder $finder Extension finder
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP extension
|
||||
* @return null
|
||||
*/
|
||||
function phpbb_create_dumped_url_matcher(phpbb_extension_finder $finder, $root_path, $php_ext)
|
||||
{
|
||||
$provider = new phpbb_controller_provider();
|
||||
$routes = $provider->import_paths_from_finder($finder)->find();
|
||||
$dumper = new PhpMatcherDumper($routes);
|
||||
$cached_url_matcher_dump = $dumper->dump(array(
|
||||
'class' => 'phpbb_url_matcher',
|
||||
));
|
||||
|
||||
file_put_contents($root_path . 'cache/url_matcher' . $php_ext, $cached_url_matcher_dump);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a non-cached UrlMatcher
|
||||
*
|
||||
* @param phpbb_extension_finder $finder Extension finder
|
||||
* @param RequestContext $context Symfony RequestContext object
|
||||
* @return UrlMatcher
|
||||
*/
|
||||
function phpbb_create_url_matcher(phpbb_extension_finder $finder, RequestContext $context)
|
||||
{
|
||||
$provider = new phpbb_controller_provider();
|
||||
$routes = $provider->import_paths_from_finder($finder)->find();
|
||||
return new UrlMatcher($routes, $context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the cached phpbb_url_matcher class
|
||||
*
|
||||
* @param RequestContext $context Symfony RequestContext object
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP extension
|
||||
* @return phpbb_url_matcher
|
||||
*/
|
||||
function phpbb_load_url_matcher(RequestContext $context, $root_path, $php_ext)
|
||||
{
|
||||
require($root_path . 'cache/url_matcher' . $php_ext);
|
||||
return new phpbb_url_matcher($context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine whether we have our dumped URL matcher
|
||||
*
|
||||
* The class is automatically dumped to the cache directory
|
||||
*
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP extension
|
||||
* @return bool True if it exists, false if not
|
||||
*/
|
||||
function phpbb_url_matcher_dumped($root_path, $php_ext)
|
||||
{
|
||||
return file_exists($root_path . 'cache/url_matcher' . $php_ext);
|
||||
}
|
@@ -44,7 +44,7 @@ class phpbb_style_resource_locator implements phpbb_template_locator
|
||||
* style directory, such as admin control panel templates.
|
||||
* @var string
|
||||
*/
|
||||
public $template_path = 'template/';
|
||||
private $template_path;
|
||||
|
||||
/**
|
||||
* Map from root index to handles to source template file paths.
|
||||
@@ -63,6 +63,16 @@ class phpbb_style_resource_locator implements phpbb_template_locator
|
||||
*/
|
||||
private $filenames = array();
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Sets default template path to template/.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$this->set_default_template_path();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the list of style paths
|
||||
*
|
||||
@@ -93,6 +103,31 @@ class phpbb_style_resource_locator implements phpbb_template_locator
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the location of templates directory within style directories.
|
||||
*
|
||||
* The location must be a relative path, with a trailing slash.
|
||||
* Typically it is one directory level deep, e.g. "template/".
|
||||
*
|
||||
* @param string $template_path Relative path to templates directory within style directories
|
||||
* @return void
|
||||
*/
|
||||
public function set_template_path($template_path)
|
||||
{
|
||||
$this->template_path = $template_path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the location of templates directory within style directories
|
||||
* to the default, which is "template/".
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function set_default_template_path()
|
||||
{
|
||||
$this->template_path = 'template/';
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
@@ -229,4 +264,85 @@ class phpbb_style_resource_locator implements phpbb_template_locator
|
||||
// search failed
|
||||
return $default_result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Obtains filesystem path for a template file.
|
||||
*
|
||||
* The simplest use is specifying a single template file as a string
|
||||
* in the first argument. This template file should be a basename
|
||||
* of a template file in the selected style, or its parent styles
|
||||
* if template inheritance is being utilized.
|
||||
*
|
||||
* Note: "selected style" is whatever style the style resource locator
|
||||
* is configured for.
|
||||
*
|
||||
* The return value then will be a path, relative to the current
|
||||
* directory or absolute, to the template file in the selected style
|
||||
* or its closest parent.
|
||||
*
|
||||
* If the selected style does not have the template file being searched,
|
||||
* (and if inheritance is involved, none of the parents have it either),
|
||||
* false will be returned.
|
||||
*
|
||||
* Specifying true for $return_default will cause the function to
|
||||
* return the first path which was checked for existence in the event
|
||||
* that the template file was not found, instead of false.
|
||||
* This is the path in the selected style itself, not any of its
|
||||
* parents.
|
||||
*
|
||||
* $files can be given an array of templates instead of a single
|
||||
* template. When given an array, the function will try to resolve
|
||||
* each template in the array to a path, and will return the first
|
||||
* path that exists, or false if none exist.
|
||||
*
|
||||
* If $files is an array and template inheritance is involved, first
|
||||
* each of the files will be checked in the selected style, then each
|
||||
* of the files will be checked in the immediate parent, and so on.
|
||||
*
|
||||
* If $return_full_path is false, then instead of returning a usable
|
||||
* path (when the template is found) only the template's basename
|
||||
* will be returned. This can be used to check which of the templates
|
||||
* specified in $files exists. Naturally more than one template must
|
||||
* be given in $files.
|
||||
*
|
||||
* This function works identically to get_first_file_location except
|
||||
* it operates on a list of templates, not files. Practically speaking,
|
||||
* the templates given in the first argument first are prepended with
|
||||
* the template path (property in this class), then given to
|
||||
* get_first_file_location for the rest of the processing.
|
||||
*
|
||||
* Templates given to this function can be relative paths for templates
|
||||
* located in subdirectories of the template directories. The paths
|
||||
* should be relative to the templates directory (template/ by default).
|
||||
*
|
||||
* @param string or array $files List of templates to locate. If there is only
|
||||
* one template, $files can be a string to make code easier to read.
|
||||
* @param bool $return_default Determines what to return if template does not
|
||||
* exist. If true, function will return location where template is
|
||||
* supposed to be. If false, function will return false.
|
||||
* @param bool $return_full_path If true, function will return full path
|
||||
* to template. If false, function will return template file name.
|
||||
* This parameter can be used to check which one of set of template
|
||||
* files is available.
|
||||
* @return string or boolean Source template path if template exists or $return_default is
|
||||
* true. False if template does not exist and $return_default is false
|
||||
*/
|
||||
public function get_first_template_location($templates, $return_default = false, $return_full_path = true)
|
||||
{
|
||||
// add template path prefix
|
||||
$files = array();
|
||||
if (is_string($templates))
|
||||
{
|
||||
$files[] = $this->template_path . $templates;
|
||||
}
|
||||
else
|
||||
{
|
||||
foreach ($templates as $template)
|
||||
{
|
||||
$files[] = $this->template_path . $template;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->get_first_file_location($files, $return_default, $return_full_path);
|
||||
}
|
||||
}
|
||||
|
@@ -110,7 +110,7 @@ class phpbb_style
|
||||
*
|
||||
* @param string $name Name of style, used for cache prefix. Examples: "admin", "prosilver"
|
||||
* @param array or string $paths Array of style paths, relative to current root directory
|
||||
* @param string $template_path Path to templates, relative to style directory. False if path should not be changed.
|
||||
* @param string $template_path Path to templates, relative to style directory. False if path should be set to default (templates/).
|
||||
*/
|
||||
public function set_custom_style($name, $paths, $template_path = false)
|
||||
{
|
||||
@@ -122,12 +122,16 @@ class phpbb_style
|
||||
$this->provider->set_styles($paths);
|
||||
$this->locator->set_paths($this->provider);
|
||||
|
||||
$this->template->cachepath = $this->phpbb_root_path . 'cache/tpl_' . str_replace('_', '-', $name) . '_';
|
||||
|
||||
if ($template_path !== false)
|
||||
{
|
||||
$this->template->template_path = $this->locator->template_path = $template_path;
|
||||
$this->locator->set_template_path($template_path);
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->locator->set_default_template_path();
|
||||
}
|
||||
|
||||
$this->template->cachepath = $this->phpbb_root_path . 'cache/tpl_' . str_replace('_', '-', $name) . '_';
|
||||
|
||||
return true;
|
||||
}
|
||||
|
@@ -99,12 +99,54 @@ interface phpbb_template_locator
|
||||
public function get_source_file_for_handle($handle, $find_all = false);
|
||||
|
||||
/**
|
||||
* Locates source file path, accounting for styles tree and verifying that
|
||||
* the path exists.
|
||||
* Obtains a complete filesystem path for a file in a style.
|
||||
*
|
||||
* Unlike previous functions, this function works without template handle
|
||||
* and it can search for more than one file. If more than one file name is
|
||||
* specified, it will return location of file that it finds first.
|
||||
* This function traverses the style tree (selected style and
|
||||
* its parents in order, if inheritance is being used) and finds
|
||||
* the first file on the filesystem matching specified relative path,
|
||||
* or the first of the specified paths if more than one path is given.
|
||||
*
|
||||
* This function can be used to determine filesystem path of any
|
||||
* file under any style, with the consequence being that complete
|
||||
* relative to the style directory path must be provided as an argument.
|
||||
*
|
||||
* In particular, this function can be used to locate templates
|
||||
* and javascript files.
|
||||
*
|
||||
* For locating templates get_first_template_location should be used
|
||||
* as it prepends the configured template path to the template basename.
|
||||
*
|
||||
* Note: "selected style" is whatever style the style resource locator
|
||||
* is configured for.
|
||||
*
|
||||
* The return value then will be a path, relative to the current
|
||||
* directory or absolute, to the first existing file in the selected
|
||||
* style or its closest parent.
|
||||
*
|
||||
* If the selected style does not have the file being searched,
|
||||
* (and if inheritance is involved, none of the parents have it either),
|
||||
* false will be returned.
|
||||
*
|
||||
* Multiple files can be specified, in which case the first file in
|
||||
* the list that can be found on the filesystem is returned.
|
||||
*
|
||||
* If multiple files are specified and inheritance is involved,
|
||||
* first each of the specified files is checked in the selected style,
|
||||
* then each of the specified files is checked in the immediate parent,
|
||||
* etc.
|
||||
*
|
||||
* Specifying true for $return_default will cause the function to
|
||||
* return the first path which was checked for existence in the event
|
||||
* that the template file was not found, instead of false.
|
||||
* This is always a path in the selected style itself, not any of its
|
||||
* parents.
|
||||
*
|
||||
* If $return_full_path is false, then instead of returning a usable
|
||||
* path (when the file is found) the file's path relative to the style
|
||||
* directory will be returned. This is the same path as was given to
|
||||
* the function as a parameter. This can be used to check which of the
|
||||
* files specified in $files exists. Naturally this requires passing
|
||||
* more than one file in $files.
|
||||
*
|
||||
* @param array $files List of files to locate.
|
||||
* @param bool $return_default Determines what to return if file does not
|
||||
|
@@ -74,12 +74,6 @@ class phpbb_template
|
||||
*/
|
||||
private $locator;
|
||||
|
||||
/**
|
||||
* Location of templates directory within style directories
|
||||
* @var string
|
||||
*/
|
||||
public $template_path = 'template/';
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
@@ -95,7 +89,6 @@ class phpbb_template
|
||||
$this->config = $config;
|
||||
$this->user = $user;
|
||||
$this->locator = $locator;
|
||||
$this->template_path = $this->locator->template_path;
|
||||
$this->context = $context;
|
||||
}
|
||||
|
||||
@@ -458,74 +451,6 @@ class phpbb_template
|
||||
include($file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Obtains filesystem path for a template file.
|
||||
*
|
||||
* The simplest use is specifying a single template file as a string
|
||||
* in the first argument. This template file should be a basename
|
||||
* of a template file in the selected style, or its parent styles
|
||||
* if template inheritance is being utilized.
|
||||
*
|
||||
* Note: "selected style" is whatever style the style resource locator
|
||||
* is configured for.
|
||||
*
|
||||
* The return value then will be a path, relative to the current
|
||||
* directory or absolute, to the template file in the selected style
|
||||
* or its closest parent.
|
||||
*
|
||||
* If the selected style does not have the template file being searched,
|
||||
* (and if inheritance is involved, none of the parents have it either),
|
||||
* false will be returned.
|
||||
*
|
||||
* Specifying true for $return_default will cause the function to
|
||||
* return the first path which was checked for existence in the event
|
||||
* that the template file was not found, instead of false.
|
||||
* This is the path in the selected style itself, not any of its
|
||||
* parents.
|
||||
*
|
||||
* $files can be given an array of templates instead of a single
|
||||
* template. When given an array, the function will try to resolve
|
||||
* each template in the array to a path, and will return the first
|
||||
* path that exists, or false if none exist.
|
||||
*
|
||||
* If $return_full_path is false, then instead of returning a usable
|
||||
* path (when the template is found) only the template's basename
|
||||
* will be returned. This can be used to check which of the templates
|
||||
* specified in $files exists, provided different file names are
|
||||
* used for different templates.
|
||||
*
|
||||
* @param string or array $files List of templates to locate. If there is only
|
||||
* one template, $files can be a string to make code easier to read.
|
||||
* @param bool $return_default Determines what to return if template does not
|
||||
* exist. If true, function will return location where template is
|
||||
* supposed to be. If false, function will return false.
|
||||
* @param bool $return_full_path If true, function will return full path
|
||||
* to template. If false, function will return template file name.
|
||||
* This parameter can be used to check which one of set of template
|
||||
* files is available.
|
||||
* @return string or boolean Source template path if template exists or $return_default is
|
||||
* true. False if template does not exist and $return_default is false
|
||||
*/
|
||||
public function locate($files, $return_default = false, $return_full_path = true)
|
||||
{
|
||||
// add template path prefix
|
||||
$templates = array();
|
||||
if (is_string($files))
|
||||
{
|
||||
$templates[] = $this->template_path . $files;
|
||||
}
|
||||
else
|
||||
{
|
||||
foreach ($files as $file)
|
||||
{
|
||||
$templates[] = $this->template_path . $file;
|
||||
}
|
||||
}
|
||||
|
||||
// use resource locator to find files
|
||||
return $this->locator->get_first_file_location($templates, $return_default, $return_full_path);
|
||||
}
|
||||
|
||||
/**
|
||||
* Include JS file
|
||||
*
|
||||
|
Reference in New Issue
Block a user