update api documentation

documentation/api/files/Controller/Admin/BaseAdminController.php.txt

@@ -0,0 +1,166 @@
+<?php
+/*************************************************************************************/
+/*                                                                                   */
+/*      Thelia	                                                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : info@thelia.net                                                      */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      This program is free software; you can redistribute it and/or modify         */
+/*      it under the terms of the GNU General Public License as published by         */
+/*      the Free Software Foundation; either version 3 of the License                */
+/*                                                                                   */
+/*      This program is distributed in the hope that it will be useful,              */
+/*      but WITHOUT ANY WARRANTY; without even the implied warranty of               */
+/*      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                */
+/*      GNU General Public License for more details.                                 */
+/*                                                                                   */
+/*      You should have received a copy of the GNU General Public License            */
+/*	    along with this program. If not, see <http://www.gnu.org/licenses/>.         */
+/*                                                                                   */
+/*************************************************************************************/
+namespace Thelia\Controller\Admin;
+
+use Thelia\Controller\BaseController;
+use Symfony\Component\HttpFoundation\Response;
+use Thelia\Core\Security\Exception\AuthorizationException;
+use Thelia\Model\ConfigQuery;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Thelia\Core\Security\Exception\AuthenticationException;
+use Thelia\Tools\URL;
+use Thelia\Tools\Redirect;
+
+class BaseAdminController extends BaseController
+{
+    const TEMPLATE_404 = "404";
+
+    public function processTemplateAction($template)
+    {
+        try {
+            if (! empty($template)) {
+                // If we have a view in the URL, render this view
+                return $this->render($template);
+            } elseif (null != $view = $this->getRequest()->get('view')) {
+                return $this->render($view);
+            }
+        } catch (\Exception $ex) {
+            // Nothing special
+        }
+
+        return $this->pageNotFound();
+    }
+
+    /**
+     * Return a 404 error
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function pageNotFound()
+    {
+        return new Response($this->renderRaw(self::TEMPLATE_404), 404);
+    }
+
+    /**
+     * Return a general error page
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function errorPage($message)
+    {
+        return $this->render('general_error', array(
+                "error_message" => $message)
+        );
+    }
+
+    /**
+     * Check current admin user authorisations. An ADMIN role is assumed.
+     *
+     * @param unknown $permissions a single permission or an array of permissions.
+     *
+     * @throws AuthenticationException if permissions are not granted ti the current user.
+     */
+    protected function checkAuth($permissions)
+    {
+        if (! $this->getSecurityContext()->isGranted(array("ADMIN"), is_array($permissions) ? $permissions : array($permissions))) {
+            throw new AuthorizationException("Sorry, you're not allowed to perform this action");
+        }
+    }
+
+    /**
+     * @return a ParserInterfac instance parser
+     */
+    protected function getParser()
+    {
+        $parser = $this->container->get("thelia.parser");
+
+        // Define the template thant shoud be used
+        $parser->setTemplate(ConfigQuery::read('base_admin_template', 'admin/default'));
+
+        return $parser;
+    }
+
+    /**
+     * Forwards the request to another controller.
+     *
+     * @param string $controller The controller name (a string like BlogBundle:Post:index)
+     * @param array  $path       An array of path parameters
+     * @param array  $query      An array of query parameters
+     *
+     * @return Response A Response instance
+     */
+    protected function forward($controller, array $path = array(), array $query = array())
+    {
+        $path['_controller'] = $controller;
+        $subRequest = $this->container->get('request')->duplicate($query, null, $path);
+
+        return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
+    }
+
+    /**
+     * Render the given template, and returns the result as an Http Response.
+     *
+     * @param $templateName the complete template name, with extension
+     * @param  array                                      $args the template arguments
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function render($templateName, $args = array())
+    {
+        $response = new Response();
+
+        return $response->setContent($this->renderRaw($templateName, $args));
+    }
+
+    /**
+     * Render the given template, and returns the result as a string.
+     *
+     * @param $templateName the complete template name, with extension
+     * @param  array                                      $args the template arguments
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function renderRaw($templateName, $args = array())
+    {
+        // Add the template standard extension
+        $templateName .= '.html';
+
+        $session = $this->getSession();
+
+        $args = array_merge($args, array(
+            'locale' => $session->getLocale(),
+            'lang'   => $session->getLang()
+        ));
+
+        try {
+            $data = $this->getParser()->render($templateName, $args);
+
+            return $data;
+        } catch (AuthenticationException $ex) {
+
+            // User is not authenticated, and templates requires authentication -> redirect to login page
+            // We user login_tpl as a path, not a template.
+
+            Redirect::exec(URL::absoluteUrl($ex->getLoginTemplate()));
+        }
+    }
+}
+