ICanBoogie/Module 2.3.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Module

Classes

  • Descriptor
  • Hooks
  • ModelCollection
  • ModuleCollection
  • ModuleRoute
  • ModuleTemplateResolver

Traits

  • ControllerBindings
  • CoreBindings

Exceptions

  • ModuleConstructorMissing
  • ModuleIsDisabled
  • ModuleNotDefined
 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 
<?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\Module;

use ICanBoogie\ActiveRecord;
use ICanBoogie\ActiveRecord\Model;
use ICanBoogie\Core;
use ICanBoogie\Facets\Fetcher;
use ICanBoogie\Facets\RecordCollection;
use ICanBoogie\Module;

/**
 * {@link \ICanBoogie\Routing\Controller} prototype bindings.
 *
 * @property-read Core $app
 * @property-read Module $module
 * @property-read Model $model
 * @property-read ModuleRoute $route
 * @property Fetcher $records_fetcher
 */
trait ControllerBindings
{
    /**
     * @see \ICanBoogie\Module\Hooks::controller_get_module
     *
     * @return Module
     */
    protected function get_module()
    {
        return parent::get_module();
    }

    /**
     * @see \ICanBoogie\Module\Hooks::controller_get_model
     *
     * @return Model
     */
    protected function get_model()
    {
        return parent::get_model();
    }

    /**
     * @see \ICanBoogie\Module\Hooks::controller_lazy_get_records_fetcher
     *
     * @return Fetcher
     */
    protected function lazy_get_records_fetcher()
    {
        return parent::lazy_get_records_fetcher();
    }

    /**
     * Fetch records using the controller `records_fetcher`.
     *
     * @see \ICanBoogie\Module\Hooks::controller_fetch_records
     *
     * @param array $modifiers
     *
     * @return RecordCollection
     */
    protected function fetch_records(array $modifiers)
    {
        return parent::fetch_records($modifiers);
    }

    /**
     * Fetch records using the controller `records_fetcher`.
     *
     * @see \ICanBoogie\Module\Hooks::controller_fetch_record
     *
     * @param array $modifiers
     * @param Fetcher|null $fetcher Reference to a variable where the fetcher should be stored.
     *
     * @return ActiveRecord
     */
    protected function fetch_record(array $modifiers, &$fetcher = null)
    {
        return parent::fetch_record($modifiers, $fetcher);
    }
}
ICanBoogie/Module 2.3.x API documentation generated by ApiGen