1: <?php
  2: /**
  3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5:  *
  6:  * Licensed under The MIT License
  7:  * For full copyright and license information, please see the LICENSE.txt
  8:  * Redistributions of files must retain the above copyright notice.
  9:  *
 10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 11:  * @link          https://cakephp.org CakePHP(tm) Project
 12:  * @since         3.0.0
 13:  * @license       https://opensource.org/licenses/mit-license.php MIT License
 14:  */
 15: namespace Cake\Routing\Route;
 16: 
 17: use Cake\Utility\Inflector;
 18: 
 19: /**
 20:  * This route class will transparently inflect the controller, action and plugin
 21:  * routing parameters, so that requesting `/my-plugin/my-controller/my-action`
 22:  * is parsed as `['plugin' => 'MyPlugin', 'controller' => 'MyController', 'action' => 'myAction']`
 23:  */
 24: class DashedRoute extends Route
 25: {
 26: 
 27:     /**
 28:      * Flag for tracking whether or not the defaults have been inflected.
 29:      *
 30:      * Default values need to be inflected so that they match the inflections that
 31:      * match() will create.
 32:      *
 33:      * @var bool
 34:      */
 35:     protected $_inflectedDefaults = false;
 36: 
 37:     /**
 38:      * Camelizes the previously dashed plugin route taking into account plugin vendors
 39:      *
 40:      * @param string $plugin Plugin name
 41:      * @return string
 42:      */
 43:     protected function _camelizePlugin($plugin)
 44:     {
 45:         $plugin = str_replace('-', '_', $plugin);
 46:         if (strpos($plugin, '/') === false) {
 47:             return Inflector::camelize($plugin);
 48:         }
 49:         list($vendor, $plugin) = explode('/', $plugin, 2);
 50: 
 51:         return Inflector::camelize($vendor) . '/' . Inflector::camelize($plugin);
 52:     }
 53: 
 54:     /**
 55:      * Parses a string URL into an array. If it matches, it will convert the
 56:      * controller and plugin keys to their CamelCased form and action key to
 57:      * camelBacked form.
 58:      *
 59:      * @param string $url The URL to parse
 60:      * @param string $method The HTTP method.
 61:      * @return array|false An array of request parameters, or false on failure.
 62:      */
 63:     public function parse($url, $method = '')
 64:     {
 65:         $params = parent::parse($url, $method);
 66:         if (!$params) {
 67:             return false;
 68:         }
 69:         if (!empty($params['controller'])) {
 70:             $params['controller'] = Inflector::camelize($params['controller'], '-');
 71:         }
 72:         if (!empty($params['plugin'])) {
 73:             $params['plugin'] = $this->_camelizePlugin($params['plugin']);
 74:         }
 75:         if (!empty($params['action'])) {
 76:             $params['action'] = Inflector::variable(str_replace(
 77:                 '-',
 78:                 '_',
 79:                 $params['action']
 80:             ));
 81:         }
 82: 
 83:         return $params;
 84:     }
 85: 
 86:     /**
 87:      * Dasherizes the controller, action and plugin params before passing them on
 88:      * to the parent class.
 89:      *
 90:      * @param array $url Array of parameters to convert to a string.
 91:      * @param array $context An array of the current request context.
 92:      *   Contains information such as the current host, scheme, port, and base
 93:      *   directory.
 94:      * @return bool|string Either false or a string URL.
 95:      */
 96:     public function match(array $url, array $context = [])
 97:     {
 98:         $url = $this->_dasherize($url);
 99:         if (!$this->_inflectedDefaults) {
100:             $this->_inflectedDefaults = true;
101:             $this->defaults = $this->_dasherize($this->defaults);
102:         }
103: 
104:         return parent::match($url, $context);
105:     }
106: 
107:     /**
108:      * Helper method for dasherizing keys in a URL array.
109:      *
110:      * @param array $url An array of URL keys.
111:      * @return array
112:      */
113:     protected function _dasherize($url)
114:     {
115:         foreach (['controller', 'plugin', 'action'] as $element) {
116:             if (!empty($url[$element])) {
117:                 $url[$element] = Inflector::dasherize($url[$element]);
118:             }
119:         }
120: 
121:         return $url;
122:     }
123: }
124: