build: apply phpstan to project

Author: Douglas Greenshields

.travis.yml

@@ -10,6 +10,7 @@ before_script: composer install --dev --prefer-source
 
 script:
     - vendor/bin/phpunit -v
+    - vendor/bin/phpstan analyse . --level 8
 
 dist: xenial
 

Cache/CacheInterface.php

@@ -21,6 +21,7 @@ public function get($key);
      *
      * @param string $key
      * @param string $value
+     * @return void
      **/
     public function set($key, $value);
 }

Cache/NullCache.php

@@ -12,6 +12,7 @@ class NullCache implements CacheInterface
      **/
     public function get($key)
     {
+        return null;
     }
 
     /**

Cache/ObjectCache.php

@@ -16,14 +16,10 @@ class ObjectCache implements ObjectCacheInterface
     private $cache;
 
     /**
-     * @var SerializerInterface
+     * @var OEmbedSerializerInterface
      **/
     private $serializer;
 
-    /**
-     * @param CacheInterface            $cache
-     * @param OEmbedSerializerInterface $serializer
-     **/
     public function __construct(CacheInterface $cache, OEmbedSerializerInterface $serializer)
     {
         $this->cache = $cache;

Cache/ObjectCacheInterface.php

@@ -22,6 +22,7 @@ public function get($key);
      *
      * @param string          $key
      * @param OEmbedInterface $oEmbed
+     * @return void
      **/
     public function set($key, OEmbedInterface $oEmbed);
 }

Client/GuzzleClient.php

@@ -12,7 +12,7 @@
 class GuzzleClient extends AbstractClient
 {
     /**
-     * @var \GuzzleHttp\ClientInterface
+     * @var \GuzzleHttp\ClientInterface|null
      */
     private $guzzle;
 
@@ -58,7 +58,7 @@ public function fetchEmbed(ProviderInterface $provider, string $mediaId, array $
         return (new OEmbedFactory())->createFromJson((string) $response->getBody(), $provider);
     }
 
-    private function getGuzzle()
+    private function getGuzzle(): \GuzzleHttp\ClientInterface
     {
         if (null === $this->guzzle) {
             $this->guzzle = new Guzzle([

Command/FetchOEmbedCommand.php

@@ -3,6 +3,7 @@
 namespace Markup\OEmbedBundle\Command;
 
 use Markup\OEmbedBundle\Exception\OEmbedUnavailableException;
+use Markup\OEmbedBundle\Service\OEmbedService;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -13,6 +14,9 @@
 */
 class FetchOEmbedCommand extends ContainerAwareCommand
 {
+    /**
+     * @return void
+     */
     protected function configure()
     {
         $this
@@ -24,18 +28,22 @@ protected function configure()
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        /** @var string $provider */
         $provider = $input->getArgument('provider');
+        /** @var string $mediaId */
         $mediaId = $input->getArgument('media_id');
 
         $output->writeln(sprintf('Looking up oEmbed data for media ID %s from the provider "%s".', $mediaId, $provider));
 
         $startTime = microtime(true);
         try {
-            $oEmbed = $this->getContainer()->get('markup_oembed')->fetchOEmbed($provider, $mediaId);
+            /** @var OEmbedService $oEmbedService */
+            $oEmbedService = $this->getContainer()->get('markup_oembed');
+            $oEmbed = $oEmbedService->fetchOEmbed($provider, $mediaId);
         } catch (OEmbedUnavailableException $e) {
             $output->writeln(sprintf('<error>Could not fetch the oEmbed data. Reported error: %s</error>', $e->getMessage()));
 
-            return;
+            return 1;
         }
 
         $output->writeln(
@@ -50,5 +58,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             }
             $output->writeln(sprintf($format, $key, $value));
         }
+
+        return 0;
     }
 }

DependencyInjection/MarkupOEmbedExtension.php

@@ -16,7 +16,7 @@
 class MarkupOEmbedExtension extends Extension
 {
     /**
-     * {@inheritDoc}
+     * @return void
      */
     public function load(array $configs, ContainerBuilder $container)
     {
@@ -38,6 +38,7 @@ public function load(array $configs, ContainerBuilder $container)
      *
      * @param array            $config
      * @param ContainerBuilder $container
+     * @return void
      **/
     private function loadProviders(array $config, ContainerBuilder $container)
     {
@@ -56,6 +57,7 @@ private function loadProviders(array $config, ContainerBuilder $container)
      *
      * @param array            $config
      * @param ContainerBuilder $container
+     * @return void
      **/
     private function loadSquashRenderingErrors(array $config, ContainerBuilder $container)
     {
@@ -67,6 +69,7 @@ private function loadSquashRenderingErrors(array $config, ContainerBuilder $cont
      *
      * @param array            $config
      * @param ContainerBuilder $container
+     * @return void
      **/
     private function loadCacheServices(array $config, ContainerBuilder $container)
     {

Exception/ProviderNotFoundException.php

@@ -7,6 +7,9 @@
 */
 class ProviderNotFoundException extends \RuntimeException implements ExceptionInterface
 {
+    /**
+     * @param string $providerName
+     */
     public function __construct($providerName)
     {
         parent::__construct(sprintf('The oEmbed provider "%s" could not be found.', $providerName));

OEmbed/OEmbed.php

@@ -7,6 +7,9 @@
 */
 class OEmbed implements OEmbedInterface
 {
+    /**
+     * @var array<string>
+     */
     private static $knownTypes = ['photo', 'video', 'link', 'rich'];
 
     /**
@@ -22,7 +25,7 @@ class OEmbed implements OEmbedInterface
     private $properties;
 
     /**
-     * @var string
+     * @var string|null
      **/
     private $embedProperty;