File Core/src/Model/Action/ListEntitiesAction.php | BEdita API doc

  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  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2017 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Model\Action;

use BEdita\Core\Exception\BadFilterException;
use BEdita\Core\ORM\QueryFilterTrait;
use Cake\ORM\Query;
use Cake\Utility\Inflector;

/**
 * Command to list entities.
 *
 * @since 4.0.0
 */
class ListEntitiesAction extends BaseAction
{
    use QueryFilterTrait;

    /**
     * Table.
     *
     * @var \Cake\ORM\Table
     */
    protected $Table;

    /**
     * @inheritDoc
     */
    protected function initialize(array $data)
    {
        $this->Table = $this->getConfig('table');
    }

    /**
     * Parse a filter string.
     *
     * @param string $filter Filter string.
     * @return array
     */
    public static function parseFilter($filter)
    {
        if (is_array($filter)) {
            return $filter;
        }
        if (!is_string($filter)) {
            return [];
        }

        $filter = array_filter(explode(',', $filter));

        $result = [];
        foreach ($filter as $condition) {
            [$key, $value] = explode('=', $condition, 2) + [null, true];

            $key = trim($key);
            if ($key === '') {
                continue;
            }
            if ($value === 'null') {
                $value = null;
            }

            $result[$key] = $value;
        }

        return $result;
    }

    /**
     * Build a filter and return modified query object.
     *
     * @param \Cake\ORM\Query $query Query object instance.
     * @param array $filter Filter data.
     * @return \Cake\ORM\Query
     * @throws \BEdita\Core\Exception\BadFilterException
     */
    protected function buildFilter(Query $query, array $filter)
    {
        $customPropsOptions = [];
        foreach ($filter as $key => $value) {
            $variableKey = Inflector::variable($key);
            if ($this->Table->hasFinder($variableKey)) {
                // Finder.
                if ($value === true) {
                    $value = [];
                }

                $query = $query->find($variableKey, (array)$value);

                continue;
            }

            $camelizedKey = Inflector::camelize($key);
            if ($this->Table->associations()->has($camelizedKey)) {
                // Associated match (primary key only).
                $target = $this->Table->getAssociation($camelizedKey)->getTarget();
                $targetPrimaryKey = $target->aliasField($target->getPrimaryKey());
                if (is_array($value)) {
                    $targetPrimaryKey .= ' IN';
                }
                $conditions = [$targetPrimaryKey => $value];

                $query = $query
                    ->distinct(array_map(
                        // Avoid duplicate results when INNER JOIN-ing hasMany associations and similar.
                        [$this->Table, 'aliasField'],
                        (array)$this->Table->getPrimaryKey()
                    ))
                    ->innerJoinWith($camelizedKey, function (Query $query) use ($conditions) {
                        return $query->where($conditions);
                    });

                continue;
            }

            if ($this->Table->hasField($key)) {
                // Filter on single field.
                $key = $this->Table->aliasField($key);
                $query = $this->fieldsFilter($query, [$key => $value]);

                continue;
            }

            if ($this->Table->behaviors()->has('CustomProperties')) {
                /** @var \BEdita\Core\Model\Behavior\CustomPropertiesBehavior $behavior */
                $behavior = $this->Table->behaviors()->get('CustomProperties');
                if (in_array($key, array_keys($behavior->getAvailable()))) {
                    $customPropsOptions[$key] = $value;

                    continue;
                }
            }

            // No suitable filter was found
            throw new BadFilterException([
                'title' => __d('bedita', 'Invalid data'),
                'detail' => 'filter "' . $key . '" was not found',
            ]);
        }

        if (!empty($customPropsOptions)) {
            $query = $query->find('customProp', $customPropsOptions);
        }

        return $query;
    }

    /**
     * {@inheritDoc}
     *
     * @return \Cake\ORM\Query
     */
    public function execute(array $data = [])
    {
        $query = $this->Table->find();

        if (!empty($data['filter'])) {
            $query = $this->buildFilter($query, static::parseFilter($data['filter']));
        }
        if (!empty($data['contain'])) {
            $query = $query->contain($data['contain']);
        }

        return $query;
    }
}

Namespaces

Classes