Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Locator
          • Configuration
            • Assembler
            • Validator
          • FileExistsStrategy
          • Generator
          • MethodBodyBuilder
          • Process
            • Transformer
              • Assembler
              • FileLoader
              • Generator
            • Validator

Classes

  • Net\Bazzline\Component\Locator\Configuration\Assembler\AbstractAssembler
  • Net\Bazzline\Component\Locator\Configuration\Assembler\FromArrayAssembler
  • Net\Bazzline\Component\Locator\Configuration\Assembler\FromPropelSchemaXmlAssembler
  • Net\Bazzline\Component\Locator\Configuration\Configuration
  • Net\Bazzline\Component\Locator\Configuration\ConfigurationFactory
  • Net\Bazzline\Component\Locator\Configuration\Instance
  • Net\Bazzline\Component\Locator\Configuration\Uses
  • Net\Bazzline\Component\Locator\Configuration\Validator\ReadableFilePath
  • Net\Bazzline\Component\Locator\FileExistsStrategy\AbstractStrategy
  • Net\Bazzline\Component\Locator\FileExistsStrategy\DeleteStrategy
  • Net\Bazzline\Component\Locator\FileExistsStrategy\SuffixWithCurrentTimestampStrategy
  • Net\Bazzline\Component\Locator\Generator\AbstractGenerator
  • Net\Bazzline\Component\Locator\Generator\AbstractInterfaceGenerator
  • Net\Bazzline\Component\Locator\Generator\FactoryInterfaceGenerator
  • Net\Bazzline\Component\Locator\Generator\InvalidArgumentExceptionGenerator
  • Net\Bazzline\Component\Locator\Generator\LocatorGenerator
  • Net\Bazzline\Component\Locator\Generator\LocatorInterfaceGenerator
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\AbstractMethodBodyBuilder
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromFactoryInstancePoolBuilder
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromSharedInstancePoolBuilder
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromSharedInstancePoolOrCreateByFactoryBuilder
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\NewInstanceBuilder
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\PropelQueryCreateBuilder
  • Net\Bazzline\Component\Locator\Process\Transformer\Assembler\ConfigurationAssembler
  • Net\Bazzline\Component\Locator\Process\Transformer\FileLoader\ConfigurationFileLoader
  • Net\Bazzline\Component\Locator\Process\Transformer\FileLoader\IfAvailableBootstrapFileLoader
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\ArgumentsGenerator
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\FactoryGenerator
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\FileExistsStrategyGenerator
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\InvalidArgumentExceptionFileGenerator
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\LocatorFileGenerator
  • Net\Bazzline\Component\Locator\Process\Transformer\Generator\LocatorInterfaceFileGenerator
  • Net\Bazzline\Component\Locator\Process\Validator\ArgumentsValidator
  • Net\Bazzline\Component\Locator\Process\Validator\ConfigurationDataValidator
  • Net\Bazzline\Component\Locator\Process\Validator\ConfigurationValidator
  • Net\Bazzline\Component\Locator\Process\Validator\IsCommandLineValidator
  • Net\Bazzline\Component\Locator\ProcessPipeFactory

Interfaces

  • Net\Bazzline\Component\Locator\Configuration\Assembler\AssemblerInterface
  • Net\Bazzline\Component\Locator\FactoryInterface
  • Net\Bazzline\Component\Locator\FileExistsStrategy\FileExistsStrategyInterface
  • Net\Bazzline\Component\Locator\Generator\GeneratorInterface
  • Net\Bazzline\Component\Locator\InstanceDependentInterface
  • Net\Bazzline\Component\Locator\LocatorInterface
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\MethodBodyBuilderInterface

Exceptions

  • Net\Bazzline\Component\Locator\Configuration\Assembler\InvalidArgumentException
  • Net\Bazzline\Component\Locator\Configuration\Assembler\RuntimeException
  • Net\Bazzline\Component\Locator\Configuration\Validator\RuntimeException
  • Net\Bazzline\Component\Locator\Exception
  • Net\Bazzline\Component\Locator\FileExistsStrategy\InvalidArgumentException
  • Net\Bazzline\Component\Locator\FileExistsStrategy\RuntimeException
  • Net\Bazzline\Component\Locator\InvalidArgumentException
  • Net\Bazzline\Component\Locator\MethodBodyBuilder\RuntimeException
  • Net\Bazzline\Component\Locator\RuntimeException
  • Overview
  • Namespace
  • Class
  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: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2014-05-26 
 */

