PinkCrab_BladeOne::set_esc_function() - Code Metrics - Pink-Crab/BladeOne_Engine - Measure and Improve Code Quality continuously with Scrutinizer

PinkCrab_BladeOne::set_esc_function() A
last analyzed 2025-01-28 22:05 UTC

↳ Parent: PinkCrab_BladeOne

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	8
rs	10

<?php

declare( strict_types=1 );

/**
 * Wrapper for BladeOne with HTML enabled
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Glynn Quelch <[email protected]>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\BladeOne_Engine
 */

// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase

namespace PinkCrab\BladeOne;

use COM;
use eftec\bladeone\BladeOne;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use eftec\bladeonehtml\BladeOneHtml;
use PinkCrab\Perique\Application\App;
use PinkCrab\Perique\Services\View\View;
use PinkCrab\Perique\Services\View\View_Model;
use PinkCrab\Perique\Services\View\Component\Component;

/**
 * Custom BladeOne Engine with HTML Escaping
 */
class PinkCrab_BladeOne extends BladeOne {
	use BladeOneHtml;

	public const SETUP_CONFIG = 'PinkCrab/BladeOne_Engine/Setup_Config';

	public const COMMENT_PHP  = 0;
	public const COMMENT_RAW  = 1;
	public const COMMENT_NONE = 2;

	/**
	 * Bob the constructor.
	 * The folder at $compiled_path is created in case it doesn't exist.
	 *
	 * @param string  $template_path If null then it uses (caller_folder)/views
	 * @param string  $compiled_path If null then it uses (caller_folder)/compiles
	 * @param integer $mode          =[BladeOne::MODE_AUTO,BladeOne::MODE_DEBUG,BladeOne::MODE_FAST,BladeOne::MODE_SLOW][$i]
	 * @param integer $comment_mode  =[BladeOne::COMMENT_PHP,BladeOne::COMMENT_RAW,BladeOne::COMMENT_NONE][$i]
	 */
	public function __construct( $template_path = null, $compiled_path = null, $mode = 0, $comment_mode = 0 ) {
		parent::__construct( $template_path, $compiled_path, $mode, $comment_mode );

		// Add the viewModel directive.
		$this->directiveRT( 'viewModel', fn( $expression ) => $this->view_model( $expression, true ) );

		// Add the component directive.
		$this->directiveRT( 'viewComponent', fn( $expression ) => $this->component( $expression, true ) );

		// Add the WP_Nonce directive.
		$this->directiveRT(
			'nonce',
			function ( string $action, ?string $field = null, bool $inc_referer = true ): void {
				\wp_nonce_field(
					$action,
					$field ?? '_pcnonce',
					$inc_referer,
					true
				);
			}
		);

		// Allow other plugins to add their own directives.
		\do_action( self::SETUP_CONFIG, $this );
	}

	/**
	 * The esc function to use
	 *
	 * @var callable(mixed):string
	 */
	protected static $esc_function = 'esc_html';

	/**
	 * The default echo format
	 *
	 * @var string
	 */
	protected string $echoFormat = '\esc_html(%s)'; //phpcs:ignore WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase


	/**
	 * Sets the esc function to use
	 *
	 * @param string $esc_function
	 * @return void
	 */
	public function set_esc_function( string $esc_function ): void {
		// Throw exception if not a valid callable.
		if ( ! \is_callable( $esc_function ) ) {
			throw new \InvalidArgumentException( 'Invalid esc function provided.' );
		}

		static::$esc_function = $esc_function;
		$this->echoFormat     = sprintf( '\\%s(%%s)', $esc_function ); //phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
	}

	/**
	 * Returns the template paths
	 *
	 * @return string[]
	 */
	public function get_template_paths(): array {
		return $this->templatePath; //phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
	}

	/**
	 * Escape HTML entities in a string.
	 *
	 * @param integer|float|string|null|mixed[]|object $value
	 * @return string
	 */
	public static function e( $value ): string {
		if ( \is_null( $value ) ) {
			return '';
		}
		if ( \is_array( $value ) || \is_object( $value ) ) {
			return \call_user_func( static::$esc_function, \print_r( $value, true ) );//phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
		}
		if ( \is_numeric( $value ) ) {
			$value = (string) $value;
		}
		return \call_user_func( static::$esc_function, $value );
	}

	/**
	 * Renders  component
	 *
	 * @param Component $component  The component to render
	 * @param boolean   $print_mode Print or Return the HTML
	 *
	 * @return string|void
	 */
	public function component( Component $component, bool $print_mode = true ) {
		/**
		 * Creates a new instance of the view.
		 *
		 * @var View
		 */
		$view = App::view();

		return $view->component( $component, $print_mode );
	}

	/**
	 * Renders a view model
	 *
	 * @param View_Model $view_model The view model to render
	 * @param boolean    $print_mode Print or Return the HTML
	 *
	 * @return string|void
	 */
	public function view_model( View_Model $view_model, bool $print_mode = true ) {
		/**
		 * Creates a new instance of the view.
		 *
		 * @var View
		 */
		$view = App::view();

		return $view->view_model( $view_model, $print_mode );
	}

