TwitterEmbedTweetBlockService::__construct() - Code Metrics - Inspection of "Suggest HTTPlug instead of Guzzle implementation" - sonata-project/SonataSeoBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#161)

by Christian

created 2019-01-16 16:57 UTC

TwitterEmbedTweetBlockService::__construct() A

↳ Parent: TwitterEmbedTweetBlockService

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	4

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\SeoBundle\Block\Social;

use GuzzleHttp\Exception\GuzzleException;
use Http\Client\Exception;
use Http\Client\HttpClient;
use Http\Message\MessageFactory;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\BlockBundle\Block\BlockContextInterface;
use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\CoreBundle\Form\Type\ImmutableArrayType;
use Sonata\CoreBundle\Model\Metadata;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\IntegerType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * This block service allows to embed a tweet by requesting the Twitter API.
 *
 * @see https://dev.twitter.com/docs/api/1/get/statuses/oembed
 *
 * @author Hugo Briand <[email protected]>
 */
class TwitterEmbedTweetBlockService extends BaseTwitterButtonBlockService
{
    public const TWITTER_OEMBED_URI = 'https://api.twitter.com/1/statuses/oembed.json';
    public const TWEET_URL_PATTERN = '%^(https://)(www.)?(twitter.com/)(.*)(/status)(es)?(/)([0-9]*)$%i';
    public const TWEET_ID_PATTERN = '%^([0-9]*)$%';

    /**
     * @var HttpClient|null
     */
    private $httpClient;

    /**
     * @var MessageFactory|null
     */
    private $messageFactory;

    public function __construct(?string $name, EngineInterface $templating, HttpClient $httpClient = null, MessageFactory $messageFactory = null)
    {
        parent::__construct($name, $templating);

        $this->httpClient = $httpClient;
        $this->messageFactory = $messageFactory;
    }

    public function execute(BlockContextInterface $blockContext, Response $response = null): Response
    {
        return $this->renderResponse($blockContext->getTemplate(), [
            'block' => $blockContext->getBlock(),
            'tweet' => $this->loadTweet($blockContext),
        ], $response);
    }

