Maslosoft Zamm API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
<?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\Helpers;
/**
* This class hides fenced code from processing,
* by replacing fenced fragments with placeholder,
* and then this can also bring fenced fragments back.
*
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class FenceHolder
{
private $fences = [];
public function hide(&$docBlock)
{
$matches = [];
preg_match_all('~(```.*?```)~ms', $docBlock, $matches);
if (empty($matches[0]))
{
return;
}
$i = 0;
// Collect matches
foreach ($matches[0] as $match)
{
$key = sprintf('~%s@%s~', __CLASS__, $i++);
$this->fences[$key] = $match;
}
$docBlock = str_replace(array_values($this->fences), array_keys($this->fences), $docBlock);
}
public function reveal(&$docBlock)
{
if (empty($this->fences))
{
return;
}
$docBlock = str_replace(array_keys($this->fences), array_values($this->fences), $docBlock);
}
}
API documentation generated by ApiGen