DefaultFactory.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2020 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\core\impl;
 
use wcmf\lib\config\Configuration;
use wcmf\lib\config\ConfigurationException;
use wcmf\lib\core\Factory;
use wcmf\lib\util\StringUtil;
 
/**
 * DefaultFactory is used to create service instances. The concrete service
 * implementations and building parameters are described in the given configuration.
 * Dependencies are injected in the following ways:
 *
 * - _Constructor injection_: Each constructor parameter is resolved either from
 *   the instance configuration or, if not specified, from an existing class that
 *   is of the same type as defined in the type hinting.
 * - _Setter injection_: Each parameter of the instance configuration, that is
 *   not part of the constructor is injected through an appropriate setter
 *   method, if existing.
 *
 * To ensure that an instance implements a certain interface, the interface
 * name may be passed together with the instance name to the DefaultFactory::addInterfaces
 * method. The interfaces required by framework classes are already defined
 * internally (see DefaultFactory::$requiredInterfaces).
 *
 * The following configuration shows the definition of the View instance:
 *
 * @code
 * [View]
 * __class = wcmf\lib\presentation\view\impl\SmartyView
 * __shared = false
 * compileCheck = true
 * caching = false
 * cacheLifetime = 3600
 * cacheDir = app/cache/smarty/
 *
 * [HtmlView]
 * __ref = $view
 * @endcode
 *
 * In this example views are instances of _SmartyView_. They are not shared,
 * meaning that clients get a fresh instance each time they request a view.
 * The parameters compileCheck, caching, ... are either defined in the constructor
 * of _SmartyView_ or there is an appropriate setter method (e.g.
 * _SmartyView::setCompileCheck_). Any other constructor parameter of _SmartyView_
 * is tried to resolve from either another instance defined in the configuration
 * or an existing class. _HtmlView_ is defined as an alias for _View_.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class DefaultFactory implements Factory {
 
  /**
   * Interfaces that must be implemented by the given instances used
   * in the framework.
   */
  protected $requiredInterfaces = [
      'eventManager' =>          'wcmf\lib\core\EventManager',
      'logger' =>                'wcmf\lib\core\Logger',
      'logManager' =>            'wcmf\lib\core\LogManager',
      'session' =>               'wcmf\lib\core\Session',
      'configuration' =>         'wcmf\lib\config\Configuration',
      'localization' =>          'wcmf\lib\i18n\Localization',
      'message' =>               'wcmf\lib\i18n\Message',
      'cache' =>                 'wcmf\lib\io\Cache',
      'persistenceFacade' =>     'wcmf\lib\persistence\PersistenceFacade',
      'transaction' =>           'wcmf\lib\persistence\Transaction',
      'concurrencyManager' =>    'wcmf\lib\persistence\concurrency\ConcurrencyManager',
      'actionMapper' =>          'wcmf\lib\presentation\ActionMapper',
      'request' =>               'wcmf\lib\presentation\Request',
      'response' =>              'wcmf\lib\presentation\Response',
      'listStrategies' =>        'wcmf\lib\presentation\control\lists\ListStrategy',
      'formats' =>               'wcmf\lib\presentation\format\Format',
      'formatter' =>             'wcmf\lib\presentation\format\Formatter',
      'view' =>                  'wcmf\lib\presentation\view\View',
      'authenticationManager' => 'wcmf\lib\security\AuthenticationManager',
      'permissionManager' =>     'wcmf\lib\security\PermissionManager',
      'principalFactory' =>      'wcmf\lib\security\principal\PrincipalFactory',
      'user' =>                  'wcmf\lib\security\principal\User',
      'role' =>                  'wcmf\lib\security\principal\Role',
  ];
 
  /**
   * The registry for already created instances
   */
  protected $instances = [];
 
  /**
   * The Configuration instance that holds the instance definitions
   */
  protected $configuration = null;
 
  protected $currentStack = [];
 
  /**
   * Constructor.
   * @param $configuration Configuration instance used to construct instances.
   */
  public function __construct(Configuration $configuration) {
    // TODO get additional interfaces from configuration
    $this->configuration = $configuration;
  }
 
  /**
   * @see Factory::getInstance()
   */
  public function getInstance($name, $dynamicConfiguration=[]) {
    $instance = null;
    if (in_array($name, $this->currentStack)) {
      throw new \Exception("Circular dependency detected: ".join(' - ', $this->currentStack)." - [".$name."]");
    }
    $this->currentStack[] = $name;
 
    // dynamic configuration must be included in internal instance key
    $instanceKey = sizeof($dynamicConfiguration) == 0 ? strtolower($name) :
      strtolower($name.json_encode($dynamicConfiguration));
 
    // check if the instance is registered already
    if (isset($this->instances[$instanceKey])) {
      $instance = $this->instances[$instanceKey];
    }
    else {
      // construct instance
      $staticConfiguration = $this->configuration->getSection($name, true);
      $configuration = array_merge($staticConfiguration, $dynamicConfiguration);
      $instance = $this->createInstance($name, $configuration, $instanceKey);
    }
    array_pop($this->currentStack);
    return $instance;
  }
 
  /**
   * @see Factory::getNewInstance()
   */
  public function getNewInstance($name, $dynamicConfiguration=[]) {
    $configuration = array_merge([
        '__shared' => false
    ], $dynamicConfiguration);
 
    $instance = $this->getInstance($name, $configuration);
    return $instance;
  }
 
  /**
   * @see Factory::getInstanceOf()
   */
  public function getInstanceOf($class, $dynamicConfiguration=[]) {
    $configuration = array_merge([
        '__class' => $class,
        '__shared' => false
    ], $dynamicConfiguration);
 
    $instance = $this->createInstance($class, $configuration, null);
    return $instance;
  }
 
  /**
   * @see Factory::registerInstance()
   */
  public function registerInstance($name, $instance) {
    $instanceKey = strtolower($name);
    $this->instances[$instanceKey] = $instance;
  }
 
  /**
   * @see Factory::addInterfaces()
   */
  public function addInterfaces(array $interfaces) {
    $this->requiredInterfaces = array_merge($this->requiredInterfaces, $interfaces);
  }
 
  /**
   * @see Factory::clear()
   */
  public function clear() {
    $this->instances = [];
  }
 
  /**
   * Get the setter method name for a property.
   * @param $property
   * @return String
   */
  protected function getSetterName($property) {
    return 'set'.ucfirst(StringUtil::underScoreToCamelCase($property, true));
  }
 
  /**
   * Create an instance from the given configuration array.
   * @param $name The name by which the instance may be retrieved later
   * using Factory::getInstance(). The name is also used to check the interface
   * (see Factory::addInterfaces())
   * @param $configuration Associative array with key value pairs for instance properties
   * passed to the constructor, setters or public properties and the special keys:
   * - '__class': optional, denotes the instance class name
   * - '__shared' optional, if true, the instance may be reused using Factory::getInstance())
   * - '__ref' optional, defines this instance as an alias of the referenced instance
   * @param $instanceKey The name under which the instance is registered for later retrieval
   * @return Object
   */
  protected function createInstance($name, $configuration, $instanceKey) {
    $instance = null;
 
    // return referenced instance, if the instance is an alias
    if (isset($configuration['__ref'])) {
      return $this->getInstance(preg_replace('/^\$/', '', $configuration['__ref']));
    }
 
    // create instance
    if (isset($configuration['__class'])) {
      // the instance belongs to the given class
      $className = $configuration['__class'];
 
      // class definition must be supplied by autoloader
      if (class_exists($className)) {
 
        // collect constructor parameters
        $cParams = [];
        $refClass = new \ReflectionClass($className);
        if ($refClass->hasMethod('__construct')) {
          $refConstructor = new \ReflectionMethod($className, '__construct');
          $refParameters = $refConstructor->getParameters();
          foreach ($refParameters as $param) {
            $paramName = $param->name;
            $paramInstanceKey = strtolower($paramName);
            if (isset($this->instances[$paramInstanceKey])) {
              // parameter is already registered
              $cParams[$paramName] = $this->instances[$paramInstanceKey];
            }
            elseif (isset($configuration[$paramName])) {
              // parameter is explicitly defined in instance configuration
              $cParams[$paramName] = $this->resolveValue($configuration[$paramName]);
            }
            elseif ($this->configuration->hasSection($paramName)) {
              // parameter exists in configuration
              $cParams[$paramName] = $this->getInstance($paramName);
            }
            elseif (($paramClass = $param->getClass()) != null) {
              // check for parameter's class from type hint
              // will cause an exception, if the class does not exist
              $cParams[$paramName] = $this->getInstanceOf($paramClass->name);
            }
            elseif (!$param->isDefaultValueAvailable()) {
              throw new ConfigurationException('Constructor parameter \''.$paramName.
                      '\' in class \''.$className.'\' cannot be injected.');
            }
            // delete resolved parameters from configuration
            unset($configuration[$paramName]);
          }
        }
 
        // create the instance
        $obj = $refClass->newInstanceArgs($cParams);
 
        // check against interface
        $interface = $this->getInterface($name);
        if ($interface != null && !($obj instanceof $interface)) {
          throw new ConfigurationException('Class \''.$className.
                  '\' is required to implement interface \''.$interface.'\'.');
        }
 
        // register the instance if it is shared (default)
        // NOTE we do this before setting the instance properties in order
        // to allow to resolve circular dependencies (dependent objects that
        // are injected into the current instance via property injection can
        // already use this instance)
        if (!isset($configuration['__shared']) || $configuration['__shared'] == 'true') {
          $this->registerInstance($instanceKey, $obj);
        }
 
        // set the instance properties from the remaining configuration
        foreach ($configuration as $key => $value) {
          // exclude properties starting with __ and constructor parameters
          if (strpos($key, '__') !== 0 && !isset($cParams[$key])) {
            $value = $this->resolveValue($value);
            // set the property
            $setterName = $this->getSetterName($key);
            if (method_exists($obj, $setterName)) {
              $obj->$setterName($value);
            }
            else {
              $obj->$key = $value;
            }
          }
        }
        $instance = $obj;
      }
      else {
        throw new ConfigurationException('Class \''.$className.'\' is not found.');
      }
    }
    else {
      // the instance is a map
 
      // get interface that map values should implement
      $interface = $this->getInterface($name);
 
      foreach ($configuration as $key => $value) {
        // create instances for variables denoted by a leading $
        if (strpos($value, '$') === 0) {
          $obj = $this->getInstance(preg_replace('/^\$/', '', $value));
          // check against interface
          if ($interface != null && !($obj instanceof $interface)) {
            throw new ConfigurationException('Class of \''.$name.'.'.$key.
                    '\' is required to implement interface \''.$interface.'\'.');
          }
          $configuration[$key] = $obj;
        }
      }
      // always register maps
      $this->registerInstance($instanceKey, $configuration);
      $instance = $configuration;
    }
    return $instance;
  }
 
  /**
   * Resolve a configuration value into a parameter
   * @param $value
   * @return Mixed
   */
  protected function resolveValue($value) {
    // special treatments, if value is a string
    if (is_string($value)) {
      // replace variables denoted by a leading $
      if (strpos($value, '$') === 0) {
        $value = $this->getInstance(preg_replace('/^\$/', '', $value));
      }
      else {
        // convert booleans
        $lower = strtolower($value);
        if ($lower === 'true') {
          $value = true;
        }
        if ($lower === 'false') {
          $value = false;
        }
      }
    }
    // special treatments, if value is an array
    if (is_array($value)) {
      $result = [];
      $containsInstance = false;
      // check for variables
      foreach ($value as $val) {
        if (is_string($val) && strpos($val, '$') === 0) {
          $result[] = $this->getInstance(preg_replace('/^\$/', '', $val));
          $containsInstance = true;
        }
        else {
          $result[] = $val;
        }
      }
      // only replace value, if the array containes an variable
      if ($containsInstance) {
        $value = $result;
      }
    }
    return $value;
  }
 
  /**
   * Get the interface that is required to be implemented by the given instance
   * @param $name The name of the instance
   * @return Interface or null, if undefined
   */
  protected function getInterface($name) {
    if (isset($this->requiredInterfaces[$name])) {
      return $this->requiredInterfaces[$name];
    }
    return null;
  }
}
?>