SoapContainerBuilder::createSerializerBuilder() - Code Metrics - Inspection of "[WIP] Soap 1.2 support" - goetas-webservices/soap-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Asmir

created 2016-12-14 17:50 UTC

SoapContainerBuilder::createSerializerBuilder() A

↳ Parent: SoapContainerBuilder

Complexity

Conditions	3
Paths	2

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	0
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	11
nc	2
nop	2
crap	12

<?php
namespace GoetasWebservices\SoapServices\SoapClient\Builder;


use GoetasWebservices\SoapServices\SoapClient\DependencyInjection\Compiler\CleanupPass;
use GoetasWebservices\SoapServices\SoapClient\DependencyInjection\SoapClientExtension;
use GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler\BaseTypesHandler;
use GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler\XmlSchemaDateHandler;
use JMS\Serializer\Handler\HandlerRegistryInterface;
use JMS\Serializer\SerializerBuilder;
use Psr\Log\LoggerInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\DelegatingLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

class SoapContainerBuilder
{
    private $className = 'SoapClientContainer';
    private $classNs = 'SoapServicesStub';

    protected $configFile = 'config.yml';
    protected $extensions = [];
    protected $compilerPasses = [];

    /**
     * @var LoggerInterface
     */
    private $logger;

    public function __construct($configFile = null, LoggerInterface $logger = null)
    {
        $this->logger = $logger;
        $this->setConfigFile($configFile);
        $this->addExtension(new SoapClientExtension());
        $this->addCompilerPass(new CleanupPass());
    }

    public function setConfigFile($configFile)
    {
        $this->configFile = $configFile;
    }

    protected function addExtension(ExtensionInterface $extension)
    {
        $this->extensions[] = $extension;
    }

    protected function addCompilerPass(CompilerPassInterface $pass)
    {
        $this->compilerPasses[] = $pass;
    }

    public function setContainerClassName($fqcn)
    {
        $fqcn = strtr($fqcn, ['.' => '\\', '/' => '\\',]);
        $pos = strrpos($fqcn, '\\');
        $this->className = substr($fqcn, $pos + 1);
        $this->classNs = substr($fqcn, 0, $pos);
    }

    /**
     * @param array $metadata
     * @return ContainerBuilder
     */
    protected function getContainerBuilder(array $metadata = array())
    {
        $container = new ContainerBuilder();

        foreach ($this->extensions as $extension) {
            $container->registerExtension($extension);
        }

        foreach ($this->compilerPasses as $pass) {
            $container->addCompilerPass($pass);
        }

        $locator = new FileLocator('.');
        $loaders = array(
            new YamlFileLoader($container, $locator),
            new XmlFileLoader($container, $locator)
        );
        $delegatingLoader = new DelegatingLoader(new LoaderResolver($loaders));
        $delegatingLoader->load($this->configFile);


        // set the production soap metadata
        $container->setParameter('goetas_webservices.soap_common.metadata', $metadata);

        $container->compile();

        return $container;
    }

    /**
     * @param ContainerInterface $debugContainer
     * @return array
     */
    protected function fetchMetadata(ContainerInterface $debugContainer)
    {
        $metadataReader = $debugContainer->get('goetas_webservices.soap_common.metadata_loader.dev');
        $wsdlMetadata = $debugContainer->getParameter('goetas_webservices.soap_client.config')['metadata'];
        $metadata = [];
        foreach (array_keys($wsdlMetadata) as $uri) {
            $metadata[$uri] = $metadataReader->load($uri);
        }

        return $metadata;
    }

    public function getDebugContainer()
    {
        return $this->getContainerBuilder();
    }

    /**
     * @return ContainerInterface
     */
    public function getProdContainer()
    {
        $ref = new \ReflectionClass("{$this->classNs}\\{$this->className}");
        return $ref->newInstance();
    }

    /**
     * @param $dir
     * @param ContainerInterface $debugContainer
     */
    public function dumpContainerForProd($dir, ContainerInterface $debugContainer)
    {
        $metadata = $this->fetchMetadata($debugContainer);

        if (!$metadata) {

            throw new \Exception("Empty metadata can not be used for production");
        }
        $forProdContainer = $this->getContainerBuilder($metadata);
        $this->dump($forProdContainer, $dir);
    }

