Maslosoft\Zamm\Capture

Complexity

Total Complexity

10

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	open()	0	16	3
A	getMd()	0	4	1
A	close()	0	14	2
A	get()	0	12	3
A	getHtml()	0	4	1

<?php

/**
 * This software package is licensed under `AGPL, Commercial` license[s].
 *
 * @package maslosoft/zamm
 * @license AGPL, Commercial
 *
 * @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
 * @link https://maslosoft.com/zamm/
 */

namespace Maslosoft\Zamm;

use Exception;
use Maslosoft\Zamm\Helpers\Tabs;
use Maslosoft\Zamm\Helpers\Wrapper;

/**
 * Capture part of php code for later use.
 * This is intended for parts of code which should be evaluated,
 * for instance for HTML widgets.
 *
 * Just after evluation or later, executing code can be captured and
 * displayed on HTML page.
 *
 * Example:
 * ```php
 * Capture::open();
 * echo 'Hi World!';
 * Capture::close();
 * ```
 * Above coge is executed, moreover php code is now available in `Capture` class,
 * and can be salvaged by `get`:
 * ```php
 * echo Capute::get(); //echo 'Hi World!';
 * ```
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class Capture
{

	/**
	 * Array of snippets
	 * @var string[]
	 */
	private static $snippets = [];

	/**
	 * Id counter for auto id's
	 * @var int
	 */
	private static $idCounter = 0;

	/**
	 * Whenever capture is opened
	 * @var bool
	 */
	private static $isOpen = false;

	/**
	 * Currently capturing id
	 * @var int|string
	 */
	private static $currentId = 0;

	/**
	 * Currently captured file
	 * @var string
	 */
	private static $currentFile = '';

	/**
	 * Currentlty captured starting line
	 * @var int
	 */
	private static $currentLine = 0;

	/**
	 * Open PHP capturing block
	 *
	 * @param int|string $id
	 */
	public static function open($id = null)
	{
		if (self::$isOpen)
		{
			throw new Exception('Capture is already open, close block before capturing another snippet');
		}
		if (null === $id)
		{
			$id = self::$idCounter++;
		}
		self::$isOpen = true;
		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1)[0];
		self::$currentId = $id;
		self::$currentFile = $trace['file'];
		self::$currentLine = $trace['line'];
	}

	/**
	 * Close php capturing block and get it wrapped
	 * @return Wrapper
	 */
	public static function close()
	{
		if (!self::$isOpen)
		{
			throw new Exception('Capture is not open, open closing capturing block');
		}
		self::$isOpen = false;
		$lines = file(self::$currentFile);
		$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1)[0];
		$fragment = array_slice($lines, self::$currentLine, $trace['line'] - self::$currentLine - 1);

		Tabs::trim($fragment);
		return new Wrapper(self::$snippets[self::$currentId] = implode('', $fragment));
	}

	/**
	 * Get last snipped or choosen by id.
	 * @param int|string $id
	 * @return Wrapper
	 */
	public static function get($id = null)
	{
		if (self::$isOpen)
		{
			throw new Exception('Capture is open, close block before getting snippet');
		}
		if (null === $id)
		{
			$id = self::$currentId;
		}
		return new Wrapper(self::$snippets[$id]);
	}

	/**
	 * Get captured PHP block, additionally wrapped by markdown
	 * fenced PHP code mark. This can be directly outputted to md file.
	 * @deprecated use Wrapper instead: append ->md
	 * @param int|string $id
	 */
	public static function getMd($id = null)
	{
		return sprintf("```php\n%s\n```", self::get($id));
	}

	/**
	 * Get captured PHP block, additionally wrapped by html pre and code tags.
	 * This can be directly outputted to HTML file.
	 * @deprecated use Wrapper instead: append ->html
	 * @param int|string $id
	 */
	public static function getHtml($id = null)
	{
		return sprintf('<pre class="php"><code>%s</code></pre>', self::get($id));
	}

}