Htsl\Htsl

Complexity

Total Complexity

22

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	4

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	parse()	0	4	1
A	compile()	0	12	2
A	setFileGetter()	0	6	1
A	setBasePath()	0	6	2
A	isDebug()	0	4	1
A	execute()	0	4	1
A	getConfig()	0	13	3
C	getFilePath()	0	23	7
A	getFileContent()	0	4	2
A	getDefaultConfigs()	0	4	1

<?php

namespace Htsl;

use Htsl\ReadingBuffer\Contracts\ABuffer;
use Htsl\ReadingBuffer\StringBuffer;
use Htsl\ReadingBuffer\FileBuffer;
use Htsl\Parser\Document;
use Htsl\Helper\DefaultConfigs;
use Htsl\Helper\IConfigProvider;

////////////////////////////////////////////////////////////////

/**
 * @link http://htsl.fenzland.com/ Document of Htsl.php
 *
 * @license https://opensource.org/licenses/MIT MIT
 *
 * @author Fenz <uukoo@163.com>
 */
class Htsl implements IConfigProvider
{
	/**
	 * Getter of file content.
	 *
	 * @var callable
	 *
	 * @access protected
	 */
	protected $fileGetter;

	/**
	 * The base path.
	 *
	 * @var string
	 *
	 * @access protected
	 */
	protected $basePath;

	/**
	 * Configurations.
	 *
	 * @var array
	 *
	 * @access protected
	 */
	protected $config;

	/**
	 * Constructor of HTSL
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @param array $config
	 */
	public function __construct( array$config=[] )
	{
		$this->config= array_replace_recursive($this->getDefaultConfigs(),$config);

Equals sign not aligned correctly; expected 1 space but found 0 spaces

	}

	/**
	 * Parsing a HTSL code string into HTML or PHP code string.
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @param  string $content
	 *
	 * @return string
	 */
	public function parse( string$content ):string
	{
		return $this->execute(new StringBuffer($this,$content));
	}

	/**
	 * Compiling a HTSL file into a HTML or PHP file.
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @param  string $fromFile
	 * @param  string $toFile
	 *
	 * @return int|string
	 */
	public function compile( string$fromFile, string$toFile='' )
	{
		$fromFile= $this->getFilePath($fromFile);

Consider using a different name than the parameter $fromFile. This often makes code more readable.

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		$result= $this->execute(new FileBuffer($this,$fromFile));

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		if( $toFile ){
			return file_put_contents($toFile,$result);
		}else{
			return $result;
		}
	}

	/**
	 * Setting the file getter.
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @param callable $fileGetter
	 */
	public function setFileGetter( callable$fileGetter ):self
	{
		$this->fileGetter=$fileGetter;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		return $this;
	}

	/**
	 * Setting the base path of the HTSL project to parse.
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @param string $basePath
	 *
	 * @return self
	 */
	public function setBasePath( string$basePath ):self
	{
		$this->basePath= '/'===substr($basePath,-1) ? substr($basePath,0,-1) : $basePath;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		return $this;
	}

	/**
	 * Returning whether the debug model is on or off.
	 *
	 * @api
	 *
	 * @access public
	 *
	 * @return boolean
	 */
	public function isDebug():bool
	{
		return !!$this->getConfig('debug');
	}

	/**
	 * Executing the parsing.
	 *
	 * @internal
	 *
	 * @access protected
	 *
	 * @param  \Htsl\ReadingBuffer\Contracts\ABuffer $buffer
	 *
	 * @return string
	 */
	protected function execute( ABuffer$buffer ):string
	{
		return (new Document($this,$buffer))->content;
	}

	/**
	 * Getting the config of Htsl.
	 *
	 * @internal
	 *
	 * @access public
	 *
	 * @param  string $keys

Should the type for parameter $keys not be string[]?

	 *
	 * @return mixed
	 */
	public function getConfig( string...$keys )
	{
		$result= $this->config;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		foreach( $keys as $key ){
			if( !isset($result[$key]) )
				{ return null; }

			$result= $result[$key];

Equals sign not aligned correctly; expected 1 space but found 0 spaces

		}

		return $result;
	}

	/**
	 * Getting the real file path of the HTSL file by relative path.
	 *
	 * @internal
	 *
	 * @access public
	 *
	 * @param  string      $filePath
	 * @param  string|null $path
	 *
	 * @return string
	 */
	public function getFilePath( string$filePath, string$path=null ):string
	{
		if( !isset($this->basePath) )
			{ throw new \Exception('BasePath musbe set.'); }

		if( !strlen($filePath) )
			{ throw new \Exception('FilePath cannot be empty.'); }

		if( '/'===$filePath{0} ){
			if( is_null($path) )
				{ return $filePath; }
			else
				{ return $this->basePath.$filePath; }
		}else{
			if( !strlen($path) )
				{ return $this->basePath.'/'.$filePath; }
			elseif( '/'===substr($path,-1) )
				{ return $path.$filePath; }
			else
				{ return $path.'/'.$filePath; }
		}

	}

	/**
	 * Getting the content of file.
	 *
	 * @internal
	 *
	 * @access public
	 *
	 * @param  string $filePath
	 *
	 * @return string
	 */
	public function getFileContent( string$filePath ):string
	{
		return isset($this->fileGetter) ? $this->fileGetter($filePath) : file_get_contents($filePath);
	}

	/**
	 * Getting default config.
	 *
	 * @internal
	 *
	 * @access private
	 *
	 * @return array
	 */
	private function getDefaultConfigs():array
	{
		return DefaultConfigs::get();
	}
}

As per coding style, files should not end with a newline character.