	/**
	 * Compile the auth statements into valid PHP.
	 *
	 * @param string $expression
	 * @return string
	 */
	protected function compileAuth( $expression = '' ): string {
		$role = $this->stripParentheses( $expression );
		if ( $role === '' ) {
			return $this->phpTag . 'if(!PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
		}

		return $this->phpTag . "if(!PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) && \$this->currentRole==$role): ?>";
	}

	/**
	 * Compile the elseauth statements into valid PHP.
	 *
	 * @param string $expression
	 * @return string
	 */
	protected function compileElseAuth( $expression = '' ): string {
		$role = $this->stripParentheses( $expression );
		if ( $role === '' ) {
			return $this->phpTag . 'else: ?>';
		}

		return $this->phpTag . "elseif(!PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) && \$this->currentRole==$role): ?>";
	}

	/**
	 * Compile the guest statements into valid PHP.
	 *
	 * @param string|null $expression
	 * @return string
	 */
	protected function compileGuest( $expression = null ): string {

		if ( $expression === null ) {
			return $this->phpTag . 'if(PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
		}

		$role = $this->stripParentheses( $expression );
		if ( $role === '' ) {
			return $this->phpTag . 'if(PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
		}

		return $this->phpTag . "if(PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) || \$this->currentRole!=$role): ?>";
	}

	/**
	 * Compile the else statements into valid PHP.
	 *
	 * @param string|null $expression
	 * @return string
	 */
	protected function compileElseGuest( $expression ): string {
		$role = $this->stripParentheses( $expression );
		if ( $role === '' ) {
			return $this->phpTag . 'else: ?>';
		}

		return $this->phpTag . "elseif(PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) || \$this->currentRole!=$role): ?>";
	}

	/**
	 * Get the comment mode.
	 *
	 * @return integer
	 */
	public function getCommentMode(): int {
		return $this->commentMode;
	}
}


1			<?php
2
3			declare( strict_types=1 );
4
5			/**
6			* Wrapper for BladeOne with HTML enabled
7			*
8			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
9			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
10			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
11			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
12			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
13			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
14			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
15			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
16			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
17			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
18			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
19			*
20			* @author Glynn Quelch <[email protected]>
21			* @license http://www.opensource.org/licenses/mit-license.html MIT License
22			* @package PinkCrab\BladeOne_Engine
23			*/
24
25			// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
26
27			namespace PinkCrab\BladeOne;
28
29			use COM;
30			use eftec\bladeone\BladeOne;
			0 ignored issues – show Bug introduced 2023-03-18 01:39 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `PinkCrab\BladeOne\BladeOne`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
