ICanBoogie/Routing v2.4.0
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Routing
      • Controller
      • Dispatcher
      • Route

Classes

  • ActionController
  • Controller
  • Dispatcher
  • FormattedRoute
  • Helpers
  • Pattern
  • Route
  • Routes

Interfaces

  • Exception
  • ToSlug

Exceptions

  • ActionNotDefined
  • ControllerNotDefined
  • PatternNotDefined
  • PatternRequiresValues
  • RouteNotDefined

Functions

  • absolutize_url
  • contextualize
  • decontextualize
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Routing;

use ICanBoogie\HTTP\Request;

/**
 * Base class for action controllers.
 *
 * @package ICanBoogie\Routing
 *
 * @property-read string $action The action being executed.
 */
class ActionController extends Controller
{
    /**
     * @return string
     */
    protected function get_action()
    {
        return $this->route->action;
    }

    /**
     * Dispatch the request to the appropriate method.
     *
     * The {@link $request} property is initialized.
     *
     * @param Request $request
     *
     * @return \ICanBoogie\HTTP\Response|mixed
     */
    public function action(Request $request)
    {
        $callable = $this->resolve_action($request);

        return $callable();
    }

    /**
     * Resolves the action into a callable.
     *
     * @param Request $request
     *
     * @return callable
     */
    protected function resolve_action(Request $request)
    {
        $action = $this->action;

        if (!$action)
        {
            throw new ActionNotDefined("Action not defined in route.");
        }

        $method_name = 'action_' . strtolower($request->method) . '_' . $action;
        $method_args = $request->path_params;

        if (!method_exists($this, $method_name))
        {
            $method_name = 'action_any_' . $action;

            if (!method_exists($this, $method_name))
            {
                $method_name = 'action_' . $action;
            }
        }

        return function() use($method_name, $method_args)
        {
            return call_user_func_array([ $this, $method_name ], $method_args);
        };
    }
}
ICanBoogie/Routing v2.4.0 API documentation generated by ApiGen