chillerlan / php-bbcode

examples/Psr4AutoloaderClass.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,7 +109,7 @@ 
 	 * Loads the class file for a given class name.
 	 *
 	 * @param string $class The fully-qualified class name.
-	 * @return mixed The mapped file name on success, or boolean false on
+	 * @return string|false The mapped file name on success, or boolean false on
 	 * failure.
 	 */
 	public function loadClass($class)
@@ -147,7 +147,7 @@ 
 	 *
 	 * @param string $prefix The namespace prefix.
 	 * @param string $relative_class The relative class name.
-	 * @return mixed Boolean false if no mapped file can be loaded, or the
+	 * @return false|string Boolean false if no mapped file can be loaded, or the
 	 * name of the mapped file that was loaded.
 	 */
 	protected function loadMappedFile($prefix, $relative_class)

Spacing +2 added lines, -2 removed lines

@@ -87,10 +87,10 @@
 	public function addNamespace($prefix, $base_dir, $prepend = false)
 	{
 		// normalize namespace prefix
-		$prefix = trim($prefix, '\\') . '\\';
+		$prefix = trim($prefix, '\\').'\\';
 
 		// normalize the base directory with a trailing separator
-		$base_dir = rtrim($base_dir, DIRECTORY_SEPARATOR) . '/';
+		$base_dir = rtrim($base_dir, DIRECTORY_SEPARATOR).'/';
 
 		// initialize the namespace prefix array
 		if (isset($this->prefixes[$prefix]) === false) {

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 -1 removed lines

@@ -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

Spacing +24 added lines, -24 removed lines

@@ -18,7 +18,7 @@ 
 /**
  * The base module implements the basic functionality for each module
  */
-class BaseModule implements BaseModuleInterface{
+class BaseModule implements BaseModuleInterface {
 
 	/**
 	 * The current bbcode tag
@@ -114,8 +114,8 @@ 
 	 *
 	 * @param \chillerlan\bbcode\BBTemp $bbtemp
 	 */
-	public function __construct(BBTemp $bbtemp = null){
-		if($bbtemp instanceof BBTemp){
+	public function __construct(BBTemp $bbtemp = null) {
+		if ($bbtemp instanceof BBTemp) {
 			$this->setBBTemp($bbtemp);
 		}
 	}
@@ -127,8 +127,8 @@ 
 	 *
 	 * @return $this
 	 */
-	public function setBBTemp(BBTemp $bbtemp){
-		foreach(['tag', 'attributes', 'content', 'parserOptions', 'languageInterface', 'depth'] as $var){
+	public function setBBTemp(BBTemp $bbtemp) {
+		foreach (['tag', 'attributes', 'content', 'parserOptions', 'languageInterface', 'depth'] as $var) {
 			$this->{$var} = $bbtemp->{$var};
 		}
 
@@ -140,10 +140,10 @@ 
 	 *
 	 * @return \chillerlan\bbcode\Modules\BaseModuleInfo
 	 */
-	public function getInfo(){
+	public function getInfo() {
 		$info = new BaseModuleInfo;
 
-		foreach(['modules', 'eol_token'] as $option){
+		foreach (['modules', 'eol_token'] as $option) {
 			$info->{$option} = $this->{$option};
 		}
 
@@ -156,7 +156,7 @@ 
 	 * @return \chillerlan\bbcode\Modules\Tagmap
 	 * @see \chillerlan\bbcode\Modules\ModuleInterface
 	 */
-	public function getTags(){
+	public function getTags() {
 		$tags = new Tagmap;
 		$tags->tags = $this->tags;
 		$tags->noparse_tags = $this->noparse_tags;
@@ -171,8 +171,8 @@ 
 	 * @return $this
 	 * @throws \chillerlan\bbcode\BBCodeException
 	 */
-	public function checkTag(){
-		if(!$this->tag || !in_array($this->tag, $this->tags)){
+	public function checkTag() {
+		if (!$this->tag || !in_array($this->tag, $this->tags)) {
 			throw new BBCodeException('tag ['.$this->tag.'] not supported.');
 		}
 
@@ -188,7 +188,7 @@ 
 	 *
 	 * @return string
 	 */
-	public function eol($str, $eol = '', $count = null){
+	public function eol($str, $eol = '', $count = null) {
 		return str_replace($this->parserOptions->eol_placeholder, $eol, $str, $count);
 	}
 
@@ -199,7 +199,7 @@ 
 	 *
 	 * @return $this
 	 */
-	public function clearEOL($eol = null){
+	public function clearEOL($eol = null) {
 		$eol = $eol ?: $this->eol_token;
 		$this->content = str_replace($this->parserOptions->eol_placeholder, $eol, $this->content);
 
@@ -211,7 +211,7 @@ 
 	 *
 	 * @return $this
 	 */
-	public function clearPseudoClosingTags(){
+	public function clearPseudoClosingTags() {
 		$this->content = preg_replace('#\[/('.$this->parserOptions->singletags.')]#is', '', $this->content);
 
 		return $this;
@@ -225,7 +225,7 @@ 
 	 *
 	 * @return mixed the attribute's value in case it exists, otherwise $default
 	 */
-	public function getAttribute($name, $default = false){
+	public function getAttribute($name, $default = false) {
 		return isset($this->attributes[$name]) && !empty($this->attributes[$name]) ? $this->attributes[$name] : $default;
 	}
 
@@ -238,7 +238,7 @@ 
 	 *
 	 * @return mixed boolean if no $default is set, otherwise the attribute's value in case it exists and is whitelisted or $default
 	 */
-	public function attributeIn($name, array $whitelist, $default = false){
+	public function attributeIn($name, array $whitelist, $default = false) {
 		return isset($this->attributes[$name]) && in_array($this->attributes[$name], $whitelist)
 			? $default !== false ? $this->attributes[$name] : true
 			: $default;
@@ -253,7 +253,7 @@ 
 	 *
 	 * @return mixed boolean if no $default is set, otherwise the whitelist value to the given key in case it exists or $default
 	 */
-	public function attributeKeyIn($name, array $whitelist, $default = false){
+	public function attributeKeyIn($name, array $whitelist, $default = false) {
 		return isset($this->attributes[$name]) && array_key_exists($this->attributes[$name], $whitelist)
 				? $default !== false ? $whitelist[$this->attributes[$name]] : true
 				: $default;
@@ -267,7 +267,7 @@ 
 	 *
 	 * @return mixed boolean if no $default is set, otherwise the whitelisted tag or $default
 	 */
-	public function tagIn(array $whitelist, $default = false){
+	public function tagIn(array $whitelist, $default = false) {
 		return in_array($this->tag, $whitelist)
 				? $default !== false ? $this->tag : true
 				: $default;
@@ -281,7 +281,7 @@ 
 	 * @return string
 	 * @codeCoverageIgnore
 	 */
-	public function sanitize($content){
+	public function sanitize($content) {
 		return 'Implement sanitize() method!';
 	}
 
@@ -292,7 +292,7 @@ 
 	 *
 	 * @see \chillerlan\bbcode\Modules\ModuleInterface::transform()
 	 */
-	public function transform(){
+	public function transform() {
 		$this->checkTag();
 
 		/** @var $this \chillerlan\bbcode\Modules\ModuleInterface */
@@ -306,7 +306,7 @@ 
 	 *
 	 * @return mixed $this->attributes['__BBTAG__']
 	 */
-	protected function bbtag($default = false){
+	protected function bbtag($default = false) {
 		return $this->getAttribute($this->parserOptions->bbtag_placeholder, $default);
 	}
 
@@ -318,7 +318,7 @@ 
 	 *
 	 * @return mixed
 	 */
-	protected function bbtagIn(array $array, $default = false){
+	protected function bbtagIn(array $array, $default = false) {
 		return $this->attributeIn($this->parserOptions->bbtag_placeholder, $array, $default);
 	}
 
@@ -329,8 +329,8 @@ 
 	 *
 	 * @return bool|string the url if valid, otherwise false
 	 */
-	public function checkUrl($url){
-		if(filter_var($url, FILTER_VALIDATE_URL) === false){
+	public function checkUrl($url) {
+		if (filter_var($url, FILTER_VALIDATE_URL) === false) {
 			return false;
 		}
 		// todo: check against whitelist?
@@ -346,7 +346,7 @@ 
 	 *
 	 * @return string
 	 */
-	public function wrap($content, $wrapper){
+	public function wrap($content, $wrapper) {
 		return $wrapper.$content.$wrapper;
 	}
 

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

Spacing +28 added lines, -28 removed lines

@@ -27,7 +27,7 @@ 
  *
  * @link http://www.developers-guide.net/c/152-bbcode-parser-mit-noparse-tag-selbst-gemacht.html
  */
-class Parser{
+class Parser {
 	use ClassLoaderTrait;
 
 	/**
@@ -139,7 +139,7 @@ 
 	 *
 	 * @param \chillerlan\bbcode\ParserOptions $options [optional]
 	 */
-	public function __construct(ParserOptions $options = null){
+	public function __construct(ParserOptions $options = null) {
 		$this->setOptions(!$options ? new ParserOptions : $options);
 		$this->BBTemp = new BBTemp;
 	}
@@ -151,22 +151,22 @@ 
 	 *
 	 * @throws \chillerlan\bbcode\BBCodeException
 	 */
-	public function setOptions(ParserOptions $options){
+	public function setOptions(ParserOptions $options) {
 		$this->parserOptions       = $options;
 		$this->baseModuleInterface = $this->__loadClass($this->parserOptions->baseModuleInterface, BaseModuleInterface::class);
 		$this->languageInterface   = $this->__loadClass($this->parserOptions->languageInterface, LanguageInterface::class);
 
-		if($this->parserOptions->parserExtensionInterface){
+		if ($this->parserOptions->parserExtensionInterface) {
 			$this->parserExtensionInterface =
 				$this->__loadClass($this->parserOptions->parserExtensionInterface, ParserExtensionInterface::class, $this->parserOptions);
 		}
 
 		$module_info = $this->baseModuleInterface->getInfo();
-		foreach($module_info->modules as $module){
+		foreach ($module_info->modules as $module) {
 			$this->moduleInterface = $this->__loadClass($module, ModuleInterface::class);
 
 			$tagmap = $this->moduleInterface->getTags();
-			foreach($tagmap->tags as $tag){
+			foreach ($tagmap->tags as $tag) {
 				$this->tagmap[$tag] = $module;
 			}
 
@@ -178,15 +178,15 @@ 
 		$this->parserOptions->eol_token  = $module_info->eol_token;
 		$this->parserOptions->singletags = implode('|', $this->singletags);
 
-		if(is_array($this->parserOptions->allowed_tags) && !empty($this->parserOptions->allowed_tags)){
-			foreach($this->parserOptions->allowed_tags as $tag){
-				if(array_key_exists($tag, $this->tagmap)){
+		if (is_array($this->parserOptions->allowed_tags) && !empty($this->parserOptions->allowed_tags)) {
+			foreach ($this->parserOptions->allowed_tags as $tag) {
+				if (array_key_exists($tag, $this->tagmap)) {
 					$this->allowed_tags[] = $tag;
 				}
 			}
 		}
-		else{
-			if($this->parserOptions->allow_all){
+		else {
+			if ($this->parserOptions->allow_all) {
 				$this->allowed_tags = array_keys($this->tagmap);
 			}
 		}
@@ -197,7 +197,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function getTagmap(){
+	public function getTagmap() {
 		ksort($this->tagmap);
 		return $this->tagmap;
 	}
@@ -207,7 +207,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function getAllowed(){
+	public function getAllowed() {
 		sort($this->allowed_tags);
 		return $this->allowed_tags;
 	}
@@ -217,7 +217,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function getNoparse(){
+	public function getNoparse() {
 		sort($this->noparse_tags);
 		return $this->noparse_tags;
 	}
@@ -227,7 +227,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function getSingle(){
+	public function getSingle() {
 		sort($this->singletags);
 		return $this->singletags;
 	}
@@ -239,8 +239,8 @@ 
 	 *
 	 * @return string
 	 */
-	public function parse($bbcode){
-		if($this->parserOptions->sanitize){
+	public function parse($bbcode) {
+		if ($this->parserOptions->sanitize) {
 			$bbcode = $this->baseModuleInterface->sanitize($bbcode);
 		}
 
@@ -264,12 +264,12 @@ 
 	 * @return string
 	 * @throws \chillerlan\bbcode\BBCodeException
 	 */
-	protected function __parse($bbcode){
+	protected function __parse($bbcode) {
 		static $callback_count = 0;
 		$callback = false;
 		$preg_error = PREG_NO_ERROR;
 
-		if(is_array($bbcode) && isset($bbcode['tag'], $bbcode['attributes'], $bbcode['content'])){
+		if (is_array($bbcode) && isset($bbcode['tag'], $bbcode['attributes'], $bbcode['content'])) {
 			$tag = strtolower($bbcode['tag']);
 			$attributes = $this->getAttributes($bbcode['attributes']);
 			$content = $bbcode['content'];
@@ -277,30 +277,30 @@ 
 			$callback = true;
 			$callback_count++;
 		}
-		else if(is_string($bbcode) && !empty($bbcode)){
+		else if (is_string($bbcode) && !empty($bbcode)) {
 			$tag = null;
 			$attributes = [];
 			$content = $bbcode;
 		}
-		else{
+		else {
 			return '';
 		}
 
-		if($callback_count < (int)$this->parserOptions->nesting_limit && !in_array($tag, $this->noparse_tags)){
+		if ($callback_count < (int)$this->parserOptions->nesting_limit && !in_array($tag, $this->noparse_tags)) {
 			$pattern = '#\[(?<tag>\w+)(?<attributes>(?:\s|=)[^]]*)?](?<content>(?:[^[]|\[(?!/?\1((?:\s|=)[^]]*)?])|(?R))*)\[/\1]#';
 			$content = preg_replace_callback($pattern, __METHOD__, $content);
 			$preg_error = preg_last_error();
 		}
 
 		// still testing...
-		if($preg_error !== PREG_NO_ERROR){
+		if ($preg_error !== PREG_NO_ERROR) {
 			// @codeCoverageIgnoreStart
 			$message = sprintf($this->languageInterface->parserExceptionCallback(), $tag, self::PREG_ERROR[$preg_error], $preg_error);
 			throw new BBCodeException($message);
 			// @codeCoverageIgnoreEnd
 		}
 
-		if($callback && isset($this->tagmap[$tag]) && in_array($tag, $this->allowed_tags)){
+		if ($callback && isset($this->tagmap[$tag]) && in_array($tag, $this->allowed_tags)) {
 			$this->BBTemp->tag               = $tag;
 			$this->BBTemp->attributes        = $attributes;
 			$this->BBTemp->content           = $content;
@@ -326,12 +326,12 @@ 
 	 * @return array
 	 * @throws \chillerlan\bbcode\BBCodeException
 	 */
-	protected function getAttributes($attributes){
+	protected function getAttributes($attributes) {
 		$attr = [];
 		$pattern = '#(?<name>^|\w+)\=(\'?)(?<value>[^\']*?)\2(?: |$)#';
 
-		if(preg_match_all($pattern, $attributes, $matches, PREG_SET_ORDER) > 0){
-			foreach($matches as $attribute){
+		if (preg_match_all($pattern, $attributes, $matches, PREG_SET_ORDER) > 0) {
+			foreach ($matches as $attribute) {
 				$name = empty($attribute['name']) ? $this->parserOptions->bbtag_placeholder : strtolower(trim($attribute['name']));
 
 				$value = trim($attribute['value']);
@@ -343,7 +343,7 @@ 
 
 		$preg_error = preg_last_error();
 
-		if($preg_error !== PREG_NO_ERROR){
+		if ($preg_error !== PREG_NO_ERROR) {
 			// @codeCoverageIgnoreStart
 			$message = sprintf($this->languageInterface->parserExceptionMatchall(), self::PREG_ERROR[$preg_error], $preg_error);
 			throw new BBCodeException($message);

Braces +3 added lines, -6 removed lines

@@ -184,8 +184,7 @@ 
 					$this->allowed_tags[] = $tag;
 				}
 			}
-		}
-		else{
+		} else{
 			if($this->parserOptions->allow_all){
 				$this->allowed_tags = array_keys($this->tagmap);
 			}
@@ -276,13 +275,11 @@ 
 
 			$callback = true;
 			$callback_count++;
-		}
-		else if(is_string($bbcode) && !empty($bbcode)){
+		} else if(is_string($bbcode) && !empty($bbcode)){
 			$tag = null;
 			$attributes = [];
 			$content = $bbcode;
-		}
-		else{
+		} else{
 			return '';
 		}
 

examples/MyAwesomeParserExtension.php

Indentation +2 added lines, -2 removed lines

@@ -33,12 +33,12 @@
 
 		$search = [
 			"\t", // lets convert all tabs into 4 spaces
-		    '{__BASE_URL__}', // assume we use a special token for our base url
+			'{__BASE_URL__}', // assume we use a special token for our base url
 		];
 
 		$replace = [
 			'    ',
-		    'https://your.base/url/'
+			'https://your.base/url/'
 		];
 
 		return str_replace($search, $replace, $bbcode);

Spacing +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
 /**
  * A tiny custom preparser as ground to start from
  */
-class MyAwesomeParserExtension implements ParserExtensionInterface{
+class MyAwesomeParserExtension implements ParserExtensionInterface {
 
 	/**
 	 * Pre-parser
@@ -29,7 +29,7 @@ 
 	 *
 	 * @return string preparsed bbcode
 	 */
-	public function pre($bbcode){
+	public function pre($bbcode) {
 
 		$search = [
 			"\t", // lets convert all tabs into 4 spaces
@@ -61,7 +61,7 @@ 
 	 *
 	 * @return string postparsed bbcode
 	 */
-	public function post($bbcode){
+	public function post($bbcode) {
 		return $bbcode;
 	}
 

examples/MyModules/MyAwesomeBaseModule.php

Spacing +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
 /**
  * The base module implements the basic functionality for each module (custom HTML5)
  */
-class MyAwesomeBaseModule extends BaseModule implements BaseModuleInterface{
+class MyAwesomeBaseModule extends BaseModule implements BaseModuleInterface {
 
 	/**
 	 * Holds an array of FQN strings to the current base module's children
@@ -45,8 +45,8 @@ 
 	 *
 	 * @return string
 	 */
-	public function sanitize($content){
-		return htmlspecialchars($content, ENT_NOQUOTES|ENT_HTML5, 'UTF-8', false);
+	public function sanitize($content) {
+		return htmlspecialchars($content, ENT_NOQUOTES | ENT_HTML5, 'UTF-8', false);
 	}
 
 }

examples/MyModules/MyAwesomeModule.php

Spacing +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
 /**
  * Transforms several simple text tags into HTML5 (custom)
  */
-class MyAwesomeModule extends MyAwesomeBaseModule implements ModuleInterface{
+class MyAwesomeModule extends MyAwesomeBaseModule implements ModuleInterface {
 
 	/**
 	 * An array of tags the module is able to process
@@ -35,8 +35,8 @@ 
 	 * @see \chillerlan\bbcode\Modules\BaseModuleInterface::transform()
 	 * @internal
 	 */
-	public function _transform(){
-		if(empty($this->content)){
+	public function _transform() {
+		if (empty($this->content)) {
 			return '';
 		}
 

examples/example_html.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * @filesource   example.php
- * @created      19.09.2015
- * @author       Smiley <smiley@chillerlan.net>
- * @copyright    2015 Smiley
- * @license      MIT
- */
+	 * @filesource   example.php
+	 * @created      19.09.2015
+	 * @author       Smiley <smiley@chillerlan.net>
+	 * @copyright    2015 Smiley
+	 * @license      MIT
+	 */
 
 require_once '../vendor/autoload.php';
 

Spacing +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 
 echo $content.PHP_EOL;
 
-echo '<!-- bbcode: '.round((microtime(true)-$timer), 5).'s -->'.PHP_EOL;
+echo '<!-- bbcode: '.round((microtime(true) - $timer), 5).'s -->'.PHP_EOL;
 
 ?>
 <!-- let's assume you use a common js framework in your project -->

examples/example_markdown.php

Spacing +1 added lines, -1 removed lines

@@ -44,4 +44,4 @@
 
 echo $content.PHP_EOL;
 
-echo PHP_EOL.'bbcode: '.round((microtime(true)-$timer), 6).'s';
+echo PHP_EOL.'bbcode: '.round((microtime(true) - $timer), 6).'s';

src/BBCodeException.php

Spacing +1 added lines, -1 removed lines

@@ -17,6 +17,6 @@
 /**
  * Placeholder
  */
-class BBCodeException extends Exception{
+class BBCodeException extends Exception {
 
 }