CakeDC / cakephp-api

src/Service/Utility/ReverseRouting.php

<?php
/**
 * Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

namespace CakeDC\Api\Service\Utility;

use CakeDC\Api\Service\Action\Action;
use Cake\Core\Configure;
use Cake\Routing\Router;
use Cake\Utility\Inflector;

/**
 * Class ReverseRouting
 *
 * @package CakeDC\Api\Service\Response
 */
class ReverseRouting
{

    /**
     * Builds link to action.
     *
     * @param string $name Link name
     * @param string $path Link path.
     * @param string $method Action method.
     * @return array
     */
    public function link($name, $path, $method = 'GET')
    {
        $prefix = Configure::read('Api.routeBase') ?: '/api';
        $baseRoute = $prefix . $path;
        $fullRoute = Router::url($baseRoute, true);

        return [
            'name' => $name,
            'href' => $fullRoute,
            'rel' => $baseRoute,
            'method' => $method,
        ];
    }

    /**
     * Builds path to the index action.
     *
     * @param Action $action An Action instance.
     * @param callable $beforeReverse Callback.
     * @return array|string
     */
    public function indexPath(Action $action, $beforeReverse = null)
    {
        $indexRoute = $action->getRoute();
        $parent = $action->getService()->getParentService();
        $path = null;
        if ($parent !== null) {
            $parentRoutes = $parent->routes();
            $currentRoute = $this->findRoute($indexRoute, $parentRoutes);

Are you sure the assignment to $currentRoute is correct as $this->findRoute($indexRoute, $parentRoutes) (which targets CakeDC\Api\Service\Utility\ReverseRouting::findRoute()) seems to always return null.

            if ($currentRoute !== null) {
                if (is_callable($beforeReverse)) {
                    $indexRoute = $beforeReverse($indexRoute);
                }

                return $parent->routeReverse($indexRoute);
            }

            return $path;
        } else {
            if (is_callable($beforeReverse)) {
                $indexRoute = $beforeReverse($indexRoute);
            }

            return $action->getService()->routeReverse($indexRoute);
        }
    }

    /**
     * Builds path to the parent view action.
     *
     * @param string $parentName Action name.
     * @param Action $action An Action instance.
     * @param string $type Type of action.
     * @return array
     */
    public function parentViewPath($parentName, $action, $type)
    {
        $baseRoute = $action->getRoute();
        $parent = $action->getService()->getParentService();
        $parentId = Inflector::singularize(Inflector::underscore($parent->getName())) . '_id';
        $route = collection($parent->routes())
            ->filter(function ($item) use ($parentName) {
                return $item->getName() == $parentName;
            })
            ->first();
        $routeDefault = $route->defaults;
        if (array_key_exists($parentId, $baseRoute)) {
            if ($type == 'view') {
                $routeDefault['pass']['id'] = $baseRoute[$parentId];
            }
            if ($type == 'index') {
                $routeDefault[$parentId] = $baseRoute[$parentId];
            }
        }

        return $parent->routeReverse($routeDefault);
    }

    /**
     * Extract matching route from routes list.
     *
     * @param array $route Route array.
     * @param array $routes List of all routes.
     * @return null
     */
    public function findRoute($route, $routes)
    {
        foreach ($routes as $item) {
            if ($this->compareDefaults($item->defaults, $route)) {
                return $item;
            }
        }

        return null;
    }

    /**
     * Compares two routes.
     *
     * @param array $route1 First route description instance.
     * @param array $route2 Second route description instance.
     * @return bool
     */
    public function compareDefaults($route1, $route2)
    {
        $result = true;
        $fields = ['controller', 'action', 'plugin'];
        foreach ($fields as $field) {
            $result = $result && $route1[$field] === $route2[$field];
        }
        $result = $result && (
                is_string($route1['_method']) && $route1['_method'] === $route2['_method'] ||
                is_array($route1['_method']) && in_array($route2['_method'], $route1['_method'])
            );

        return $result;
    }
}