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/Processor/Processor.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         $context->textContent = $shortcode->getContent();
     }
 
+    /**
+     * @param callable|null $handler
+     */
     private function processHandler(ParsedShortcodeInterface $parsed, ProcessorContext $context, $handler)
     {
         $processed = ProcessedShortcode::createFromContext(clone $context);

src/Shortcode/ReplacedShortcode.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
         return $this->replacement;
     }
 
+    /**
+     * @return string
+     */
     public function getText()
     {
         return $this->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,11 +111,18 @@ 
         return $this;
     }
 
+    /**
+     * @param string $alias
+     * @param string $name
+     */
     public function addHandlerAlias($alias, $name)
     {
         $this->handlers->addAlias($alias, $name);
     }
 
+    /**
+     * @param EventHandler\FilterRawEventHandler $handler
+     */
     public function addEventHandler($name, $handler)
     {
         $this->events->addListener($name, $handler);
@@ -113,6 +130,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $format
+     */
     public function serialize(ShortcodeInterface $shortcode, $format)
     {
         switch($format) {
@@ -124,6 +144,9 @@ 
         }
     }
 
+    /**
+     * @param string $format
+     */
     public function unserialize($text, $format)
     {
         switch($format) {

src/Parser/RegularParser.php

Doc Comments +12 added lines

@@ -61,6 +61,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);
@@ -265,6 +270,10 @@ 
         return true;
     }
 
+    /**
+     * @param integer|null $type
+     * @param \Closure $callbacks
+     */
     private function match($type, $callbacks = null, $ws = false)
     {
         if($this->position >= $this->tokensCount) {
@@ -292,6 +301,9 @@ 
 
     /* --- LEXER ----------------------------------------------------------- */
 
+    /**
+     * @param string $text
+     */
     private function tokenize($text)
     {
         preg_match_all($this->lexerRegex, $text, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);