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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 <?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\Converters;
use Maslosoft\MiniView\MiniView;
use Maslosoft\Zamm\FileDecorators\FileDecorator;
use Maslosoft\Zamm\Interfaces\ConverterInterface;
use Maslosoft\Zamm\Interfaces\OutputInterface;
/**
* Convert PHP documentation file into md
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class PhpConverter implements ConverterInterface
{
/**
*
* @var MiniView
*/
private $view = null;
/**
* File decorator
* @var FileDecorator
*/
private $decorator = null;
/**
*
* @var string
*/
private $_fileName;
/**
*
* @var string
*/
private $_tempName;
private $_doc = '';
public function __construct()
{
$this->decorator = new FileDecorator($this);
}
public function input($documentation, $fileName)
{
$this->decorator->decorate($documentation);
$this->_tempName = sprintf('%s.tmp', $this->_fileName);
$this->_fileName = $fileName;
$this->view = new MiniView($this, dirname($this->_tempName));
$this->_doc = $this->view->render(basename($this->_tempName), [], true);
}
public function output(OutputInterface $output)
{
$outputName = preg_replace('~\.php~', '', $this->_fileName);
$output->output($this->_doc, $outputName);
}
}
API documentation generated by ApiGen