Pink-Crab / Perique-BladeOne-Provider

src/BladeOne_Bootstrap.php

<?php

declare( strict_types=1 );

/**
 * Implementation of BladeOne for the PinkCrab Perique frameworks Renderable interface
 *
 * 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 <glynn.quelch@gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\BladeOne_Provider
 */

namespace PinkCrab\BladeOne;

use Dice\Dice;
use eftec\bladeone\BladeOne;
use PinkCrab\Perique\Application\Hooks;
use PinkCrab\BladeOne\BladeOne_Provider;
use PinkCrab\BladeOne\PinkCrab_BladeOne;
use PinkCrab\Perique\Application\Config;
use PinkCrab\Perique\Interfaces\Renderable;
use PinkCrab\Perique\Services\View\PHP_Engine;
use PinkCrab\BladeOne\Abstract_BladeOne_Config;

class BladeOne_Bootstrap {

	/**
	 * Sets the rules for bladeone and unsets the default PHP_Engine for rendering
	 *
	 * @param string $template_path
	 * @param string|null $compiled_path
	 * @param int $mode
	 * @param class-string|BladeOne $blade

The doc comment class-string|BladeOne at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|BladeOne.

	 * @return void
	 */
	public static function use( $template_path = null, ?string $compiled_path = null, int $mode = 0, $blade = null ) {

		add_filter(
			Hooks::APP_INIT_SET_DI_RULES,
			function( $rules ) use ( $template_path, $compiled_path, $mode, $blade ) {

				// Unset the global PHP_Engine useage.
				if ( array_key_exists( '*', $rules )
				&& array_key_exists( 'substitutions', $rules['*'] )
				&& array_key_exists( Renderable::class, $rules['*']['substitutions'] )
				&& is_a( $rules['*']['substitutions'][ Renderable::class ], PHP_Engine::class ) ) {

					// If template path is not set, get from renderable.
					if ( is_null( $template_path ) ) {
						$template_path = $rules['*']['substitutions'][ Renderable::class ]->base_view_path();
					}
					unset( $rules['*']['substitutions'][ Renderable::class ] );
				}

				// If there is no compiled path, set to to uploads.
				if ( is_null( $compiled_path ) ) {
					$wp_upload_dir = wp_upload_dir();
					$compiled_path = sprintf( '%1$s%2$scompiled%2$sblade', $wp_upload_dir['basedir'], \DIRECTORY_SEPARATOR );
				}

				// Get the version of Blade to start.
				$blade = self::get_blade_instance( $blade );

				$rules[ BladeOne_Provider::class ] = array(
					'substitutions' => array(
						PinkCrab_BladeOne::class => new $blade( $template_path, $compiled_path, $mode ),
					),
					'call'          => array(
						array( 'allow_pipe', array() ),
					),
				);

				$rules[ Renderable::class ] = array(
					'instanceOf' => BladeOne_Provider::class,
					'shared'     => true,
				);

				$rules[ Abstract_BladeOne_Config::class ] = array(
					'call' => array(
						array( 'set_renderable', array( array( Dice::INSTANCE => Renderable::class ) ) ),
					),
				);

				return $rules;
			}
		);
	}

	/**
	 * Gets the class used for bladeone instance
	 *
	 * @param mixed $blade
	 * @return class-string

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

	 */
	protected static function get_blade_instance( $blade ): string {
		// If we have a populated instance of BladeOne, get the full class name.
		if ( is_object( $blade ) && is_a( $blade, PinkCrab_BladeOne::class ) ) {
			$blade = get_class( $blade );
		}

		if ( is_string( $blade ) && is_a( $blade, PinkCrab_BladeOne::class, true ) ) {
			return $blade;
		}

		return PinkCrab_BladeOne::class;
	}
}