ICanBoogie/ActiveRecord 4.0.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • ActiveRecord
      • ActiveRecordCache
      • Driver
      • Property
      • Validate
        • Reader
        • Validator
        • ValidatorProvider

Classes

  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • HasManyRelation
  • Model
  • ModelCollection
  • ModelProvider
  • Query
  • Relation
  • RelationCollection
  • RelationNotDefined
  • Schema
  • SchemaColumn
  • Statement
  • Table

Interfaces

  • ActiveRecordCache
  • Driver
  • Exception

Exceptions

  • ActiveRecordClassNotValid
  • ConnectionAlreadyEstablished
  • ConnectionNotDefined
  • ConnectionNotEstablished
  • DriverNotDefined
  • ModelAlreadyInstantiated
  • ModelNotDefined
  • RecordNotFound
  • RecordNotValid
  • ScopeNotDefined
  • StatementInvocationFailed
  • StatementNotValid
  • UnableToSetFetchMode

Functions

  • extract_charset_and_collate
  • get_model
 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 
<?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\ActiveRecord;

/**
 * Provides a {@link Model} instance.
 */
class ModelProvider
{
    /**
     * @var callable {@link Model} provider
     */
    static private $provider;

    /**
     * Defines the {@link Model} provider.
     *
     * @param callable $provider
     *
     * @return callable The previous provider, or `null` if none was defined.
     */
    static public function define(callable $provider)
    {
        $previous = self::$provider;

        self::$provider = $provider;

        return $previous;
    }

    /**
     * Returns the current provider.
     *
     * @return callable|null
     */
    static public function defined()
    {
        return self::$provider;
    }

    /**
     * Undefine the provider.
     */
    static public function undefine()
    {
        self::$provider = null;
    }

    /**
     * Returns a {@link Model} instance using the provider.
     *
     * @param string $id Model identifier.
     *
     * @return Model
     *
     * @throws ModelNotDefined if the model cannot be provided.
     */
    static public function provide($id)
    {
        $provider = self::$provider;

        if (!$provider)
        {
            throw new \LogicException("No provider is defined yet. Please define one with `ModelProvider::define(\$provider)`.");
        }

        $model = $provider($id);

        if (!$model)
        {
            throw new ModelNotDefined($id);
        }

        return $model;
    }
}
ICanBoogie/ActiveRecord 4.0.x API documentation generated by ApiGen