    private function dump(ContainerBuilder $container, $dir)
    {
        $dumper = new PhpDumper($container);
        $options = [
            'debug' => false,
            'class' => $this->className,
            'namespace' => $this->classNs
        ];

        if (!is_dir($dir)) {
            mkdir($dir, 0777, true);
        }

        file_put_contents($dir . '/' . $this->className . '.php', $dumper->dump($options));
    }

    /**
     * @param ContainerInterface $container
     * @param callable $callback
     * @return SerializerBuilder
     */
    public static function createSerializerBuilderFromContainer(ContainerInterface $container, callable $callback = null)
    {
        $destinations = $container->getParameter('goetas_webservices.xsd2php.config')['destinations_jms'];
        return self::createSerializerBuilder($destinations, $callback);
    }

    /**
     * @param array $jmsMetadata
     * @param callable $callback
     * @return SerializerBuilder
     */
    public static function createSerializerBuilder(array $jmsMetadata, callable $callback = null)
    {
        $serializerBuilder = SerializerBuilder::create();
        $serializerBuilder->configureHandlers(function (HandlerRegistryInterface $handler) use ($callback, $serializerBuilder) {
            $serializerBuilder->addDefaultHandlers();
            $handler->registerSubscribingHandler(new BaseTypesHandler()); // XMLSchema List handling
            $handler->registerSubscribingHandler(new XmlSchemaDateHandler()); // XMLSchema date handling
            if ($callback) {
                call_user_func($callback, $handler);
            }
        });


        foreach ($jmsMetadata as $php => $dir) {
            $serializerBuilder->addMetadataDir($dir, $php);
        }
        return $serializerBuilder;
    }
}



