ConnectorFactory::createConnector() - Code Metrics - borfast/socializr - Measure and Improve Code Quality continuously with Scrutinizer

ConnectorFactory::createConnector() B
last analyzed 2017-07-01 12:21 UTC

↳ Parent: ConnectorFactory

Complexity

Conditions	6
Paths	17

Size

Total Lines	70
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	70
rs	8.5454
cc	6
eloc	33
nc	17
nop	7

How to fix Long Method

<?php
namespace Borfast\Socializr\Connectors;

use OAuth\Common\Http\Uri\Uri;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\Common\Http\Client\ClientInterface;
use OAuth\ServiceFactory;
use OAuth\Common\Consumer\CredentialsInterface;
use OAuth\Common\Http\Client\CurlClient;
use OAuth\Common\Consumer\Credentials;
use OAuth\Common\Service\ServiceInterface;

use Borfast\Socializr\Exceptions\InvalidProviderException;
use Borfast\Socializr\Exceptions\InvalidConfigurationException;

class ConnectorFactory
{
    /**
     * An array that will contain the configuration for the various providers
     * Socializr's connectors can use.
     * @var array
     */
    protected $config = [];


    /**
     * The ID on the social network we're connecting to.
     * @var string
     */
    protected $id;


    /**
     * The constructor for the ConnectorFactory.
     * @param array $config Contains the configuration for each provider.
     * @throws InvalidConfigurationException if $config has no 'providers' key.
     */
    public function __construct(array $config)
    {
        $this->config = $config;

        if (!array_key_exists('providers', $config)) {
            throw new InvalidConfigurationException;
        }
    }


    /**
     * Creates a Connector object for the given provider type. The $id parameter
     * may be null but should only be used like that when getting
     *
     * @param  string $provider The provider type you want.
     * @param  TokenStorageInterface $storage The storage for PHPoAuthLib.
     * @param  array $options
     * @param  string $id The ID we're connecting to.

     * @param  null|ClientInterface $http_client The HTTP client for PHPoAuthLib.
     * @param  null|ServiceFactory $service_factory The PHPoAuthLib service factory.
     * @param  null|CredentialsInterface $credentials The credentials for PHPoAuthLib.
     * @return ConnectorInterface An instance of the requested connector type.
     * @throws InvalidProviderException
     */
    public function createConnector(
        $provider,
        TokenStorageInterface $storage,
        array $options = [],
        $id = null,
        ClientInterface $http_client = null,
        ServiceFactory $service_factory = null,
        CredentialsInterface $credentials = null
    ) {
        // Only allow configured providers.
        if (!array_key_exists($provider, $this->config['providers'])) {
            throw new InvalidProviderException($provider);
        }

        // Default to CurlClient (why isn't this the default? :( )
        if (is_null($http_client)) {
            $http_client = new CurlClient;
        }

        // Just if we want to be lazy and not pass this as an argument.
        if (is_null($service_factory)) {
            $service_factory = new ServiceFactory;
        }

        // Simplify config access for this provider.
        $config = $this->getFlatConfig($provider);


        // We're already getting the credentials via $this->config, we might not
        // want to always pass them as an argument.
        if (is_null($credentials)) {
            $credentials = new Credentials(
                $config['consumer_key'],
                $config['consumer_secret'],
                $config['callback']
            );
        }

        // Let's make use of CurlClient.
        $service_factory->setHttpClient($http_client);

        // Temporary (or so I hope) hack to overcome PHPoAuthLib not being ready
        // for Facebook's Graph API 1.0 deprecation.

        // If this is Facebook, let's specify we want API v2.2
//        $api_version = null;
//        if (strtolower($provider) == 'facebook') {
//            $api_version = '2.2';
//        }
        $uri = null;
        if (in_array($provider, ['Facebook', 'FacebookGroup', 'FacebookPage'])) {
            $uri = new Uri('https://graph.facebook.com/v2.8/');
        }

        // Finally, create the service already!
        $service = $service_factory->createService(
            $config['service'],
            $credentials,
            $storage,
            $config['scopes'],
            $uri
            //$api_version
        );


        $connector_class = '\\Borfast\\Socializr\\Connectors\\'.$provider;
        $connector = new $connector_class($config, $service, $options, $id);

        return $connector;
    }


    /**
     * Gets a config array for the given provider, taking care of a few checks
     * to make sure it has the needed data.
     * @param  string $provider The provider type we want the config for.
     * @return array            The config for the requested provider type.
     */
    protected function getFlatConfig($provider)
    {
        $config = $this->config['providers'][$provider];

        /*
         * Make sure we will create the correct PHPoAuthLib service. Each
         * configured provider can specify which service to use. If none is
         * specified, then the provider name is used.
         */
        if (empty($config['service'])) {
            $config['service'] = $provider;
        }

        // Cater for the possibility of having one single general callback URL.
        if (empty($config['callback'])) {
            $config['callback'] = $this->config['callback'];
        }

        // Cater for the possibility of no scope being defined
        if (empty($config['scopes'])) {
            $config['scopes'] = [];
        }

        // Make it possible to define the scopes as a comma separated string
        // instead of an array.
        if (!is_array($config['scopes'])) {
            $config['scopes'] = explode(', ', $config['scopes']);
        }

        return $config;
    }
}


