Overview

Namespaces

  • JP
    • LeanMapperExtension

Classes

  • JP\LeanMapperExtension\LeanMapperExtension
  • JP\LeanMapperExtension\Mapper

Interfaces

  • JP\LeanMapperExtension\IEntityProvider
  • 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: 
<?php
    /**
     * @author      Jan Pecha, <janpecha@email.cz>
     */

    namespace JP\LeanMapperExtension;
    use Nette\DI\ServiceDefinition;
    use Nette\DI\ContainerBuilder;
    use Nette;

    class LeanMapperExtension extends \Nette\DI\CompilerExtension
    {
        public $defaults = array(
            # services
            'mapper' => 'JP\LeanMapperExtension\Mapper',
            'entityFactory' => 'LeanMapper\DefaultEntityFactory',
            'connection' => 'LeanMapper\Connection',
            'defaultEntityNamespace' => NULL,

            # connection
            'host' => 'localhost',
            'driver' => 'mysqli',
            'username' => NULL,
            'password' => NULL,
            'database' => NULL,
            'lazy' => TRUE,

            # entities
            'entities' => NULL,
        );


        public function loadConfiguration()
        {
            $config = $this->getConfig($this->defaults);
            $builder = $this->getContainerBuilder();

            // config alias for 'username'
            if (!isset($config['username']) && isset($config['user'])) {
                $config['username'] = $config['user'];
            }
            unset($config['user']);

            // use profiler?
            $useProfiler = isset($config['profiler'])
                ? $config['profiler']
                : class_exists('Tracy\Debugger') && $builder->parameters['debugMode'];

            unset($config['profiler']);

            // Services
            $connection = $this->configConnection($builder, $config);
            $mapper = $this->configMapper($builder, $config);

            $builder->addDefinition($this->prefix('entityFactory'))
                ->setClass($config['entityFactory']);

            // profiler
            if ($useProfiler) {
                $panel = $builder->addDefinition($this->prefix('panel'))
                    ->setClass('Dibi\Bridges\Tracy\Panel');

                $connection->addSetup(array($panel, 'register'), array($connection));
            }
        }


        /**
         * Adds connection service into container
         * @return ServiceDefinition
         */
        protected function configConnection(ContainerBuilder $builder, array $config)
        {
            if (!isset($config['connection']) || !is_string($config['connection'])) {
                throw new \RuntimeException('Connection class definition is missing, or not (string).');
            }

            return $builder->addDefinition($this->prefix('connection'))
                ->setClass($config['connection'], array(
                    array(
                        'host' => $config['host'],
                        'driver' => $config['driver'],
                        'username' => $config['username'],
                        'password' => $config['password'],
                        'database' => $config['database'],
                        'lazy' => (bool) $config['lazy'],
                    ),
                ));
        }


        /**
         * Adds mapper service into container
         * @return ServiceDefinition
         */
        protected function configMapper(ContainerBuilder $builder, array $config)
        {
            if ($config['defaultEntityNamespace'] !== NULL && !is_string($config['defaultEntityNamespace'])) {
                throw new \RuntimeException('DefaultEntityNamespace must be NULL or string, ' . gettype($config['defaultEntityNamespace']) . ' given');
            }

            $mapper = $builder->addDefinition($this->prefix('mapper'))
                ->setClass($config['mapper'], array($config['defaultEntityNamespace']));

            $this->processEntityProviders($mapper, $config);
            $this->processUserEntities($mapper, $config);

            return $mapper;
        }


        /**
         * Processes user entities definitions + registers repositories in container
         * @return void
         */
        protected function processUserEntities(ServiceDefinition $mapper, array $config)
        {
            $builder = $this->getContainerBuilder();

            if (isset($config['entities'])) {
                if (!is_array($config['entities'])) {
                    throw new \RuntimeException('List of entities must be array, ' . gettype($config['entities']) . ' given');
                }

                foreach ($config['entities'] as $tableName => $mapping) {
                    if (isset($mapping['repository']) && !is_string($mapping['repository'])) {
                        throw new \RuntimeException('Repository class must be string or NULL, ' . gettype($mapping['primaryKey']) . ' given');
                    }

                    if (is_string($mapping)) { // entity class
                        $mapping = array(
                            'entity' => $mapping,
                        );
                    }

                    $mapping['table'] = $tableName;
                    $this->registerInMapper($mapper, $mapping);

                    // auto-register of repository in Container
                    if (isset($mapping['repository'])) {
                        $this->registerRepositoryInContainer($builder, $mapping['repository']);
                    }
                }
            }
        }


        /**
         * @see    https://github.com/Kdyby/Doctrine/blob/6fc930a79ecadca326722f1c53cab72d56ee2a90/src/Kdyby/Doctrine/DI/OrmExtension.php#L255-L278
         * @see    http://forum.nette.org/en/18888-extending-extensions-solid-modular-concept
         */
        protected function processEntityProviders(ServiceDefinition $mapper, array $config)
        {
            $builder = $this->getContainerBuilder();

            foreach ($this->compiler->getExtensions() as $extension) {
                if ($extension instanceof IEntityProvider) {
                    $mappings = $extension->getEntityMappings();

                    if (!is_array($mappings) && !is_null($mappings)) {
                        throw new \InvalidArgumentException('Mappings must be array or NULL, '. gettype($mapping) . ' given.');
                    }

                    if (is_array($mappings)) {
                        foreach ($mappings as $mapping) {
                            if (!is_array($mappings) && !is_null($mappings)) {
                                throw new \InvalidArgumentException('Entity mapping must be array or NULL, '. gettype($mapping) . ' given.');
                            }
                            $this->registerInMapper($mapper, $mapping);

                            if (isset($mapping['repository']) && (!isset($mapping['registerRepository']) || $mapping['registerRepository'])) {
                                $this->registerRepositoryInContainer($builder, $mapping['repository']);
                            }
                        }
                    }
                }
            }
        }


        protected function registerRepositoryInContainer($builder, $repositoryClass)
        {
            if (!is_string($repositoryClass)) {
                throw new \RuntimeException('RepositoryClass must be string, ');
            }
            $repository = strtr($repositoryClass, '\\', '_');
            $builder->addDefinition("repositories.$repository")
                ->setClass($repositoryClass);
        }


        /**
         * Registers new entity in mapper
         * @param  ServiceDefinition
         * @param  array  [table => '', primaryKey => '', entity => '', repository => '']
         * @return void
         */
        protected function registerInMapper(ServiceDefinition $mapper, array $mapping = NULL)
        {
            if ($mapping === NULL) {
                return;
            }

            if (!isset($mapping['table']) || !is_string($mapping['table'])) {
                throw new \InvalidArgumentException('Table name missing or it\'s not string');
            }

            if (!isset($mapping['entity']) || !is_string($mapping['entity'])) {
                throw new \InvalidArgumentException('Entity class missing or it\'s not string');
            }

            $repositoryClass = isset($mapping['repository']) ? $mapping['repository'] : NULL;
            $primaryKey = isset($mapping['primaryKey']) ? $mapping['primaryKey'] : NULL;

            if (!is_string($repositoryClass) && !is_null($repositoryClass)) {
                throw new \InvalidArgumentException('Repository class must be string or NULL, ' . gettype($repositoryClass) . ' given');
            }

            if (!is_string($primaryKey) && !is_null($primaryKey)) {
                throw new \InvalidArgumentException('Primary key must be string or NULL, ' . gettype($primaryKey) . ' given');
            }

            $mapper->addSetup('register', array($mapping['table'], $mapping['entity'], $repositoryClass, $primaryKey));
        }


        /**
         * @param  Nette\Configurator
         * @param  string
         * @return void
         */
        public static function register(Nette\Configurator $configurator, $name = 'leanmapper')
        {
            $configurator->onCompile[] = function ($config, Nette\DI\Compiler $compiler) use ($name) {
                $compiler->addExtension($name, new LeanMapperExtension());
            };
        }
    }

janpecha/leanmapper-extension v0.9.0 API documentation API documentation generated by ApiGen