namespace Net\Bazzline\Component\Locator\Configuration;

use Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromFactoryInstancePoolBuilder;
use Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromSharedInstancePoolBuilder;
use Net\Bazzline\Component\Locator\MethodBodyBuilder\FetchFromSharedInstancePoolOrCreateByFactoryBuilder;
use Net\Bazzline\Component\Locator\MethodBodyBuilder\MethodBodyBuilderInterface;
use Net\Bazzline\Component\Locator\MethodBodyBuilder\NewInstanceBuilder;
use Net\Bazzline\Component\Locator\RuntimeException;

/**
 * Interface Configuration
 * @package Net\Bazzline\Component\Locator\Configuration\Assembler
 */
class Configuration
{
    //begin of properties
    /** @var string */
    private $extends;

    /** @var array */
    private $instances = array();

    /** @var array */
    private $implements = array();

    /** @var string */
    private $className;

    /** @var bool */
    private $createLocatorGeneratorInterface = false;

    /** @var FetchFromFactoryInstancePoolBuilder */
    private $fetchFromFactoryInstancePoolBuilder;

    /** @var FetchFromSharedInstancePoolBuilder */
    private $fetchFromSharedInstancePoolBuilder;

    /** @var FetchFromSharedInstancePoolOrCreateByFactoryBuilder */
    private $fetchFromSharedInstancePoolOrCreateByFactoryBuilder;

    /** @var bool */
    private $hasFactoryInstances = false;

    /** @var bool */
    private $hasSharedInstances = false;

    /** @var Instance */
    private $instance;

    /** @var string */
    private $namespace;

    /** @var NewInstanceBuilder */
    private $newInstanceBuilder;

    /** @var string */
    private $methodPrefix;

    /** @var array */
    private $methodBodyBuilderInstancePool = array();

    /** @var string */
    private $fileName;

    /** @var string */
    private $filePath;

    /** @var array */
    private $useCollection = array();

    /** @var Uses */
    private $uses;
    //end of properties

    //begin of public methods
    /**
     * @return null|string
     */
    public function getClassName()
    {
        return $this->className;
    }

    /**
     * @param string $name
     * @return $this
     */
    public function setClassName($name)
    {
        $this->className = (string) $name;
        $this->fileName = $this->className . $this->getFileNameExtension();

        return $this;
    }

    /**
     * @return bool
     */
    public function createLocatorGeneratorInterface()
    {
        return $this->createLocatorGeneratorInterface;
    }

