Add PHP 7+ features for bundles (#392)

* Add PHP 7+ features for bundles * Add PHP 7+ features for bundles: fix argument type of `logRequest` method in HttpServer class * Add PHP 7+ features for bundles: fix argument `$port` type of `logRequest` method in HttpServer class * Add PHP 7+ features for bundles: various fixes * Add PHP 7+ features for bundles: fix phpstan error * Add PHP 7+ features for bundles: fix missed type declaration
sculpin · Oct 13, 2018 · faebbad · faebbad
1 parent 4497859
commit faebbad
Show file tree

Hide file tree

Showing 52 changed files with 137 additions and 118 deletions.
diff --git a/src/Sculpin/Bundle/ContentTypesBundle/Command/ContentCreateCommand.php b/src/Sculpin/Bundle/ContentTypesBundle/Command/ContentCreateCommand.php
@@ -28,12 +28,12 @@
  */
 class ContentCreateCommand extends AbstractCommand
 {
-    const DIRECTORY_FLAG = '_directory_';
+    private const DIRECTORY_FLAG = '_directory_';
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $prefix = $this->isStandaloneSculpin() ? '' : 'sculpin:';
 
@@ -72,7 +72,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): void
     {
         $pluralType   = $input->getArgument('type');
         $singularType = Inflector::singularize($pluralType);
@@ -109,7 +109,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
     }
 
-    protected function generateBoilerplateManifest($plural, $singular, array $taxonomies = []): array
+    protected function generateBoilerplateManifest(string $plural, string $singular, array $taxonomies = []): array
     {
         $app = $this->getApplication();
         if (!$app instanceof Application) {
@@ -153,7 +153,7 @@ protected function generateBoilerplateManifest($plural, $singular, array $taxono
         return $manifest;
     }
 
-    protected function getOutputMessage($type, $singularType, $taxonomies = [])
+    protected function getOutputMessage(string $type, string $singularType, array $taxonomies = []): string
     {
         $outputMessage = <<<EOT
 =============================================
@@ -181,7 +181,7 @@ protected function getOutputMessage($type, $singularType, $taxonomies = [])
         return $outputMessage;
     }
 
-    protected function getIndexTemplate($plural, $singular)
+    protected function getIndexTemplate(string $plural, string $singular)
     {
         $title = ucfirst($plural);
 
@@ -214,7 +214,7 @@ protected function getIndexTemplate($plural, $singular)
 EOT;
     }
 
-    protected function getViewTemplate($plural, $singular, $taxonomies = [])
+    protected function getViewTemplate(string $plural, string $singular, array $taxonomies = []): string
     {
         $output = <<<EOT
 {% extends 'default' %}
@@ -264,8 +264,12 @@ protected function getViewTemplate($plural, $singular, $taxonomies = [])
         return $output;
     }
 
-    protected function getTaxonomyIndexTemplate($plural, $singular, $taxonomy, $singularTaxonomy)
-    {
+    protected function getTaxonomyIndexTemplate(
+        string $plural,
+        string $singular,
+        string $taxonomy,
+        string $singularTaxonomy
+    ): string {
         $title = ucfirst($taxonomy);
 
         return <<<EOT
@@ -283,8 +287,12 @@ protected function getTaxonomyIndexTemplate($plural, $singular, $taxonomy, $sing
 EOT;
     }
 
-    protected function getTaxonomyViewTemplate($plural, $singular, $taxonomy, $singularTaxonomy)
-    {
+    protected function getTaxonomyViewTemplate(
+        string $plural,
+        string $singular,
+        string $taxonomy,
+        string $singularTaxonomy
+    ): string {
         $title = ucfirst($plural);
 
         return <<<EOT

diff --git a/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/Compiler/MapPass.php b/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/Compiler/MapPass.php
@@ -19,7 +19,7 @@
 
 class MapPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $typesId = self::generateId('types');
         $types = $container->getParameter($typesId);
@@ -41,12 +41,12 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private static function generateId($value)
+    private static function generateId(string $value): string
     {
         return implode('.', ['sculpin_content_types', $value]);
     }
 
-    private static function generateTypesId($type, $value)
+    private static function generateTypesId(string $type, string $value): string
     {
         return implode('.', ['sculpin_content_types.types', $type, $value]);
     }

diff --git a/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/Configuration.php b/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/Configuration.php
@@ -26,7 +26,7 @@ class Configuration implements ConfigurationInterface
     /**
     * {@inheritdoc}
     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder();
 

diff --git a/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/SculpinContentTypesExtension.php b/src/Sculpin/Bundle/ContentTypesBundle/DependencyInjection/SculpinContentTypesExtension.php
@@ -273,17 +273,17 @@ public function load(array $configs, ContainerBuilder $container)
         }
     }
 
-    private static function generatePlaceholder($value)
+    private static function generatePlaceholder(string $value): string
     {
         return '%'.$value.'%';
     }
 
-    private static function generateId($value)
+    private static function generateId(string $value): string
     {
         return implode('.', ['sculpin_content_types', $value]);
     }
 
-    private static function generateTypesId($type, $value)
+    private static function generateTypesId(string $type, string $value)
     {
         return implode('.', ['sculpin_content_types.types', $type, $value]);
     }

diff --git a/src/Sculpin/Bundle/ContentTypesBundle/SculpinContentTypesBundle.php b/src/Sculpin/Bundle/ContentTypesBundle/SculpinContentTypesBundle.php
@@ -27,7 +27,7 @@ class SculpinContentTypesBundle extends Bundle
     /**
      * {@inheritdoc}
      */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new MapPass);
     }

diff --git a/src/Sculpin/Bundle/MarkdownBundle/DependencyInjection/Configuration.php b/src/Sculpin/Bundle/MarkdownBundle/DependencyInjection/Configuration.php
@@ -26,7 +26,7 @@ class Configuration implements ConfigurationInterface
     /**
     * {@inheritdoc}
     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder;
 

diff --git a/src/Sculpin/Bundle/MarkdownBundle/DependencyInjection/SculpinMarkdownExtension.php b/src/Sculpin/Bundle/MarkdownBundle/DependencyInjection/SculpinMarkdownExtension.php
@@ -28,7 +28,7 @@ class SculpinMarkdownExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration;
         $config = $this->processConfiguration($configuration, $configs);

diff --git a/src/Sculpin/Bundle/MarkdownBundle/MarkdownConverter.php b/src/Sculpin/Bundle/MarkdownBundle/MarkdownConverter.php
@@ -18,6 +18,7 @@
 use Sculpin\Core\Converter\ParserInterface;
 use Sculpin\Core\Event\SourceSetEvent;
 use Sculpin\Core\Sculpin;
+use Sculpin\Core\Source\SourceInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Michelf\Markdown;
 
@@ -68,7 +69,7 @@ public function convert(ConverterContextInterface $converterContext): void
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Sculpin::EVENT_BEFORE_RUN => 'beforeRun',
@@ -80,8 +81,9 @@ public static function getSubscribedEvents()
      *
      * @param SourceSetEvent $sourceSetEvent Source Set Event
      */
-    public function beforeRun(SourceSetEvent $sourceSetEvent)
+    public function beforeRun(SourceSetEvent $sourceSetEvent): void
     {
+        /** @var SourceInterface $source */
         foreach ($sourceSetEvent->updatedSources() as $source) {
             foreach ($this->extensions as $extension) {
                 if (fnmatch("*.{$extension}", $source->filename())) {
@@ -99,7 +101,7 @@ public function beforeRun(SourceSetEvent $sourceSetEvent)
      * @param string $headerText raw markdown input for the header name
      * @return string
      */
-    public function generateHeaderId($headerText)
+    public function generateHeaderId(string $headerText): string
     {
 
         // $headerText is completely raw markdown input. We need to strip it

diff --git a/src/Sculpin/Bundle/MarkdownBundle/SculpinMarkdownBundle.php b/src/Sculpin/Bundle/MarkdownBundle/SculpinMarkdownBundle.php
@@ -22,5 +22,5 @@
  */
 class SculpinMarkdownBundle extends Bundle
 {
-    const CONVERTER_NAME = 'markdown';
+    public const CONVERTER_NAME = 'markdown';
 }
diff --git a/src/Sculpin/Bundle/MarkdownTwigCompatBundle/ConvertListener.php b/src/Sculpin/Bundle/MarkdownTwigCompatBundle/ConvertListener.php
@@ -54,7 +54,7 @@ class ConvertListener implements EventSubscriberInterface
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Sculpin::EVENT_BEFORE_CONVERT => 'beforeConvert',
@@ -67,7 +67,7 @@ public static function getSubscribedEvents()
      *
      * @param ConvertEvent $convertEvent Convert Event
      */
-    public function beforeConvert(ConvertEvent $convertEvent)
+    public function beforeConvert(ConvertEvent $convertEvent): void
     {
         if ($convertEvent->isHandledBy(SculpinMarkdownBundle::CONVERTER_NAME, SculpinTwigBundle::FORMATTER_NAME)) {
             $content = $convertEvent->source()->content();
@@ -88,7 +88,7 @@ public function beforeConvert(ConvertEvent $convertEvent)
      *
      * @param ConvertEvent $convertEvent Convert event
      */
-    public function afterConvert(ConvertEvent $convertEvent)
+    public function afterConvert(ConvertEvent $convertEvent): void
     {
         if ($convertEvent->isHandledBy(SculpinMarkdownBundle::CONVERTER_NAME, SculpinTwigBundle::FORMATTER_NAME)) {
             $content = $convertEvent->source()->content();

diff --git a/...undle/MarkdownTwigCompatBundle/DependencyInjection/SculpinMarkdownTwigCompatExtension.php b/...undle/MarkdownTwigCompatBundle/DependencyInjection/SculpinMarkdownTwigCompatExtension.php
@@ -28,7 +28,7 @@ class SculpinMarkdownTwigCompatExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');

diff --git a/src/Sculpin/Bundle/PaginationBundle/DependencyInjection/Configuration.php b/src/Sculpin/Bundle/PaginationBundle/DependencyInjection/Configuration.php
@@ -26,7 +26,7 @@ class Configuration implements ConfigurationInterface
     /**
     * {@inheritdoc}
     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder;
 

diff --git a/src/Sculpin/Bundle/PaginationBundle/DependencyInjection/SculpinPaginationExtension.php b/src/Sculpin/Bundle/PaginationBundle/DependencyInjection/SculpinPaginationExtension.php
@@ -28,7 +28,7 @@ class SculpinPaginationExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration;
         $config = $this->processConfiguration($configuration, $configs);

diff --git a/src/Sculpin/Bundle/PaginationBundle/PaginationGenerator.php b/src/Sculpin/Bundle/PaginationBundle/PaginationGenerator.php
@@ -56,7 +56,7 @@ class PaginationGenerator implements GeneratorInterface
     public function __construct(
         DataProviderManager $dataProviderManager,
         SourcePermalinkFactory $permalinkFactory,
-        $maxPerPage
+        int $maxPerPage
     ) {
         $this->dataProviderManager = $dataProviderManager;
         $this->permalinkFactory = $permalinkFactory;

diff --git a/src/Sculpin/Bundle/PostsBundle/DependencyInjection/Configuration.php b/src/Sculpin/Bundle/PostsBundle/DependencyInjection/Configuration.php
@@ -26,7 +26,7 @@ class Configuration implements ConfigurationInterface
     /**
     * {@inheritdoc}
     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder;
 

diff --git a/src/Sculpin/Bundle/PostsBundle/DependencyInjection/SculpinPostsExtension.php b/src/Sculpin/Bundle/PostsBundle/DependencyInjection/SculpinPostsExtension.php
@@ -27,7 +27,7 @@ class SculpinPostsExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration;
         $config = $this->processConfiguration($configuration, $configs);

diff --git a/src/Sculpin/Bundle/SculpinBundle/Command/AbstractCommand.php b/src/Sculpin/Bundle/SculpinBundle/Command/AbstractCommand.php
@@ -27,7 +27,7 @@ abstract class AbstractCommand extends ContainerAwareCommand
      *
      * @return bool
      */
-    protected function isStandaloneSculpin()
+    protected function isStandaloneSculpin(): bool
     {
         return class_exists('Sculpin\\Bundle\\StandaloneBundle\\SculpinStandaloneBundle', false);
     }

diff --git a/src/Sculpin/Bundle/SculpinBundle/Command/ContainerDebugCommand.php b/src/Sculpin/Bundle/SculpinBundle/Command/ContainerDebugCommand.php
@@ -50,7 +50,7 @@ class ContainerDebugCommand extends ContainerAwareCommand
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('container:debug')
@@ -127,7 +127,7 @@ protected function configure()
      *
      * @throws \LogicException
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): void
     {
         $this->validateInput($input);
 
@@ -207,7 +207,7 @@ protected function outputServices(
         $serviceIds,
         $showPrivate = false,
         $showTagAttributes = null
-    ) {
+    ): void {
         // set the label to specify public or public+private
         if ($showPrivate) {
             $label = '<comment>Public</comment> and <comment>private</comment> services';
@@ -322,7 +322,7 @@ protected function outputServices(
         }
     }
 
-    protected function buildArgumentsArray($serviceId, $className, array $tagAttributes = [])
+    protected function buildArgumentsArray($serviceId, $className, array $tagAttributes = []): array
     {
         $arguments = [$serviceId];
         foreach ($tagAttributes as $tagAttribute) {
@@ -336,7 +336,7 @@ protected function buildArgumentsArray($serviceId, $className, array $tagAttribu
     /**
      * Renders detailed service information about one service
      */
-    protected function outputService(OutputInterface $output, $serviceId)
+    protected function outputService(OutputInterface $output, string $serviceId)
     {
         $definition = $this->resolveServiceDefinition($serviceId);
 
@@ -389,7 +389,7 @@ function ($key, $value) {
         }
     }
 
-    protected function outputParameters(OutputInterface $output, $parameters)
+    protected function outputParameters(OutputInterface $output, array $parameters): void
     {
         $output->writeln($this->getHelper('formatter')->formatSection('container', 'List of parameters'));
 
@@ -437,6 +437,7 @@ protected function outputParameters(OutputInterface $output, $parameters)
      * @param string $serviceId The service id to resolve
      *
      * @return Definition|Alias
+     * @throws \Exception
      */
     protected function resolveServiceDefinition($serviceId)
     {
@@ -460,9 +461,11 @@ protected function resolveServiceDefinition($serviceId)
      * Renders list of tagged services grouped by tag
      *
      * @param OutputInterface $output
-     * @param bool            $showPrivate
+     * @param bool $showPrivate
+     *
+     * @throws \Exception
      */
-    protected function outputTags(OutputInterface $output, $showPrivate = false)
+    protected function outputTags(OutputInterface $output, bool $showPrivate = false): void
     {
         $container = $this->getContainer();
         if (! $container instanceof ContainerBuilder) {