From 50bf0199f91d35496da3fb0b03b5027deb939107 Mon Sep 17 00:00:00 2001 From: Oliver Klee Date: Sun, 27 Jun 2021 14:54:30 +0200 Subject: [PATCH] Add type annotations for `Parser` Also add a note concerning a bug that will be fixed in a separate change. --- src/Parser.php | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/src/Parser.php b/src/Parser.php index 7435db35..f3b0493a 100644 --- a/src/Parser.php +++ b/src/Parser.php @@ -4,9 +4,10 @@ use Sabberworm\CSS\CSSList\Document; use Sabberworm\CSS\Parsing\ParserState; +use Sabberworm\CSS\Parsing\SourceException; /** - * Parser class parses CSS from text into a data structure. + * This class parses CSS from text into a data structure. */ class Parser { @@ -16,11 +17,9 @@ class Parser private $oParserState; /** - * Note that that iLineNo starts from 1 and not 0. - * - * @param $sText + * @param string $sText * @param Settings|null $oParserSettings - * @param int $iLineNo + * @param int $iLineNo the line number (starting from 1, not from 0) */ public function __construct($sText, Settings $oParserSettings = null, $iLineNo = 1) { @@ -30,20 +29,29 @@ public function __construct($sText, Settings $oParserSettings = null, $iLineNo = $this->oParserState = new ParserState($sText, $oParserSettings, $iLineNo); } + /** + * @param string $sCharset + * + * @return void + */ public function setCharset($sCharset) { $this->oParserState->setCharset($sCharset); } + /** + * @return void + */ public function getCharset() { + // Note: The `return` statement is missing here. This is a bug that needs to be fixed. $this->oParserState->getCharset(); } /** * @return Document * - * @throws Parsing\SourceException + * @throws SourceException */ public function parse() {