1			<?php
2			namespace GoetasWebservices\SoapServices\SoapClient\Builder;
3
4
5			use GoetasWebservices\SoapServices\SoapClient\DependencyInjection\Compiler\CleanupPass;
6			use GoetasWebservices\SoapServices\SoapClient\DependencyInjection\SoapClientExtension;
7			use GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler\BaseTypesHandler;
8			use GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler\XmlSchemaDateHandler;
9			use JMS\Serializer\Handler\HandlerRegistryInterface;
10			use JMS\Serializer\SerializerBuilder;
11			use Psr\Log\LoggerInterface;
12			use Symfony\Component\Config\FileLocator;
13			use Symfony\Component\Config\Loader\DelegatingLoader;
14			use Symfony\Component\Config\Loader\LoaderResolver;
15			use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
16			use Symfony\Component\DependencyInjection\ContainerBuilder;
17			use Symfony\Component\DependencyInjection\ContainerInterface;
18			use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
19			use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
20			use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
21			use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
22
23			class SoapContainerBuilder
24			{
25			private $className = 'SoapClientContainer';
26			private $classNs = 'SoapServicesStub';
27
28			protected $configFile = 'config.yml';
29			protected $extensions = [];
30			protected $compilerPasses = [];
31
32			/**
33			* @var LoggerInterface
34			*/
35			private $logger;
36
37			public function __construct($configFile = null, LoggerInterface $logger = null)
38			{
39			$this->logger = $logger;
40			$this->setConfigFile($configFile);
41			$this->addExtension(new SoapClientExtension());
42			$this->addCompilerPass(new CleanupPass());
43			}
44
45			public function setConfigFile($configFile)
46			{
47			$this->configFile = $configFile;
48			}
49
50			protected function addExtension(ExtensionInterface $extension)
51			{
52			$this->extensions[] = $extension;
53			}
54
55			protected function addCompilerPass(CompilerPassInterface $pass)
56			{
57			$this->compilerPasses[] = $pass;
58			}
59
60			public function setContainerClassName($fqcn)
61			{
62			$fqcn = strtr($fqcn, ['.' => '\\', '/' => '\\',]);
63			$pos = strrpos($fqcn, '\\');
64			$this->className = substr($fqcn, $pos + 1);
65			$this->classNs = substr($fqcn, 0, $pos);
66			}
67
68			/**
69			* @param array $metadata
70			* @return ContainerBuilder
71			*/
72			protected function getContainerBuilder(array $metadata = array())
73			{
74			$container = new ContainerBuilder();
75
76			foreach ($this->extensions as $extension) {
77			$container->registerExtension($extension);
78			}
79
80			foreach ($this->compilerPasses as $pass) {
81			$container->addCompilerPass($pass);
82			}
83
84			$locator = new FileLocator('.');
85			$loaders = array(
86			new YamlFileLoader($container, $locator),
87			new XmlFileLoader($container, $locator)
88			);
89			$delegatingLoader = new DelegatingLoader(new LoaderResolver($loaders));
90			$delegatingLoader->load($this->configFile);
91
92
93			// set the production soap metadata
94			$container->setParameter('goetas_webservices.soap_common.metadata', $metadata);
95
96			$container->compile();
97
98			return $container;
99			}
100
101			/**
102			* @param ContainerInterface $debugContainer
103			* @return array
104			*/
105			protected function fetchMetadata(ContainerInterface $debugContainer)
106			{
107			$metadataReader = $debugContainer->get('goetas_webservices.soap_common.metadata_loader.dev');
108			$wsdlMetadata = $debugContainer->getParameter('goetas_webservices.soap_client.config')['metadata'];
109			$metadata = [];
110			foreach (array_keys($wsdlMetadata) as $uri) {
111			$metadata[$uri] = $metadataReader->load($uri);
112			}
113
114			return $metadata;
115			}
116
117			public function getDebugContainer()
118			{
119			return $this->getContainerBuilder();
120			}
121
122			/**
123			* @return ContainerInterface
124			*/
125			public function getProdContainer()
126			{
127			$ref = new \ReflectionClass("{$this->classNs}\\{$this->className}");
128			return $ref->newInstance();
129			}
130
131			/**
132			* @param $dir
133			* @param ContainerInterface $debugContainer
134			*/
135			public function dumpContainerForProd($dir, ContainerInterface $debugContainer)
136			{
137			$metadata = $this->fetchMetadata($debugContainer);
138
139			if (!$metadata) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-16 15:40 UTC by Report Bug Copy Issue Report The expression `$metadata` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
140			throw new \Exception("Empty metadata can not be used for production");
141			}
142			$forProdContainer = $this->getContainerBuilder($metadata);
143			$this->dump($forProdContainer, $dir);
144			}
145
146			private function dump(ContainerBuilder $container, $dir)
147			{
148			$dumper = new PhpDumper($container);
149			$options = [
150			'debug' => false,
151			'class' => $this->className,
152			'namespace' => $this->classNs
153			];
154
155			if (!is_dir($dir)) {
156			mkdir($dir, 0777, true);
157			}
158
159			file_put_contents($dir . '/' . $this->className . '.php', $dumper->dump($options));
160			}
161
162			/**
163			* @param ContainerInterface $container
164			* @param callable $callback
165			* @return SerializerBuilder
166			*/
167			public static function createSerializerBuilderFromContainer(ContainerInterface $container, callable $callback = null)
168			{
169			$destinations = $container->getParameter('goetas_webservices.xsd2php.config')['destinations_jms'];
170			return self::createSerializerBuilder($destinations, $callback);
171			}
172
173			/**
174			* @param array $jmsMetadata
175			* @param callable $callback
176			* @return SerializerBuilder
177			*/
178			public static function createSerializerBuilder(array $jmsMetadata, callable $callback = null)
179			{
180			$serializerBuilder = SerializerBuilder::create();
181			$serializerBuilder->configureHandlers(function (HandlerRegistryInterface $handler) use ($callback, $serializerBuilder) {
182			$serializerBuilder->addDefaultHandlers();
183			$handler->registerSubscribingHandler(new BaseTypesHandler()); // XMLSchema List handling
184			$handler->registerSubscribingHandler(new XmlSchemaDateHandler()); // XMLSchema date handling
185			if ($callback) {
186			call_user_func($callback, $handler);
187			}
188			});
189
190
191			foreach ($jmsMetadata as $php => $dir) {
192			$serializerBuilder->addMetadataDir($dir, $php);
193			}
194			return $serializerBuilder;
195			}
196			}
197
198

goetas-webservices / soap-client

Pull Request — master (#6)

SoapContainerBuilder::createSerializerBuilder() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like