31			use eftec\bladeonehtml\BladeOneHtml;
32			use PinkCrab\Perique\Application\App;
33			use PinkCrab\Perique\Services\View\View;
34			use PinkCrab\Perique\Services\View\View_Model;
35			use PinkCrab\Perique\Services\View\Component\Component;
36
37			/**
38			* Custom BladeOne Engine with HTML Escaping
39			*/
40			class PinkCrab_BladeOne extends BladeOne {
41			use BladeOneHtml;
42
43			public const SETUP_CONFIG = 'PinkCrab/BladeOne_Engine/Setup_Config';
44
45			public const COMMENT_PHP = 0;
46			public const COMMENT_RAW = 1;
47			public const COMMENT_NONE = 2;
48
49			/**
50			* Bob the constructor.
51			* The folder at $compiled_path is created in case it doesn't exist.
52			*
53			* @param string $template_path If null then it uses (caller_folder)/views
54			* @param string $compiled_path If null then it uses (caller_folder)/compiles
55			* @param integer $mode =[BladeOne::MODE_AUTO,BladeOne::MODE_DEBUG,BladeOne::MODE_FAST,BladeOne::MODE_SLOW][$i]
56			* @param integer $comment_mode =[BladeOne::COMMENT_PHP,BladeOne::COMMENT_RAW,BladeOne::COMMENT_NONE][$i]
57			*/
58			public function __construct( $template_path = null, $compiled_path = null, $mode = 0, $comment_mode = 0 ) {
59			parent::__construct( $template_path, $compiled_path, $mode, $comment_mode );
60
61			// Add the viewModel directive.
62			$this->directiveRT( 'viewModel', fn( $expression ) => $this->view_model( $expression, true ) );
63
64			// Add the component directive.
65			$this->directiveRT( 'viewComponent', fn( $expression ) => $this->component( $expression, true ) );
66
67			// Add the WP_Nonce directive.
68			$this->directiveRT(
69			'nonce',
70			function ( string $action, ?string $field = null, bool $inc_referer = true ): void {
71			\wp_nonce_field(
72			$action,
73			$field ?? '_pcnonce',
74			$inc_referer,
75			true
76			);
77			}
78			);
79
80			// Allow other plugins to add their own directives.
81			\do_action( self::SETUP_CONFIG, $this );
82			}
83
84			/**
85			* The esc function to use
86			*
87			* @var callable(mixed):string
88			*/
89			protected static $esc_function = 'esc_html';
90
91			/**
92			* The default echo format
93			*
94			* @var string
95			*/
96			protected string $echoFormat = '\esc_html(%s)'; //phpcs:ignore WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase
97
98
99			/**
100			* Sets the esc function to use
101			*
102			* @param string $esc_function
103			* @return void
104			*/
105			public function set_esc_function( string $esc_function ): void {
106			// Throw exception if not a valid callable.
107			if ( ! \is_callable( $esc_function ) ) {
108			throw new \InvalidArgumentException( 'Invalid esc function provided.' );
109			}
110
111			static::$esc_function = $esc_function;
112			$this->echoFormat = sprintf( '\\%s(%%s)', $esc_function ); //phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
113			}
114
115			/**
116			* Returns the template paths
117			*
118			* @return string[]
119			*/
120			public function get_template_paths(): array {
121			return $this->templatePath; //phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
122			}
123
124			/**
125			* Escape HTML entities in a string.
126			*
127			* @param integer\|float\|string\|null\|mixed[]\|object $value
128			* @return string
129			*/
130			public static function e( $value ): string {
131			if ( \is_null( $value ) ) {
132			return '';
133			}
134			if ( \is_array( $value ) \|\| \is_object( $value ) ) {
135			return \call_user_func( static::$esc_function, \print_r( $value, true ) );//phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
136			}
137			if ( \is_numeric( $value ) ) {
138			$value = (string) $value;
139			}
140			return \call_user_func( static::$esc_function, $value );
141			}
142
143			/**
144			* Renders component
145			*
146			* @param Component $component The component to render
147			* @param boolean $print_mode Print or Return the HTML
148			*
149			* @return string\|void
150			*/
151			public function component( Component $component, bool $print_mode = true ) {
152			/**
153			* Creates a new instance of the view.
154			*
155			* @var View
156			*/
157			$view = App::view();
158
159			return $view->component( $component, $print_mode );
160			}
161
162			/**
163			* Renders a view model
164			*
165			* @param View_Model $view_model The view model to render
166			* @param boolean $print_mode Print or Return the HTML
167			*
168			* @return string\|void
169			*/
170			public function view_model( View_Model $view_model, bool $print_mode = true ) {
171			/**
172			* Creates a new instance of the view.
173			*
174			* @var View
175			*/
176			$view = App::view();
177
178			return $view->view_model( $view_model, $print_mode );
179			}
180
181			/**
182			* Compile the auth statements into valid PHP.
183			*
184			* @param string $expression
185			* @return string
186			*/
187			protected function compileAuth( $expression = '' ): string {
188			$role = $this->stripParentheses( $expression );
189			if ( $role === '' ) {
190			return $this->phpTag . 'if(!PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
191			}
192
193			return $this->phpTag . "if(!PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) && \$this->currentRole==$role): ?>";
194			}
195
196			/**
197			* Compile the elseauth statements into valid PHP.
198			*
199			* @param string $expression
200			* @return string
201			*/
202			protected function compileElseAuth( $expression = '' ): string {
203			$role = $this->stripParentheses( $expression );
204			if ( $role === '' ) {
205			return $this->phpTag . 'else: ?>';
206			}
207
208			return $this->phpTag . "elseif(!PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) && \$this->currentRole==$role): ?>";
209			}
210
211			/**
212			* Compile the guest statements into valid PHP.
213			*
214			* @param string\|null $expression
215			* @return string
216			*/
217			protected function compileGuest( $expression = null ): string {
218
219			if ( $expression === null ) {
220			return $this->phpTag . 'if(PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
221			}
222
223			$role = $this->stripParentheses( $expression );
224			if ( $role === '' ) {
225			return $this->phpTag . 'if(PinkCrab\FunctionConstructors\Strings\isBlank($this->currentUser)): ?>';
226			}
227
228			return $this->phpTag . "if(PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) \|\| \$this->currentRole!=$role): ?>";
229			}
230
231			/**
232			* Compile the else statements into valid PHP.
233			*
234			* @param string\|null $expression
235			* @return string
236			*/
237			protected function compileElseGuest( $expression ): string {
238			$role = $this->stripParentheses( $expression );
239			if ( $role === '' ) {
240			return $this->phpTag . 'else: ?>';
241			}
242
243			return $this->phpTag . "elseif(PinkCrab\FunctionConstructors\Strings\isBlank(\$this->currentUser) \|\| \$this->currentRole!=$role): ?>";
244			}
245
246			/**
247			* Get the comment mode.
248			*
249			* @return integer
250			*/
251			public function getCommentMode(): int {
252			return $this->commentMode;
253			}
254			}
255

Pink-Crab / BladeOne_Engine

PinkCrab_BladeOne::set_esc_function() A last analyzed 2025-01-28 22:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PinkCrab_BladeOne::set_esc_function() A
last analyzed 2025-01-28 22:05 UTC