Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.0][Configuration] Cleanup bundle configuration. #325

Merged
merged 1 commit into from
Mar 6, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 65 additions & 6 deletions DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,58 @@

namespace Liip\ImagineBundle\DependencyInjection;

use Liip\ImagineBundle\DependencyInjection\Factory\Loader\LoaderFactoryInterface;
use Liip\ImagineBundle\DependencyInjection\Factory\Resolver\ResolverFactoryInterface;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
/**
* Generates the configuration tree.
*
* @return TreeBuilder
* @var ResolverFactoryInterface[]
*/
protected $resolversFactories;

/**
* @var LoaderFactoryInterface[]
*/
protected $loadersFactories;

/**
* @param ResolverFactoryInterface[] $resolversFactories
* @param LoaderFactoryInterface[] $loadersFactories
*/
public function __construct(array $resolversFactories, array $loadersFactories)
{
$this->resolversFactories = $resolversFactories;
$this->loadersFactories = $loadersFactories;
}

/**
* {@inheritDoc}
*/
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('liip_imagine', 'array');

$resolversPrototypeNode = $rootNode
->children()
->arrayNode('resolvers')
->useAttributeAsKey('name')
->prototype('array')
;
$this->addResolversSections($resolversPrototypeNode);

$loadersPrototypeNode = $rootNode
->children()
->arrayNode('loaders')
->useAttributeAsKey('name')
->prototype('array')
;
$this->addLoadersSections($loadersPrototypeNode);

$rootNode
->fixXmlConfig('format', 'formats')
->fixXmlConfig('filter_set', 'filter_sets')
Expand All @@ -27,10 +64,8 @@ public function getConfigTreeBuilder()
->thenInvalid('Invalid imagine driver specified: %s')
->end()
->end()
->scalarNode('web_root')->defaultValue('%kernel.root_dir%/../web')->end()
->scalarNode('data_root')->defaultValue('%liip_imagine.web_root%')->end()
->scalarNode('cache_prefix')->defaultValue('/media/cache')->end()
->scalarNode('cache')->defaultValue('web_path')->end()
->scalarNode('cache')->defaultValue('default')->end()
->scalarNode('cache_base_path')->defaultValue('')->end()
->scalarNode('data_loader')->defaultValue('filesystem')->end()
->scalarNode('controller_action')->defaultValue('liip_imagine.controller:filterAction')->end()
Expand Down Expand Up @@ -71,4 +106,28 @@ public function getConfigTreeBuilder()

return $treeBuilder;
}

/**
* @param ArrayNodeDefinition $resolversPrototypeNode
*/
protected function addResolversSections(ArrayNodeDefinition $resolversPrototypeNode)
{
foreach ($this->resolversFactories as $factory) {
$factory->addConfiguration(
$resolversPrototypeNode->children()->arrayNode($factory->getName())
);
}
}

/**
* @param ArrayNodeDefinition $resolversPrototypeNode
*/
protected function addLoadersSections(ArrayNodeDefinition $resolversPrototypeNode)
{
foreach ($this->loadersFactories as $factory) {
$factory->addConfiguration(
$resolversPrototypeNode->children()->arrayNode($factory->getName())
);
}
}
}
33 changes: 33 additions & 0 deletions DependencyInjection/Factory/Loader/LoaderFactoryInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace Liip\ImagineBundle\DependencyInjection\Factory\Loader;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;

interface LoaderFactoryInterface
{
/**
* @param ContainerBuilder $container
* @param string $loaderName
* @param array $config
*
* @return string The resolver service id
*/
public function create(ContainerBuilder $container, $loaderName, array $config);

/**
* The resolver factory name,
* For example filesystem, stream
*
* @return string
*/
public function getName();

/**
* @param ArrayNodeDefinition $builder
*
* @return void
*/
public function addConfiguration(ArrayNodeDefinition $builder);
}
57 changes: 57 additions & 0 deletions DependencyInjection/Factory/Loader/StreamLoaderFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php
/**
* Created by PhpStorm.
* User: makasim
* Date: 2/21/14
* Time: 4:44 PM
*/

namespace Liip\ImagineBundle\DependencyInjection\Factory\Loader;


use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\DefinitionDecorator;

class StreamLoaderFactory implements LoaderFactoryInterface
{
/**
* {@inheritDoc}
*/
public function create(ContainerBuilder $container, $loaderName, array $config)
{
$loaderDefinition = new DefinitionDecorator('liip_imagine.data.loader.prototype.stream');
$loaderDefinition->replaceArgument(0, $config['wrapper']);
$loaderDefinition->replaceArgument(1, $config['context']);
$loaderDefinition->addTag('liip_imagine.data.loader', array(
'loader' => $loaderName
));
$loaderId = 'liip_imagine.data.loader.'.$loaderName;

$container->setDefinition($loaderId, $loaderDefinition);

return $loaderId;
}

/**
* {@inheritDoc}
*/
public function getName()
{
return 'stream';
}

/**
* {@inheritDoc}
*/
public function addConfiguration(ArrayNodeDefinition $builder)
{
$builder
->addDefaultsIfNotSet()
->children()
->scalarNode('wrapper')->isRequired()->cannotBeEmpty()->end()
->scalarNode('context')->defaultValue(null)->end()
->end()
;
}
}
83 changes: 83 additions & 0 deletions DependencyInjection/Factory/Resolver/AwsS3ResolverFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php

