Add ALL THE TYPES (#346)

CHANGELOG.md

@@ -14,6 +14,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ### Changed
 
+ - Pretty much everything now has parameter and return types (#346)
  - `Environment` is now a `final` class
  - `Environment::getBlockRendererForClass()` was replaced with `Environment::getBlockRenderersForClass()` (note the added `s`)
  - `Environment::getInlineRendererForClass()` was replaced with `Environment::getInlineRenderersForClass()` (note the added `s`)

UPGRADE.md

@@ -25,6 +25,10 @@ After doing this, the two abstract classes mentioned above had notthing left in
 
 Several previously-deprecated methods inside of `RegexHelper` were finally removed.  That functionality was made available with static methods and constants, so use those instead.
 
+### Parameter and return types
+
+Pretty much every method now uses parameter and return types, including several interfaces.  Update your implementations accordingly.
+
 ### Environment interfaces
 
 We have extracted two interfaces from the `Environment` class:

src/Block/Element/AbstractBlock.php

@@ -84,15 +84,15 @@ protected function setParent(Node $node = null)
     /**
      * @return bool
      */
-    public function isContainer()
+    public function isContainer(): bool
     {
         return true;
     }
 
     /**
      * @return bool
      */
-    public function hasChildren()
+    public function hasChildren(): bool
     {
         return $this->firstChild !== null;
     }
@@ -104,28 +104,28 @@ public function hasChildren()
      *
      * @return bool
      */
-    abstract public function canContain(AbstractBlock $block);
+    abstract public function canContain(AbstractBlock $block): bool;
 
     /**
      * Returns true if block type can accept lines of text
      *
      * @return bool
      */
-    abstract public function acceptsLines();
+    abstract public function acceptsLines(): bool;
 
     /**
      * Whether this is a code block
      *
      * @return bool
      */
-    abstract public function isCode();
+    abstract public function isCode(): bool;
 
     /**
      * @param Cursor $cursor
      *
      * @return bool
      */
-    abstract public function matchesNextLine(Cursor $cursor);
+    abstract public function matchesNextLine(Cursor $cursor): bool;
 
     /**
      * @param ContextInterface $context
@@ -144,7 +144,7 @@ public function handleRemainingContents(ContextInterface $context, Cursor $curso
      *
      * @return $this
      */
-    public function setStartLine($startLine)
+    public function setStartLine(int $startLine)
     {
         $this->startLine = $startLine;
         if (empty($this->endLine)) {
@@ -157,12 +157,17 @@ public function setStartLine($startLine)
     /**
      * @return int
      */
-    public function getStartLine()
+    public function getStartLine(): int
     {
         return $this->startLine;
     }
 
-    public function setEndLine($endLine)
+    /**
+     * @param int $endLine
+     *
+     * @return $this
+     */
+    public function setEndLine(int $endLine)
     {
         $this->endLine = $endLine;
 
@@ -172,7 +177,7 @@ public function setEndLine($endLine)
     /**
      * @return int
      */
-    public function getEndLine()
+    public function getEndLine(): int
     {
         return $this->endLine;
     }
@@ -182,15 +187,15 @@ public function getEndLine()
      *
      * @return bool
      */
-    public function endsWithBlankLine()
+    public function endsWithBlankLine(): bool
     {
         return $this->lastLineBlank;
     }
 
     /**
      * @param bool $blank
      */
-    public function setLastLineBlank($blank)
+    public function setLastLineBlank(bool $blank)
     {
         $this->lastLineBlank = $blank;
     }
@@ -203,23 +208,23 @@ public function setLastLineBlank($blank)
      *
      * @return bool
      */
-    public function shouldLastLineBeBlank(Cursor $cursor, $currentLineNumber)
+    public function shouldLastLineBeBlank(Cursor $cursor, int $currentLineNumber): bool
     {
         return $cursor->isBlank();
     }
 
     /**
      * @return string[]
      */
-    public function getStrings()
+    public function getStrings(): iterable
     {
         return $this->strings->toArray();
     }
 
     /**
      * @param string $line
      */
-    public function addLine($line)
+    public function addLine(string $line)
     {
         if (!$this->acceptsLines()) {
             throw new \LogicException('You cannot add lines to a block which cannot accept them');
@@ -233,7 +238,7 @@ public function addLine($line)
      *
      * @return bool
      */
-    public function isOpen()
+    public function isOpen(): bool
     {
         return $this->open;
     }
@@ -244,7 +249,7 @@ public function isOpen()
      * @param ContextInterface $context
      * @param int              $endLineNumber
      */
-    public function finalize(ContextInterface $context, $endLineNumber)
+    public function finalize(ContextInterface $context, int $endLineNumber)
     {
         if (!$this->open) {
             return;
@@ -259,7 +264,7 @@ public function finalize(ContextInterface $context, $endLineNumber)
     /**
      * @return string
      */
-    public function getStringContent()
+    public function getStringContent(): string
     {
         return $this->finalStringContents;
     }
@@ -270,7 +275,7 @@ public function getStringContent()
      *
      * @return mixed
      */
-    public function getData($key, $default = null)
+    public function getData(string $key, $default = null)
     {
         return array_key_exists($key, $this->data) ? $this->data[$key] : $default;
     }

src/Block/Element/BlockQuote.php

@@ -25,7 +25,7 @@ class BlockQuote extends AbstractBlock
      *
      * @return bool
      */
-    public function canContain(AbstractBlock $block)
+    public function canContain(AbstractBlock $block): bool
     {
         return true;
     }
@@ -35,7 +35,7 @@ public function canContain(AbstractBlock $block)
      *
      * @return bool
      */
-    public function acceptsLines()
+    public function acceptsLines(): bool
     {
         return false;
     }
@@ -45,12 +45,12 @@ public function acceptsLines()
      *
      * @return bool
      */
-    public function isCode()
+    public function isCode(): bool
     {
         return false;
     }
 
-    public function matchesNextLine(Cursor $cursor)
+    public function matchesNextLine(Cursor $cursor): bool
     {
         if (!$cursor->isIndented() && $cursor->getNextNonSpaceCharacter() === '>') {
             $cursor->advanceToNextNonSpaceOrTab();
@@ -69,7 +69,7 @@ public function matchesNextLine(Cursor $cursor)
      *
      * @return bool
      */
-    public function shouldLastLineBeBlank(Cursor $cursor, $currentLineNumber)
+    public function shouldLastLineBeBlank(Cursor $cursor, int $currentLineNumber): bool
     {
         return false;
     }

src/Block/Element/Document.php

@@ -36,7 +36,7 @@ public function __construct()
     /**
      * @return ReferenceMap
      */
-    public function getReferenceMap()
+    public function getReferenceMap(): ReferenceMap
     {
         return $this->referenceMap;
     }
@@ -48,7 +48,7 @@ public function getReferenceMap()
      *
      * @return bool
      */
-    public function canContain(AbstractBlock $block)
+    public function canContain(AbstractBlock $block): bool
     {
         return true;
     }
@@ -58,7 +58,7 @@ public function canContain(AbstractBlock $block)
      *
      * @return bool
      */
-    public function acceptsLines()
+    public function acceptsLines(): bool
     {
         return false;
     }
@@ -68,12 +68,12 @@ public function acceptsLines()
      *
      * @return bool
      */
-    public function isCode()
+    public function isCode(): bool
     {
         return false;
     }
 
-    public function matchesNextLine(Cursor $cursor)
+    public function matchesNextLine(Cursor $cursor): bool
     {
         return true;
     }