Overview

Namespaces

  • Net
    • Bazzline
      • Propel
        • Behavior
          • EntityInstantiator
  • None

Classes

  • AddToEntityInstantiatorBehavior
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\AbstractEntity
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\Configuration
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\EntityCollection
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\FileContentGenerator
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\Manager
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\ObjectEntity
  • Net\Bazzline\Propel\Behavior\EntityInstantiator\QueryEntity
  • 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: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-09-19
 */
namespace Net\Bazzline\Propel\Behavior\EntityInstantiator;

use InvalidArgumentException;

class Configuration
{
    /** @var string */
    private $className;

    /** @var null|string */
    private $defaultConnectionMode;

    /** @var null|string */
    private $defaultConnectionName;

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

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

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

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

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

    /** @var bool */
    private $useFullyQualifiedNames;

    /**
     * @param string $className
     * @param string $indention
     * @param string $pathToOutput
     * @param null|string $namespace
     * @param null|string $extends
     * @param null|string $defaultConnectionMode
     * @param null|string $defaultConnectionName
     * @param null|bool $useFullyQualifiedNames
     * @throws InvalidArgumentException
     */
    public function configure(
        $className,
        $indention,
        $pathToOutput,
        $namespace = null,
        $extends = null,
        $defaultConnectionMode = null,
        $defaultConnectionName = null,
        $useFullyQualifiedNames = null
    ) {
        $this->setClassName($className);

        if (!is_null($extends)) {
            $this->setExtends($extends);
        }

        $this->setIndention($indention);

        if (!is_null($namespace)) {
            $this->setNamespace($namespace);
        }

        if (!is_null($defaultConnectionMode)) {
            $this->setDefaultConnectionMode($defaultConnectionMode);
        } else {
            $this->setDefaultConnectionMode('Propel::CONNECTION_WRITE');
        }

        if (!is_null($defaultConnectionName)) {
            $this->setDefaultConnectionName('\'' . $defaultConnectionName . '\'');
        } else {
            $this->setDefaultConnectionName('null');
        }

        if (!is_null($useFullyQualifiedNames)) {
            $this->setUseFullyQualifiedName($useFullyQualifiedNames);
        } else {
            $this->setUseFullyQualifiedName(false);
        }

        $this->tryToCreatePathNameToFileOutputOrThrowInvalidArgumentException($pathToOutput);
        $this->isConfigured = true;
    }

    /**
     * @return bool
     */
    public function doNotUseFullyQualifiedNames()
    {
        return ($this->useFullyQualifiedNames === false);
    }

    /**
     * @return string
     */
    public function getClassName()
    {
        return $this->className;
    }

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

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

    /**
     * @return string
     */
    public function getIndention()
    {
        return $this->indention;
    }

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

    /**
     * @return string
     */
    public function getFilePathToOutput()
    {
        return $this->filePathToOutput;
    }

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

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

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

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

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

    /**
     * @param string $className
     * @throws InvalidArgumentException
     */
    private function setClassName($className)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($className);
        $this->className = $className;
    }

    /**
     * @param string $defaultConnectionMode
     * @throws InvalidArgumentException
     */
    private function setDefaultConnectionMode($defaultConnectionMode)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($defaultConnectionMode);
        $this->defaultConnectionMode = $defaultConnectionMode;
    }

    /**
     * @param string $defaultConnectionName
     * @throws InvalidArgumentException
     */
    private function setDefaultConnectionName($defaultConnectionName)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($defaultConnectionName);
        $this->defaultConnectionName = $defaultConnectionName;
    }

    /**
     * @param string $extends
     * @throws InvalidArgumentException
     */
    private function setExtends($extends)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($extends);
        $this->extends = $extends;
    }

    /**
     * @param string $indention
     * @throws InvalidArgumentException
     */
    private function setIndention($indention)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($indention);
        $this->indention = $indention;
    }

    /**
     * @param string $namespace
     * @throws InvalidArgumentException
     */
    private function setNamespace($namespace)
    {
        $this->throwInvalidArgumentExceptionIfStringIsNotValid($namespace);
        $this->namespace = $namespace;
    }

    /**
     * @param $useFullyQualifiedName
     * @throws InvalidArgumentException
     */
    private function setUseFullyQualifiedName($useFullyQualifiedName)
    {
        if (!is_bool($useFullyQualifiedName)) {
            throw new InvalidArgumentException(
                'provided variable must be a boolean "' . var_export($useFullyQualifiedName, true) . '"" given'
            );
        }
        $this->useFullyQualifiedNames = $useFullyQualifiedName;
    }

    /**
     * @param string $string
     * @throws InvalidArgumentException
     */
    private function throwInvalidArgumentExceptionIfStringIsNotValid($string)
    {
        if (!is_string($string)) {
            throw new InvalidArgumentException(
                'provided variable must be a string "' . var_export($string, true) . '"" given'
            );
        }

        if (strlen($string) < 1) {
            throw new InvalidArgumentException(
                'provided string must contain at least one character'
            );
        }
    }

    /**
     * @param string $path
     * @throws InvalidArgumentException
     */
    private function tryToCreatePathNameToFileOutputOrThrowInvalidArgumentException($path)
    {
        if (!is_dir($path)) {
            throw new InvalidArgumentException(
                'provided path "' . $path . '" is not a directory'
            );
        }

        if (!is_writable($path)) {
            throw new InvalidArgumentException(
                'provided path "' . $path . '" is not writable'
            );
        }

        $this->filePathToOutput = $path . DIRECTORY_SEPARATOR . $this->className . '.php';
    }
}
PHP EntityInstantiator Propel Behavior by bazzline.net API documentation generated by ApiGen