namespace Liip\ImagineBundle\DependencyInjection\Factory\Resolver;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Reference;

class AwsS3ResolverFactory implements ResolverFactoryInterface
{
/**
* {@inheritDoc}
*/
public function create(ContainerBuilder $container, $resolverName, array $config)
{
$awsS3ClientDefinition = new Definition('Aws\S3\S3Client');
$awsS3ClientDefinition->setFactoryClass('Aws\S3\S3Client');
$awsS3ClientDefinition->setFactoryMethod('factory');
$awsS3ClientDefinition->addArgument($config['client_config']);
$awsS3ClientId = 'liip_imagine.cache.resolver.'.$resolverName.'.client';
$container->setDefinition($awsS3ClientId, $awsS3ClientDefinition);

$resolverDefinition = new DefinitionDecorator('liip_imagine.cache.resolver.prototype.aws_s3');
$resolverDefinition->replaceArgument(0, new Reference($awsS3ClientId));
$resolverDefinition->replaceArgument(1, $config['bucket']);
$resolverDefinition->replaceArgument(2, $config['acl']);
$resolverDefinition->replaceArgument(3, $config['url_options']);
$resolverId = 'liip_imagine.cache.resolver.'.$resolverName;
$container->setDefinition($resolverId, $resolverDefinition);

if ($config['cache']) {
$internalResolverId = 'liip_imagine.cache.resolver.'.$resolverName.'.internal';

$container->setDefinition($internalResolverId, $resolverDefinition);

$cacheResolverDefinition = new DefinitionDecorator('liip_imagine.cache.resolver.prototype.cache');
$cacheResolverDefinition->replaceArgument(0, new Reference($config['cache']));
$cacheResolverDefinition->replaceArgument(1, new Reference($internalResolverId));

$container->setDefinition($resolverId, $cacheResolverDefinition);
}

$container->getDefinition($resolverId)->addTag('liip_imagine.cache.resolver', array(
'resolver' => $resolverName
));

return $resolverId;
}

/**
* {@inheritDoc}
*/
public function getName()
{
return 'aws_s3';
}

/**
* {@inheritDoc}
*/
public function addConfiguration(ArrayNodeDefinition $builder)
{
$builder
->addDefaultsIfNotSet()
->children()
->scalarNode('bucket')->isRequired()->cannotBeEmpty()->end()
->scalarNode('cache')->defaultValue(false)->end()
->scalarNode('acl')->defaultValue('public-read')->cannotBeEmpty()->end()
->arrayNode('client_config')
->isRequired()
->useAttributeAsKey('key')
->prototype('scalar')->end()
->end()
->arrayNode('url_options')
->useAttributeAsKey('key')
->prototype('scalar')->end()
->end()
->end()
;
}
}
33 changes: 33 additions & 0 deletions DependencyInjection/Factory/Resolver/ResolverFactoryInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace Liip\ImagineBundle\DependencyInjection\Factory\Resolver;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;

interface ResolverFactoryInterface
{
/**
* @param ContainerBuilder $container
* @param string $resolverName
* @param array $config
*
* @return string The resolver service id
*/
public function create(ContainerBuilder $container, $resolverName, array $config);

/**
* The resolver factory name,
* For example web_path, aws_s3 o amazon_s3
*
* @return string
*/
public function getName();

/**
* @param ArrayNodeDefinition $builder
*
* @return void
*/
public function addConfiguration(ArrayNodeDefinition $builder);
}
50 changes: 50 additions & 0 deletions DependencyInjection/Factory/Resolver/WebPathResolverFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace Liip\ImagineBundle\DependencyInjection\Factory\Resolver;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;

class WebPathResolverFactory implements ResolverFactoryInterface
{
/**
* {@inheritDoc}
*/
public function create(ContainerBuilder $container, $resolverName, array $config)
{
$resolverDefinition = new DefinitionDecorator('liip_imagine.cache.resolver.prototype.web_path');
$resolverDefinition->replaceArgument(2, $config['web_root']);
$resolverDefinition->replaceArgument(3, $config['cache_prefix']);
$resolverDefinition->addTag('liip_imagine.cache.resolver', array(
'resolver' => $resolverName
));
$resolverId = 'liip_imagine.cache.resolver.'.$resolverName;

$container->setDefinition($resolverId, $resolverDefinition);

return $resolverId;
}

/**
* {@inheritDoc}
*/
public function getName()
{
return 'web_path';
}

/**
* {@inheritDoc}
*/
public function addConfiguration(ArrayNodeDefinition $builder)
{
$builder
->addDefaultsIfNotSet()
->children()
->scalarNode('web_root')->defaultValue('%kernel.root_dir%/../web')->cannotBeEmpty()->end()
->scalarNode('cache_prefix')->defaultValue('media/cache')->cannotBeEmpty()->end()
->end()
;
}
}
Loading