thunderer / Shortcode

src/Parser/WordpressParser.php

Doc Comments +3 added lines

@@ -49,6 +49,9 @@
         return $shortcodes;
     }
 
+    /**
+     * @param string $text
+     */
     private static function parseParameters($text)
     {
         $text = preg_replace('/[\x{00a0}\x{200b}]+/u', ' ', $text);

src/ShortcodeFacade.php

Doc Comments +23 added lines

@@ -76,11 +76,17 @@ 
         $this->processor = $this->processor->withEventContainer($this->events);
     }
 
+    /**
+     * @param string $text
+     */
     public function process($text)
     {
         return $this->processor->process($text);
     }
 
+    /**
+     * @param string $text
+     */
     public function parse($text)
     {
         return $this->parser->parse($text);
@@ -94,6 +100,10 @@ 
         return $this;
     }
 
+    /**
+     * @param string $name
+     * @param \Closure $handler
+     */
     public function addHandler($name, $handler)
     {
         $this->handlers->add($name, $handler);
@@ -101,6 +111,10 @@ 
         return $this;
     }
 
+    /**
+     * @param string $alias
+     * @param string $name
+     */
     public function addHandlerAlias($alias, $name)
     {
         $this->handlers->addAlias($alias, $name);
@@ -108,6 +122,9 @@ 
         return $this;
     }
 
+    /**
+     * @param EventHandler\FilterRawEventHandler $handler
+     */
     public function addEventHandler($name, $handler)
     {
         $this->events->addListener($name, $handler);
@@ -117,6 +134,9 @@ 
 
     /* --- SERIALIZATION --------------------------------------------------- */
 
+    /**
+     * @param string $format
+     */
     public function serialize(ShortcodeInterface $shortcode, $format)
     {
         switch($format) {
@@ -128,6 +148,9 @@ 
         }
     }
 
+    /**
+     * @param string $format
+     */
     public function unserialize($text, $format)
     {
         switch($format) {

src/Processor/Processor.php

Doc Comments +6 added lines

@@ -127,6 +127,9 @@ 
         return $text;
     }
 
+    /**
+     * @param callable|null $handler
+     */
     private function processHandler(ParsedShortcodeInterface $parsed, ProcessorContext $context, $handler)
     {
         $processed = ProcessedShortcode::createFromContext(clone $context);
@@ -144,6 +147,9 @@ 
         return mb_substr($state, 0, $offset, 'utf-8').$processed->getContent().mb_substr($state, $offset + $length, mb_strlen($state, 'utf-8'), 'utf-8');
     }
 
+    /**
+     * @return string
+     */
     private function processRecursion(ParsedShortcodeInterface $shortcode, ProcessorContext $context)
     {
         if ($this->autoProcessContent && null !== $shortcode->getContent()) {

src/Parser/RegularParser.php

Doc Comments +15 added lines

@@ -73,6 +73,11 @@ 
         return $shortcodes;
     }
 
+    /**
+     * @param string|null $bbCode
+     * @param null|string $content
+     * @param string $text
+     */
     private function getObject($name, $parameters, $bbCode, $offset, $content, $text)
     {
         return new ParsedShortcode(new Shortcode($name, $parameters, $content, $bbCode), $text, $offset);
@@ -254,11 +259,18 @@ 
         return $backtrack;
     }
 
+    /**
+     * @param integer $type
+     */
     private function lookahead($type)
     {
         return $this->position < $this->tokensCount && $this->tokens[$this->position][0] === $type;
     }
 
+    /**
+     * @param null|integer $type
+     * @param boolean $ws
+     */
     private function match($type, $ws)
     {
         if($this->position >= $this->tokensCount) {
@@ -280,6 +292,9 @@ 
 
     /* --- LEXER ----------------------------------------------------------- */
 
+    /**
+     * @param string $text
+     */
     private function tokenize($text)
     {
         $count = preg_match_all($this->lexerRegex, $text, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);