Namespaces

• ICanBoogie
  • Binding
    • Facets

Classes

• Hooks

Interfaces

• HasCriteriaProperty
• HasCriterionListProperty
• HasFetchRecordMethod
• HasFetchRecordsMethod

Traits

• ModelBindings

  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 

<?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\Binding\Facets;

use ICanBoogie\ActiveRecord;
use ICanBoogie\ActiveRecord\Model;
use ICanBoogie\Binding\PrototypedBindings;
use ICanBoogie\Facets\CriterionList;
use ICanBoogie\Facets\Fetcher;
use ICanBoogie\Facets\Fetcher\BasicFetcher;
use ICanBoogie\Facets\RecordCollection;

class Hooks
{
    /**
     * Synthesizes the `activerecord_facets` config from `activerecord` fragments.
     *
     * @param array $fragments
     *
     * @return array
     */
    static public function synthesize_config(array $fragments)
    {
        $facets = [];

        foreach ($fragments as $fragment)
        {
            if (empty($fragment['facets']))
            {
                continue;
            }

            foreach ($fragment['facets'] as $model_id => $criteria)
            {
                if (empty($facets[$model_id]))
                {
                    $facets[$model_id] = $criteria;

                    continue;
                }

                $facets[$model_id] = array_merge($facets[$model_id], $criteria);
            }
        }

        return $facets;
    }

    /**
     * Returns the criteria associated with the specified model.
     *
     * The criteria include the criteria of the parent models.
     *
     * @param Model|PrototypedBindings $model
     *
     * @return array
     */
    static public function criteria_from(Model $model)
    {
        $criteria_list = [];
        $facets = $model->app->configs['activerecord_facets'];

        $m = $model;

        while ($m)
        {
            $id = $m->id;

            if (!empty($facets[$id]))
            {
                $criteria_list[] = $facets[$id];
            }

            $m = $m->parent_model;
        }

        if (!$criteria_list)
        {
            return [];
        }

        return call_user_func_array('array_merge', array_reverse($criteria_list));
    }

    /**
     * Returns the {@link CriterionList} instance associated with the specified model.
     *
     * @param Model|ModelBindings $model
     *
     * @return CriterionList
     */
    static public function criterion_list_from(Model $model)
    {
        static $instances = [];

        $model_id = $model->id;

        if (isset($instances[$model_id]))
        {
            return $instances[$model_id];
        }

        $criteria = $model->criteria;
        $instances[$model_id] = $criterion_list = new CriterionList($criteria);

        return $criterion_list;
    }

    /**
     * Fetches the records matching the specified conditions.
     *
     * A {@link BasicFetcher} instance is used to fetch the records.
     *
     * @param Model $model
     * @param array $conditions
     *
     * @return RecordCollection|null
     */
    static public function fetch_records(Model $model, array $conditions)
    {
        $fetcher = new BasicFetcher($model);
        $records = $fetcher($conditions);

        if (!$records)
        {
            return null;
        }

        new RecordCollection\AlterEvent($records);

        return $records;
    }

    /**
     * Fetches a record matching the specified conditions.
     *
     * The model's {@link fetch_records} prototype method is used to retrieve the record.
     *
     * @param Model|ModelBindings $model
     * @param array $conditions
     * @param Fetcher $fetcher If the parameter `fetcher` is present, the {@link Fetcher}
     * instance used to fetch the record is stored inside.
     *
     * @return ActiveRecord|null
     */
    static public function fetch_record(Model $model, array $conditions, &$fetcher = null)
    {
        $records = $model->fetch_records($conditions + [ 'limit' => 1 ]);

        if (!$records)
        {
            return null;
        }

        $fetcher = $records->fetcher;

        return $records->one;
    }
}