    /**
     * @param bool $flag
     * @return $this
     */
    public function setCreateLocatorGeneratorInterface($flag = false)
    {
        $this->createLocatorGeneratorInterface = (bool) $flag;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getFileName()
    {
        return $this->fileName;
    }

    /**
     * @return string
     */
    public function getFileNameExtension()
    {
        return '.php';
    }

    /**
     * @return null|string
     */
    public function getFilePath()
    {
        return $this->filePath;
    }

    /**
     * @param string $path
     * @return $this
     */
    public function setFilePath($path)
    {
        $this->filePath = (string) $path;

        return $this;
    }

    /**
     * @param Instance $instance
     * @return $this
     */
    public function setInstance(Instance $instance)
    {
        $this->instance = $instance;

        return $this;
    }

    /**
     * @param Uses $uses
     * @return $this
     */
    public function setUses(Uses $uses)
    {
        $this->uses = $uses;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    /**
     * @return bool
     */
    public function hasNamespace()
    {
        return (is_string($this->namespace));
    }

    /**
     * @param string $namespace
     * @return $this
     */
    public function setNamespace($namespace)
    {
        $namespace = trim((string) $namespace);

        if (strlen($namespace) > 0) {
            $this->namespace = $namespace;
        }

        return $this;
    }

    /**
     * @param string $methodPrefix
     * @return $this
     */
    public function setMethodPrefix($methodPrefix)
    {
        $this->methodPrefix = (string) $methodPrefix;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getMethodPrefix()
    {
        return $this->methodPrefix;
    }

    /**
     * @param string $className
     * @param bool $isFactory
     * @param bool $isShared
     * @param string $returnValue
     * @param string $alias
     * @param null|string $methodBodyBuilderClassName
     * @return $this
     * @throws RuntimeException
     */
    public function addInstance($className, $isFactory, $isShared, $returnValue, $alias, $methodBodyBuilderClassName = null)
    {
        $instance = $this->getNewInstance();

        if ($isFactory) {
            $this->enableHasFactoryInstances();
        }

        if ($isShared) {
            $this->hasSharedInstances = true;
        }

        $instance->setAlias($alias);
        $instance->setClassName($className);
        $instance->setIsFactory($isFactory);
        $instance->setIsShared($isShared);
        $instance->setReturnValue($returnValue);

        if (!is_null($methodBodyBuilderClassName)) {
            $methodBodyBuilder = $this->fetchFromMethodBodyBuilderInstancePool($methodBodyBuilderClassName);
            $methodBodyBuilder->setInstance($instance);
            $instance->setMethodBodyBuilder($methodBodyBuilder);
        } else {
            $instance = $this->tryToDetermineMethodBodyBuilder($instance);
        }

        $this->instances[] = $instance;

        return $this;
    }

    /**
     * @return array|Instance[]
     */
    public function getInstances()
    {
        return $this->instances;
    }

    /**
     * @return boolean
     */
    public function hasInstances()
    {
        return (!empty($this->instances));
    }

    /**
     * @return bool
     */
    public function hasFactoryInstances()
    {
        return $this->hasFactoryInstances;
    }

    /**
     * @return bool
     */
    public function hasSharedInstances()
    {
        return $this->hasSharedInstances;
    }

    /**
     * @param string $interfaceName
     * @return $this
     */
    public function addImplements($interfaceName)
    {
        $this->implements[] = $interfaceName;

        return $this;
    }

    /**
     * @return array
     */
    public function getImplements()
    {
        return $this->implements;
    }

    /**
     * @return boolean
     */
    public function hasImplements()
    {
        return (!empty($this->implements));
    }

    /**
     * @param string $className
     * @return $this
     */
    public function setExtends($className)
    {
        $this->extends = (string) $className;

        return $this;
    }

    /**
     * @return bool
     */
    public function hasExtends()
    {
        return (is_string($this->extends));
    }

    /**
     * @return null|string
     */
    public function getExtends()
    {
        return $this->extends;
    }

    /**
     * @param string $className
     * @param string $alias
     * @return $this
     */
    public function addUses($className, $alias = '')
    {
        $uses = $this->getNewUses();

        $uses->setAlias($alias);
        $uses->setClassName($className);

        $this->useCollection[] = $uses;

        return $this;
    }

    /**
     * @return bool
     */
    public function hasUses()
    {
        return (!empty($this->useCollection));
    }

    /**
     * @return array|Uses[]
     */
    public function getUseCollection()
    {
        return $this->useCollection;
    }

    /**
     * @param FetchFromFactoryInstancePoolBuilder $fetchFromFactoryInstancePoolBuilder
     * @return $this
     */
    public function setFetchFromFactoryInstancePoolBuilder(FetchFromFactoryInstancePoolBuilder $fetchFromFactoryInstancePoolBuilder)
    {
        $this->fetchFromFactoryInstancePoolBuilder = $fetchFromFactoryInstancePoolBuilder;

        return $this;
    }

    /**
     * @param FetchFromSharedInstancePoolBuilder $fetchFromSharedInstancePoolBuilder
     * @return $this
     */
    public function setFetchFromSharedInstancePoolBuilder(FetchFromSharedInstancePoolBuilder $fetchFromSharedInstancePoolBuilder)
    {
        $this->fetchFromSharedInstancePoolBuilder = $fetchFromSharedInstancePoolBuilder;

        return $this;
    }

    /**
     * @param FetchFromSharedInstancePoolOrCreateByFactoryBuilder $fetchFromSharedInstancePoolOrCreateByFactoryBuilder
     * @return $this
     */
    public function setFetchFromSharedInstancePoolOrCreateByFactoryBuilder(FetchFromSharedInstancePoolOrCreateByFactoryBuilder $fetchFromSharedInstancePoolOrCreateByFactoryBuilder)
    {
        $this->fetchFromSharedInstancePoolOrCreateByFactoryBuilder = $fetchFromSharedInstancePoolOrCreateByFactoryBuilder;

        return $this;
    }

    /**
     * @param NewInstanceBuilder $newInstanceBuilder
     * @return $this
     */
    public function setNewInstanceBuilder(NewInstanceBuilder $newInstanceBuilder)
    {
        $this->newInstanceBuilder = $newInstanceBuilder;

        return $this;
    }
    //end of public methods

    //begin of private methods
    /**
     * @return Uses
     */
    private function getNewUses()
    {
        return clone $this->uses;
    }

    /**
     * @return Instance
     */
    private function getNewInstance()
    {
        return clone $this->instance;
    }

    /**
     * @param Instance $instance
     * @return Instance
     * @throws RuntimeException
     */
    private function tryToDetermineMethodBodyBuilder(Instance $instance)
    {
        $isUniqueInvokableInstance              = ((!$instance->isFactory()) && (!$instance->isShared()));
        $isUniqueInvokableFactorizedInstance    = (($instance->isFactory()) && (!$instance->isShared()));
        $isSharedInvokableInstance              = ((!$instance->isFactory()) && ($instance->isShared()));
        $isSharedInvokableFactorizedInstance    = (($instance->isFactory()) && ($instance->isShared()));

        if ($isUniqueInvokableInstance) {
            $instance->setMethodBodyBuilder($this->newInstanceBuilder);
        } else if ($isUniqueInvokableFactorizedInstance) {
            $instance->setMethodBodyBuilder($this->fetchFromFactoryInstancePoolBuilder);
        } else if ($isSharedInvokableInstance) {
            $instance->setMethodBodyBuilder($this->fetchFromSharedInstancePoolBuilder);
        } else if ($isSharedInvokableFactorizedInstance) {
            $instance->setMethodBodyBuilder($this->fetchFromSharedInstancePoolOrCreateByFactoryBuilder);
        } else {
            throw new RuntimeException(
                'could not determine method body builder for instance.' . PHP_EOL .
                'please set a method_body_builder for following instance: ' . PHP_EOL .
                var_export($instance, true)
            );
        }

        return $instance;
    }

    /**
     * @param $methodBodyBuilderClassName
     * @return \Net\Bazzline\Component\Locator\MethodBodyBuilder\MethodBodyBuilderInterface
     * @throws RuntimeException
     */
    private function fetchFromMethodBodyBuilderInstancePool($methodBodyBuilderClassName)
    {
        $key = sha1($methodBodyBuilderClassName);

        if (!isset($this->methodBodyBuilderInstancePool[$key])) {
            if (class_exists($methodBodyBuilderClassName)) {
                $methodBodyBuilder = new $methodBodyBuilderClassName();
                if (!$methodBodyBuilder instanceof MethodBodyBuilderInterface) {
                    throw new RuntimeException(
                        'provided method body builder class name "' . $methodBodyBuilderClassName .
                        '" does not implements MethodBodyBuilderInterface'
                    );
                }
                $this->methodBodyBuilderInstancePool[$key] = $methodBodyBuilder;
            } else {
                throw new RuntimeException(
                    'provided method_body_builder_class_name "' . $methodBodyBuilderClassName . '" does not exists'
                );
            }
        }

        return $this->methodBodyBuilderInstancePool[$key];
    }

    private function enableHasFactoryInstances()
    {
        if (!$this->hasFactoryInstances) {
            $this->hasFactoryInstances = true;
            $this->addUses('Net\Bazzline\Component\Locator\FactoryInterface');
        }
    }
    //end of private methods
}
PHP Locator Generator Component by bazzline.net API documentation generated by ApiGen