1			<?php
2			namespace Borfast\Socializr\Connectors;
3
4			use OAuth\Common\Http\Uri\Uri;
5			use OAuth\Common\Storage\TokenStorageInterface;
6			use OAuth\Common\Http\Client\ClientInterface;
7			use OAuth\ServiceFactory;
8			use OAuth\Common\Consumer\CredentialsInterface;
9			use OAuth\Common\Http\Client\CurlClient;
10			use OAuth\Common\Consumer\Credentials;
11			use OAuth\Common\Service\ServiceInterface;
12
13			use Borfast\Socializr\Exceptions\InvalidProviderException;
14			use Borfast\Socializr\Exceptions\InvalidConfigurationException;
15
16			class ConnectorFactory
17			{
18			/**
19			* An array that will contain the configuration for the various providers
20			* Socializr's connectors can use.
21			* @var array
22			*/
23			protected $config = [];
24
25
26			/**
27			* The ID on the social network we're connecting to.
28			* @var string
29			*/
30			protected $id;
31
32
33			/**
34			* The constructor for the ConnectorFactory.
35			* @param array $config Contains the configuration for each provider.
36			* @throws InvalidConfigurationException if $config has no 'providers' key.
37			*/
38			public function __construct(array $config)
39			{
40			$this->config = $config;
41
42			if (!array_key_exists('providers', $config)) {
43			throw new InvalidConfigurationException;
44			}
45			}
46
47
48			/**
49			* Creates a Connector object for the given provider type. The $id parameter
50			* may be null but should only be used like that when getting
51			*
52			* @param string $provider The provider type you want.
53			* @param TokenStorageInterface $storage The storage for PHPoAuthLib.
54			* @param array $options
55			* @param string $id The ID we're connecting to.
			0 ignored issues – show Documentation introduced 2015-12-08 22:41 UTC by Report Bug Copy Issue Report Should the type for parameter `$id` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
56			* @param null\|ClientInterface $http_client The HTTP client for PHPoAuthLib.
57			* @param null\|ServiceFactory $service_factory The PHPoAuthLib service factory.
58			* @param null\|CredentialsInterface $credentials The credentials for PHPoAuthLib.
59			* @return ConnectorInterface An instance of the requested connector type.
60			* @throws InvalidProviderException
61			*/
62			public function createConnector(
63			$provider,
64			TokenStorageInterface $storage,
65			array $options = [],
66			$id = null,
67			ClientInterface $http_client = null,
68			ServiceFactory $service_factory = null,
69			CredentialsInterface $credentials = null
70			) {
71			// Only allow configured providers.
72			if (!array_key_exists($provider, $this->config['providers'])) {
73			throw new InvalidProviderException($provider);
74			}
75
76			// Default to CurlClient (why isn't this the default? :( )
77			if (is_null($http_client)) {
78			$http_client = new CurlClient;
79			}
80
81			// Just if we want to be lazy and not pass this as an argument.
82			if (is_null($service_factory)) {
83			$service_factory = new ServiceFactory;
84			}
85
86			// Simplify config access for this provider.
87			$config = $this->getFlatConfig($provider);
88
89
90			// We're already getting the credentials via $this->config, we might not
91			// want to always pass them as an argument.
92			if (is_null($credentials)) {
93			$credentials = new Credentials(
94			$config['consumer_key'],
95			$config['consumer_secret'],
96			$config['callback']
97			);
98			}
99
100			// Let's make use of CurlClient.
101			$service_factory->setHttpClient($http_client);
102
103			// Temporary (or so I hope) hack to overcome PHPoAuthLib not being ready
104			// for Facebook's Graph API 1.0 deprecation.
105
106			// If this is Facebook, let's specify we want API v2.2
107			// $api_version = null;
108			// if (strtolower($provider) == 'facebook') {
109			// $api_version = '2.2';
110			// }
111			$uri = null;
112			if (in_array($provider, ['Facebook', 'FacebookGroup', 'FacebookPage'])) {
113			$uri = new Uri('https://graph.facebook.com/v2.8/');
114			}
115
116			// Finally, create the service already!
117			$service = $service_factory->createService(
118			$config['service'],
119			$credentials,
120			$storage,
121			$config['scopes'],
122			$uri
123			//$api_version
124			);
125
126
127			$connector_class = '\\Borfast\\Socializr\\Connectors\\'.$provider;
128			$connector = new $connector_class($config, $service, $options, $id);
129
130			return $connector;
131			}
132
133
134			/**
135			* Gets a config array for the given provider, taking care of a few checks
136			* to make sure it has the needed data.
137			* @param string $provider The provider type we want the config for.
138			* @return array The config for the requested provider type.
139			*/
140			protected function getFlatConfig($provider)
141			{
142			$config = $this->config['providers'][$provider];
143
144			/*
145			* Make sure we will create the correct PHPoAuthLib service. Each
146			* configured provider can specify which service to use. If none is
147			* specified, then the provider name is used.
148			*/
149			if (empty($config['service'])) {
150			$config['service'] = $provider;
151			}
152
153			// Cater for the possibility of having one single general callback URL.
154			if (empty($config['callback'])) {
155			$config['callback'] = $this->config['callback'];
156			}
157
158			// Cater for the possibility of no scope being defined
159			if (empty($config['scopes'])) {
160			$config['scopes'] = [];
161			}
162
163			// Make it possible to define the scopes as a comma separated string
164			// instead of an array.
165			if (!is_array($config['scopes'])) {
166			$config['scopes'] = explode(', ', $config['scopes']);
167			}
168
169			return $config;
170			}
171			}
172

borfast / socializr

ConnectorFactory::createConnector() B last analyzed 2017-07-01 12:21 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ConnectorFactory::createConnector() B
last analyzed 2017-07-01 12:21 UTC