chillerlan / php-bbcode

src/Modules/BaseModule.php

Doc Comments +5 added lines, -5 removed lines

@@ -223,7 +223,7 @@ 
 	 * @param string $name     the desired attributes name
 	 * @param mixed  $default  [optional] a default value in case the attribute isn't set, defaults to false
 	 *
-	 * @return mixed the attribute's value in case it exists, otherwise $default
+	 * @return string the attribute's value in case it exists, otherwise $default
 	 */
 	public function getAttribute($name, $default = false){
 		return isset($this->attributes[$name]) && !empty($this->attributes[$name]) ? $this->attributes[$name] : $default;
@@ -249,7 +249,7 @@ 
 
 	 * @param string $name      the desired attributes name
 	 * @param array  $whitelist an array with whitelisted key -> value pairs
-	 * @param mixed  $default   [optional] a default value in case the attribute isn't set, defaults to false
+	 * @param string  $default   [optional] a default value in case the attribute isn't set, defaults to false
 	 *
 	 * @return mixed boolean if no $default is set, otherwise the whitelist value to the given key in case it exists or $default
 	 */
@@ -263,7 +263,7 @@ 
 	 * Checks if the current tag is whitelisted
 	 *
 	 * @param array $whitelist an array with whitelisted tag names
-	 * @param mixed $default   [optional] a default value in case the tag isn't whitelisted
+	 * @param string $default   [optional] a default value in case the tag isn't whitelisted
 	 *
 	 * @return mixed boolean if no $default is set, otherwise the whitelisted tag or $default
 	 */
@@ -314,7 +314,7 @@ 
 	 * shorthand for self::attributeIn('__BBTAG__', $array)
 	 *
 	 * @param array $array
-	 * @param mixed $default
+	 * @param string $default
 	 *
 	 * @return mixed
 	 */
@@ -327,7 +327,7 @@ 
 	 *
 	 * @param string $url the URL to check
 	 *
-	 * @return bool|string the url if valid, otherwise false
+	 * @return false|string the url if valid, otherwise false
 	 */
 	public function checkUrl($url){
 		if(filter_var($url, FILTER_VALIDATE_URL) === false){

Indentation +9 added lines, -10 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 /**
- * Class BaseModule
- *
- * @filesource   BaseModule.php
- * @created      12.10.2015
- * @package      chillerlan\bbcode\Modules
- * @author       Smiley <smiley@chillerlan.net>
- * @copyright    2015 Smiley
- * @license      MIT
- */
+	 * Class BaseModule
+	 *
+	 * @filesource   BaseModule.php
+	 * @created      12.10.2015
+	 * @package      chillerlan\bbcode\Modules
+	 * @author       Smiley <smiley@chillerlan.net>
+	 * @copyright    2015 Smiley
+	 * @license      MIT
+	 */
 
 namespace chillerlan\bbcode\Modules;
 
@@ -246,7 +246,6 @@ 
 
 	/**
 	 * Checks if an attribute exists and if it exists as key in a whitelist
-
 	 * @param string $name      the desired attributes name
 	 * @param array  $whitelist an array with whitelisted key -> value pairs
 	 * @param mixed  $default   [optional] a default value in case the attribute isn't set, defaults to false

src/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -259,7 +259,7 @@
 	/**
 	 * strng regexp bbcode killer
 	 *
-	 * @param string|array $bbcode BBCode as string or matches as array - callback from preg_replace_callback()
+	 * @param string $bbcode BBCode as string or matches as array - callback from preg_replace_callback()
 	 *
 	 * @return string
 	 * @throws \chillerlan\bbcode\BBCodeException

src/Modules/BaseModuleInterface.php

Indentation -1 removed lines

@@ -101,7 +101,6 @@
 
 	/**
 	 * Checks if an attribute exists and if it exists as key in a whitelist
-
 	 * @param string $name      the desired attributes name
 	 * @param array  $whitelist an array with whitelisted key -> value pairs
 	 * @param mixed  $default   [optional] a default value in case the attribute isn't set, defaults to false

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
 	 * @param string $name     the desired attributes name
 	 * @param mixed  $default  [optional] a default value in case the attribute isn't set, defaults to false
 	 *
-	 * @return mixed the attribute's value in case it exists, otherwise $default
+	 * @return string the attribute's value in case it exists, otherwise $default
 	 */
 	public function getAttribute($name, $default = false);
 
@@ -123,7 +123,7 @@ 
 	/**
 	 * Sanitizes the content to prevent vulnerabilities or compatibility problems
 	 *
-	 * @param $content string to sanitize
+	 * @param string $content string to sanitize
 	 *
 	 * @return string
 	 */

src/Modules/Html5/Video.php

Indentation +4 added lines, -4 removed lines

@@ -72,10 +72,10 @@
 
 				if($this->flash){
 					$player = '<object type="application/x-shockwave-flash" data="'.$video_url.'">'
-					          .'<param name="allowfullscreen" value="true">'
-					          .'<param name="wmode" value="opaque" />'
-					          .'<param name="movie" value="'.$video_url.'" />'
-					          .'</object>';
+							  .'<param name="allowfullscreen" value="true">'
+							  .'<param name="wmode" value="opaque" />'
+							  .'<param name="movie" value="'.$video_url.'" />'
+							  .'</object>';
 				}
 
 				return '<div'.$cssclass.'>'.$player.'</div>';

src/Traits/ClassLoaderTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
 	 * @param string $class     FQCN
 	 * @param string $interface FQCN
 	 *
-	 * @param mixed  $params    [optional] the following arguments are optional and will be passed to the class constructor if present.
+	 * @param \chillerlan\bbcode\ParserOptions  $params    [optional] the following arguments are optional and will be passed to the class constructor if present.
 	 *
 	 * @link https://github.com/chillerlan/framework/blob/master/src/Core/Traits/ClassLoaderTrait.php
 	 *

src/ParserExtensionInterface.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
 	 * ParserExtensionInterface constructor.
 	 *
 	 * @param \chillerlan\bbcode\ParserOptions|null $options
+	 * @return void
 	 */
 	public function __construct(ParserOptions $options = null);