    /**
     * {@inheritdoc}
     */
    public function configureSettings(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'template' => '@SonataSeo/Block/block_twitter_embed.html.twig',
            'tweet' => '',
            'maxwidth' => null,
            'hide_media' => false,
            'hide_thread' => false,
            'omit_script' => false,
            'align' => 'none',
            'related' => null,
            'lang' => null,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function buildEditForm(FormMapper $form, BlockInterface $block)
    {
        $form->add('settings', ImmutableArrayType::class, [
            'keys' => [
                ['tweet', TextareaType::class, [
                    'required' => true,
                    'label' => 'form.label_tweet',
                    'sonata_help' => 'form.help_tweet',
                ]],
                ['maxwidth', IntegerType::class, [
                    'required' => false,
                    'label' => 'form.label_maxwidth',
                    'sonata_help' => 'form.help_maxwidth',
                ]],
                ['hide_media', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_hide_media',
                    'sonata_help' => 'form.help_hide_media',
                ]],
                ['hide_thread', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_hide_thread',
                    'sonata_help' => 'form.help_hide_thread',
                ]],
                ['omit_script', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_omit_script',
                    'sonata_help' => 'form.help_omit_script',
                ]],
                ['align', ChoiceType::class, [
                    'required' => false,
                    'choices' => [
                        'left' => 'form.label_align_left',
                        'right' => 'form.label_align_right',
                        'center' => 'form.label_align_center',
                        'none' => 'form.label_align_none',
                    ],
                    'label' => 'form.label_align',
                ]],
                ['related', TextType::class, [
                    'required' => false,
                    'label' => 'form.label_related',
                    'sonata_help' => 'form.help_related',
                ]],
                ['lang', ChoiceType::class, [
                    'required' => true,
                    'choices' => $this->languageList,
                    'label' => 'form.label_lang',
                ]],
            ],
            'translation_domain' => 'SonataSeoBundle',
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockMetadata($code = null)
    {
        return new Metadata($this->getName(), (null !== $code ? $code : $this->getName()), false, 'SonataSeoBundle', [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'class' => 'fa fa-twitter',
        ]);
    }

    /**
     * Returns supported API parameters from settings.
     *
     * @return array
     */
    protected function getSupportedApiParams()
    {
        return [
            'maxwidth',
            'hide_media',
            'hide_thread',
            'omit_script',
            'align',
            'related',
            'lang',
            'url',
            'id',
        ];
    }

    /**
     * Builds the API query URI based on $settings.
     *
     * @param bool  $uriMatched
     * @param array $settings
     *
     * @return string
     */
    protected function buildUri($uriMatched, array $settings)
    {
        $apiParams = $settings;
        $supportedParams = $this->getSupportedApiParams();

        if ($uriMatched) {
            // We matched the uri
            $apiParams['url'] = $settings['tweet'];
        } else {
            $apiParams['id'] = $settings['tweet'];
        }

        unset($apiParams['tweet']);

        $parameters = [];
        foreach ($apiParams as $key => $value) {
            if ($value && \in_array($key, $supportedParams)) {
                $parameters[] = $key.'='.$value;
            }
        }

        return sprintf('%s?%s', self::TWITTER_OEMBED_URI, implode('&', $parameters));
    }

    /**
     * Loads twitter tweet.
     */
    private function loadTweet(BlockContextInterface $blockContext): ?string
    {
        $uriMatched = preg_match(self::TWEET_URL_PATTERN, $blockContext->getSetting('tweet'));

        if (!$uriMatched || !preg_match(self::TWEET_ID_PATTERN, $blockContext->getSetting('tweet'))) {
            return null;
        }

        if (null !== $this->httpClient && null !== $this->messageFactory) {
            try {
                $response = $this->httpClient->sendRequest(
                    $this->messageFactory->createRequest(
                        'GET',
                        $this->buildUri($uriMatched, $blockContext->getSettings())
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    )
                );
            } catch (Exception $e) {
                // log error
                return null;
            }

            $apiTweet = json_decode($response->getBody(), true);

            return $apiTweet['html'];
        }

        // NEXT_MAJOR: Remove the old guzzle implementation

        // We matched an URL or an ID, we'll need to ask the API
        if (false === class_exists('GuzzleHttp\Client')) {
            throw new \RuntimeException(
                'The guzzle http client library is required to call the Twitter API.'.
                'Make sure to add php-http/httplug-bundle or guzzlehttp/guzzle to your composer.json.'
            );
        }

        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The direct Guzzle implementation is deprecated since 2.x and will be removed with the next major release.',
            E_USER_DEPRECATED
        );

        // TODO cache API result
        $client = new \GuzzleHttp\Client();
        $client->setConfig(['curl.options' => [CURLOPT_CONNECTTIMEOUT_MS => 1000]]);

        try {
            $request = $client->get($this->buildUri($uriMatched, $blockContext->getSettings()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $apiTweet = json_decode($request->send()->getBody(true), true);


            return $apiTweet['html'];
        } catch (GuzzleException $e) {
            // log error
            return null;
        }
        // END NEXT_MAJOR
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\SeoBundle\Block\Social;
15
16			use GuzzleHttp\Exception\GuzzleException;
17			use Http\Client\Exception;
18			use Http\Client\HttpClient;
19			use Http\Message\MessageFactory;
20			use Sonata\AdminBundle\Form\FormMapper;
21			use Sonata\BlockBundle\Block\BlockContextInterface;
22			use Sonata\BlockBundle\Model\BlockInterface;
23			use Sonata\CoreBundle\Form\Type\ImmutableArrayType;
24			use Sonata\CoreBundle\Model\Metadata;
25			use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
26			use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
27			use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
28			use Symfony\Component\Form\Extension\Core\Type\IntegerType;
29			use Symfony\Component\Form\Extension\Core\Type\TextareaType;
30			use Symfony\Component\Form\Extension\Core\Type\TextType;
31			use Symfony\Component\HttpFoundation\Response;
32			use Symfony\Component\OptionsResolver\OptionsResolver;
33
34			/**
35			* This block service allows to embed a tweet by requesting the Twitter API.
36			*
37			* @see https://dev.twitter.com/docs/api/1/get/statuses/oembed
38			*
39			* @author Hugo Briand <[email protected]>
40			*/
41			class TwitterEmbedTweetBlockService extends BaseTwitterButtonBlockService
42			{
43			public const TWITTER_OEMBED_URI = 'https://api.twitter.com/1/statuses/oembed.json';
44			public const TWEET_URL_PATTERN = '%^(https://)(www.)?(twitter.com/)(.)(/status)(es)?(/)([0-9])$%i';
45			public const TWEET_ID_PATTERN = '%^([0-9]*)$%';
46
47			/**
48			* @var HttpClient\|null
49			*/
50			private $httpClient;
51
52			/**
53			* @var MessageFactory\|null
54			*/
55			private $messageFactory;
56
57			public function __construct(?string $name, EngineInterface $templating, HttpClient $httpClient = null, MessageFactory $messageFactory = null)
58			{
59			parent::__construct($name, $templating);
60
61			$this->httpClient = $httpClient;
62			$this->messageFactory = $messageFactory;
63			}
64
65			public function execute(BlockContextInterface $blockContext, Response $response = null): Response
66			{
67			return $this->renderResponse($blockContext->getTemplate(), [
68			'block' => $blockContext->getBlock(),
69			'tweet' => $this->loadTweet($blockContext),
70			], $response);
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			public function configureSettings(OptionsResolver $resolver)
77			{
78			$resolver->setDefaults([
79			'template' => '@SonataSeo/Block/block_twitter_embed.html.twig',
80			'tweet' => '',
81			'maxwidth' => null,
82			'hide_media' => false,
83			'hide_thread' => false,
84			'omit_script' => false,
85			'align' => 'none',
86			'related' => null,
87			'lang' => null,
88			]);
89			}
90
91			/**
92			* {@inheritdoc}
93			*/
94			public function buildEditForm(FormMapper $form, BlockInterface $block)
95			{
96			$form->add('settings', ImmutableArrayType::class, [
97			'keys' => [
98			['tweet', TextareaType::class, [
99			'required' => true,
100			'label' => 'form.label_tweet',
101			'sonata_help' => 'form.help_tweet',
102			]],
103			['maxwidth', IntegerType::class, [
104			'required' => false,
105			'label' => 'form.label_maxwidth',
106			'sonata_help' => 'form.help_maxwidth',
107			]],
108			['hide_media', CheckboxType::class, [
109			'required' => false,
110			'label' => 'form.label_hide_media',
111			'sonata_help' => 'form.help_hide_media',
112			]],
113			['hide_thread', CheckboxType::class, [
114			'required' => false,
115			'label' => 'form.label_hide_thread',
116			'sonata_help' => 'form.help_hide_thread',
117			]],
118			['omit_script', CheckboxType::class, [
119			'required' => false,
120			'label' => 'form.label_omit_script',
121			'sonata_help' => 'form.help_omit_script',
122			]],
123			['align', ChoiceType::class, [
124			'required' => false,
125			'choices' => [
126			'left' => 'form.label_align_left',
127			'right' => 'form.label_align_right',
128			'center' => 'form.label_align_center',
129			'none' => 'form.label_align_none',
130			],
131			'label' => 'form.label_align',
132			]],
133			['related', TextType::class, [
134			'required' => false,
135			'label' => 'form.label_related',
136			'sonata_help' => 'form.help_related',
137			]],
138			['lang', ChoiceType::class, [
139			'required' => true,
140			'choices' => $this->languageList,
141			'label' => 'form.label_lang',
142			]],
143			],
144			'translation_domain' => 'SonataSeoBundle',
145			]);
146			}
147
148			/**
149			* {@inheritdoc}
150			*/
151			public function getBlockMetadata($code = null)
152			{
153			return new Metadata($this->getName(), (null !== $code ? $code : $this->getName()), false, 'SonataSeoBundle', [
			0 ignored issues – show Bug Best Practice introduced 2019-01-10 07:41 UTC by Report Bug Copy Issue Report The return type of `return new \Sonata\CoreB...' => 'fa fa-twitter'));` (`Sonata\CoreBundle\Model\Metadata`) is incompatible with the return type declared by the interface `Sonata\BlockBundle\Block...rface::getBlockMetadata` of type `Sonata\BlockBundle\Meta\MetadataInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history... Deprecated Code introduced 2019-01-10 07:41 UTC by Report Bug Copy Issue Report The class `Sonata\CoreBundle\Model\Metadata` has been deprecated with message: since version 3.x, to be removed in 4.0. Use Sonata\BlockBundle\Meta\Metadata instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
154			'class' => 'fa fa-twitter',
155			]);
156			}
157
158			/**
159			* Returns supported API parameters from settings.
160			*
161			* @return array
162			*/
163			protected function getSupportedApiParams()
164			{
165			return [
166			'maxwidth',
167			'hide_media',
168			'hide_thread',
169			'omit_script',
170			'align',
171			'related',
172			'lang',
173			'url',
174			'id',
175			];
176			}
177
178			/**
179			* Builds the API query URI based on $settings.
180			*
181			* @param bool $uriMatched
182			* @param array $settings
183			*
184			* @return string
185			*/
186			protected function buildUri($uriMatched, array $settings)
187			{
188			$apiParams = $settings;
189			$supportedParams = $this->getSupportedApiParams();
190
191			if ($uriMatched) {
192			// We matched the uri
193			$apiParams['url'] = $settings['tweet'];
194			} else {
195			$apiParams['id'] = $settings['tweet'];
196			}
197
198			unset($apiParams['tweet']);
199
200			$parameters = [];
201			foreach ($apiParams as $key => $value) {
202			if ($value && \in_array($key, $supportedParams)) {
203			$parameters[] = $key.'='.$value;
204			}
205			}
206
207			return sprintf('%s?%s', self::TWITTER_OEMBED_URI, implode('&', $parameters));
208			}
209
210			/**
211			* Loads twitter tweet.
212			*/
213			private function loadTweet(BlockContextInterface $blockContext): ?string
214			{
215			$uriMatched = preg_match(self::TWEET_URL_PATTERN, $blockContext->getSetting('tweet'));
216
217			if (!$uriMatched \|\| !preg_match(self::TWEET_ID_PATTERN, $blockContext->getSetting('tweet'))) {
218			return null;
219			}
220
221			if (null !== $this->httpClient && null !== $this->messageFactory) {
222			try {
223			$response = $this->httpClient->sendRequest(
224			$this->messageFactory->createRequest(
225			'GET',
226			$this->buildUri($uriMatched, $blockContext->getSettings())
			0 ignored issues – show Documentation introduced 2018-06-01 17:49 UTC by Report Bug Copy Issue Report `$uriMatched` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
227			)
228			);
229			} catch (Exception $e) {
230			// log error
231			return null;
232			}
233
234			$apiTweet = json_decode($response->getBody(), true);
235
236			return $apiTweet['html'];
237			}
238
239			// NEXT_MAJOR: Remove the old guzzle implementation
240
241			// We matched an URL or an ID, we'll need to ask the API
242			if (false === class_exists('GuzzleHttp\Client')) {
243			throw new \RuntimeException(
244			'The guzzle http client library is required to call the Twitter API.'.
245			'Make sure to add php-http/httplug-bundle or guzzlehttp/guzzle to your composer.json.'
246			);
247			}
248
249			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2019-01-15 18:44 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
250			'The direct Guzzle implementation is deprecated since 2.x and will be removed with the next major release.',
251			E_USER_DEPRECATED
252			);
253
254			// TODO cache API result
255			$client = new \GuzzleHttp\Client();
256			$client->setConfig(['curl.options' => [CURLOPT_CONNECTTIMEOUT_MS => 1000]]);
257
258			try {
259			$request = $client->get($this->buildUri($uriMatched, $blockContext->getSettings()));
			0 ignored issues – show Documentation introduced 2018-06-01 14:14 UTC by Report Bug Copy Issue Report `$uriMatched` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
260			$apiTweet = json_decode($request->send()->getBody(true), true);
			0 ignored issues – show Bug introduced 2018-06-01 15:42 UTC by Report Bug Copy Issue Report The method `send()` does not seem to exist on `object<Psr\Http\Message\ResponseInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
261
262			return $apiTweet['html'];
263			} catch (GuzzleException $e) {
264			// log error
265			return null;
266			}
267			// END NEXT_MAJOR
268			}
269			}
270

sonata-project / SonataSeoBundle

Pull Request — 2.x (#161)

TwitterEmbedTweetBlockService::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like