aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/controller
diff options
context:
space:
mode:
authorDavid King <imkingdavid@gmail.com>2012-10-19 19:54:19 -0400
committerDavid King <imkingdavid@gmail.com>2012-11-16 16:25:09 -0500
commit06158693c7b846518abfe9d72491fc7376e457f3 (patch)
tree46ce44bfeab4bb9f5275fee8ad8e01df3babaddf /phpBB/includes/controller
parent65dde648cab316fd0f0715f13d57ef45452398a3 (diff)
downloadforums-06158693c7b846518abfe9d72491fc7376e457f3.tar
forums-06158693c7b846518abfe9d72491fc7376e457f3.tar.gz
forums-06158693c7b846518abfe9d72491fc7376e457f3.tar.bz2
forums-06158693c7b846518abfe9d72491fc7376e457f3.tar.xz
forums-06158693c7b846518abfe9d72491fc7376e457f3.zip
[feature/controller] Implement a front controller
PHPBB3-10864
Diffstat (limited to 'phpBB/includes/controller')
-rw-r--r--phpBB/includes/controller/helper.php142
-rw-r--r--phpBB/includes/controller/provider.php94
-rw-r--r--phpBB/includes/controller/resolver.php123
-rw-r--r--phpBB/includes/controller/route_collection.php36
4 files changed, 395 insertions, 0 deletions
diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
new file mode 100644
index 0000000000..1998ea6733
--- /dev/null
+++ b/phpBB/includes/controller/helper.php
@@ -0,0 +1,142 @@
+<?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\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+* Controller helper class, contains methods that do things for controllers
+* @package phpBB3
+*/
+class phpbb_controller_helper
+{
+ /**
+ * Container
+ * @var ContainerBuilder
+ */
+ protected $container;
+
+ /**
+ * Template object
+ * @var phpbb_template
+ */
+ protected $template;
+
+ /**
+ * phpBB Root Path
+ * @var string
+ */
+ protected $phpbb_root_path;
+
+ /**
+ * PHP Extension
+ * @var string
+ */
+ protected $php_ext;
+
+ /**
+ * Base URL
+ * @var array
+ */
+ protected $url_base;
+
+ /**
+ * Constructor
+ *
+ * @param ContainerBuilder $container DI Container
+ */
+ public function __construct(ContainerBuilder $container)
+ {
+ $this->container = $container;
+
+ $this->template = $this->container->get('template');
+ $this->phpbb_root_path = $this->container->getParameter('core.root_path');
+ $this->php_ext = $this->container->getParameter('core.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)
+ {
+ if (!function_exists('page_header'))
+ {
+ include("{$this->phpbb_root_path}includes/functions.{$this->php_ext}");
+ }
+
+ page_header($page_title);
+
+ $this->template->set_filenames(array(
+ 'body' => $template_file,
+ ));
+
+ page_footer(true, false, false);
+
+ return new Response($this->template->return_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 . $this->url_base . implode('/', $url_parts), $query);
+ }
+
+ /**
+ * Set base to prepend to urls generated by url()
+ * This allows extensions to have a certain 'directory' under which
+ * all their pages are served, but not have to type it every time
+ *
+ * @param array $url_parts Each array element is a 'folder'
+ * i.e. array('my', 'ext') maps to ./app.php/my/ext
+ * @return null
+ */
+ public function set_url_base(array $url_parts)
+ {
+ $this->url_base = !empty($url_parts) ? implode('/', $url_parts) . '/' : '';
+ }
+
+ /**
+ * Output an error, effectively the same thing as trigger_error
+ *
+ * @param string $code The error code (e.g. 404, 500, 503, etc.)
+ * @param string $message The error message
+ * @return Response A Reponse instance
+ */
+ public function error($code = 500, $message = '')
+ {
+ $this->template->assign_vars(array(
+ 'MESSAGE_TEXT' => $message,
+ 'MESSAGE_TITLE' => $this->container->get('user')->lang('INFORMATION'),
+ ));
+
+ return $this->render('message_body.html', $this->container->get('user')->lang('INFORMATION'), $code);
+ }
+}
diff --git a/phpBB/includes/controller/provider.php b/phpBB/includes/controller/provider.php
new file mode 100644
index 0000000000..25deedb5d1
--- /dev/null
+++ b/phpBB/includes/controller/provider.php
@@ -0,0 +1,94 @@
+<?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->set_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 get_paths(phpbb_extension_finder $finder)
+ {
+ // We hardcode the path to the core config directory
+ // because the finder cannot find it
+ $this->set_paths(array_merge(array('config'), array_map('dirname', array_keys($finder
+ ->directory('config')
+ ->prefix('routing')
+ ->suffix('yml')
+ ->find()
+ ))));
+
+ return $this;
+ }
+
+ /**
+ * Set the $routing_paths property with a given list of paths
+ *
+ * @return The current instance of this object for method chaining
+ */
+ public function set_paths(array $paths)
+ {
+ $this->routing_paths = $paths;
+
+ 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;
+ }
+}
diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
new file mode 100644
index 0000000000..bf9ce3330d
--- /dev/null
+++ b/phpBB/includes/controller/resolver.php
@@ -0,0 +1,123 @@
+<?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 RuntimeException
+ */
+ public function getController(Request $request)
+ {
+ $controller = $request->attributes->get('_controller');
+
+ if (!$controller)
+ {
+ throw new RuntimeException($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
+ }
+
+ // Require a method name along with the service name
+ if (stripos($controller, ':') === false)
+ {
+ throw new RuntimeException($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
+ }
+
+ list($service, $method) = explode(':', $controller);
+
+ if (!$this->container->has($service))
+ {
+ throw new RuntimeException($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 string $controller Controller class name
+ * @return bool False
+ */
+ 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->isDefaultValueAvailable())
+ {
+ $arguments[] = $param->getDefaultValue();
+ }
+ else
+ {
+ throw new RuntimeException($user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+ }
+ }
+
+ return $arguments;
+ }
+}
diff --git a/phpBB/includes/controller/route_collection.php b/phpBB/includes/controller/route_collection.php
new file mode 100644
index 0000000000..e6c7d3b543
--- /dev/null
+++ b/phpBB/includes/controller/route_collection.php
@@ -0,0 +1,36 @@
+<?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;
+
+/**
+* Controller manager class
+* @package phpBB3
+*/
+class phpbb_controller_route_collection extends RouteCollection
+{
+ /**
+ * Construct method
+ *
+ * @param phpbb_extension_finder $finder Finder object
+ */
+ public function __construct(phpbb_extension_finder $finder, phpbb_controller_provider $provider)
+ {
+ parent::__construct();
+ $this->addCollection($provider->get_paths($finder)->find());
+ }
+}