PHP Classes

File: src/loader/LoaderFactory.php

Recommend this page to a friend!
  Classes of Vitaly   Queasy PHP Config   src/loader/LoaderFactory.php   Download  
File: src/loader/LoaderFactory.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Queasy PHP Config
Read a configuration from files in several formats
Author: By
Last change:
Date: 3 years ago
Size: 3,428 bytes
 

Contents

Class file image Download
<?php

/*
 * Queasy PHP Framework - Configuration
 *
 * (c) Vitaly Demyanenko <vitaly_demyanenko@yahoo.com>
 *
 * For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
 */

namespace queasy\config\loader;

use
queasy\config\InvalidArgumentException;

/**
 * Loader factory
 */
class LoaderFactory
{
   
/**
     * @var array Built-in default loaders
     */
   
private static $defaultLoaders = array(
       
'/\.php$/i' => 'queasy\config\loader\PhpLoader',
       
'/\.json$/i' => 'queasy\config\loader\JsonLoader',
       
'/\.ini$/i' => 'queasy\config\loader\IniLoader',
       
'/\.xml$/i' => 'queasy\config\loader\XmlLoader',
       
'/\.cli$/i' => 'queasy\config\loader\CliLoader'
   
);

   
/**
     * @var array Custom loaders
     */
   
private static $loaders = array();

   
/**
     * Register a custom loader.
     *
     * @param string $pattern Regexp pattern for resource paths to handle by this loader
     * @param string $className Loader class name
     * @param bool $ignoreIfRegistered If true, do not throw exception if $pattern is already registered in custom loaders
     *
     * @throws ConfigLoaderException When $pattern is already registered and $ignoreIfRegistered is false
     * @throws InvalidArgumentException When $className does not implement LoaderInterface
     */
   
public static function register($pattern, $className, $ignoreIfRegistered = false)
    {
        if (isset(
self::$loaders[$pattern])
                && !
$ignoreIfRegistered) {
            throw new
AlreadyRegisteredException($pattern);
        }

       
$interfaceName = 'queasy\config\loader\LoaderInterface';
       
$interfaces = class_implements($className);
        if (!
$interfaces || !isset($interfaces[$interfaceName])) {
            throw new
NotImplementedException($className);
        }

       
self::$loaders[$pattern] = $className;
    }

   
/**
     * Create a loader for specified path.
     *
     * @param string $path Path to resource
     *
     * @returns queasy\config\loader\LoaderInterface Loader instance
     *
     * @throws LoaderNotFoundException When no loader found for $path
     */
   
public static function create($path)
    {
       
$className = self::registered($path);
        if (!
$className) {
            throw new
LoaderNotFoundException($path);
        }

        return new
$className($path);
    }

   
/**
     * Check if loader for specified path is registered.
     *
     * @param string $path Path to resource
     *
     * @returns bool|string Loader class name or false if not found
     */
   
public static function registered($path)
    {
       
$className = self::find(self::$loaders, $path);

        if (
$className) {
            return
$className;
        } else {
            return
self::find(self::$defaultLoaders, $path);
        }
    }

   
/**
     * Look for a loader for specified path in an array given.
     *
     * @param array $loaders Array of patterns and loader class names to search in
     * @param string $path Path to resource
     *
     * @returns bool|string Loader class name or false if not found
     */
   
private static function find(array $loaders, $path)
    {
        foreach (
$loaders as $pattern => $className) {
            if (
preg_match($pattern, $path)) {
                return
$className;
            }
        }

        return
false;
    }
}