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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 <?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 Maslosoft\Zamm\Interfaces\SourceAccessorInterface;
use Maslosoft\Zamm\Traits\SourceMagic;
use UnexpectedValueException;
/**
* Api Url generator
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class ApiUrl implements SourceAccessorInterface
{
use SourceMagic;
private static $sources = [];
private $dotName = '';
private $source = '';
private $className = '';
public function __construct($className = null, $text = '')
{
$this->dotName = str_replace('\\', '.', $className);
$this->className = $className;
}
/**
* Set root url of current project API. This can be relative or absolute url.
*
* Set url for many projects with namespaces - this allows cross-linking different projects:
*
* ```
* ApiUrl::setRoot([
* '/mangan/api' => 'Maslosoft\\Mangan\\'
* '/addendum/api' => 'Maslosoft\\Addendum\\'
* ]);
* ```
*
* Could also be used for one project, but might result in wrong url if
* used on classes outside of project:
*
* ```
* ApiUrl::setRoot('/mangan/api');
* ```
*
*
* @param string|string[] $apiUrl
*/
public static function setRoot($apiUrl)
{
if (is_string($apiUrl))
{
self::$sources[rtrim($apiUrl, '/')] = [];
}
elseif (is_array($apiUrl))
{
$urls = [];
foreach ($apiUrl as $url => $ns)
{
if (!is_array($ns))
{
$ns = [$ns];
}
foreach ($ns as $nsIndex => $oneNs)
{
$ns[$nsIndex] = self::normalize($oneNs);
}
$urls[rtrim($url, '/')] = $ns;
}
self::$sources = array_merge(self::$sources, $urls);
}
else
{
throw new UnexpectedValueException(sprintf('Expected `apiUrl` to be string or array, got `%s`', gettype($apiUrl)));
}
}
public function method($name)
{
// https://df.home/zamm/api/class-Maslosoft.Zamm.Decorators.AbstractDecorator.html#_decorate
return sprintf('%s/class-%s.html#_%s', $this->resolveSource($this->resolveMethodClass($name)), $this->dotName, $name);
}
public function property($name)
{
// https://df.home/zamm/api/class-Maslosoft.Zamm.Zamm.html#$decorators
return sprintf('%s/class-%s.html#$%s', $this->resolveSource($this->resolvePropertyClass($name)), $this->dotName, $name);
}
public static function __callStatic($name, $arguments)
{
}
public function __toString()
{
return sprintf('%s/class-%s.html', $this->resolveSource($this->className), $this->dotName);
}
/**
* TODO: Resolve real class where property was defined
* @param string $name Property name
* @return string
*/
private function resolvePropertyClass($name)
{
return $this->className;
}
/**
* TODO: Resolve real class where method was defined
* @param string $name Method name
* @return string
*/
private function resolveMethodClass($name)
{
return $this->className;
}
private function resolveSource($className)
{
// Many sources found, search for proper api source
$url = '';
$source = '';
$search = self::normalize($className);
foreach (self::$sources as $url => $nss)
{
foreach ($nss as $ns)
{
if (empty($ns) || !is_string($url))
{
continue;
}
$pos = strpos($search, $ns);
if ($pos === false)
{
continue;
}
if ($pos === 0)
{
$source = $url;
break;
}
}
}
// Last resort url assigning
if (empty($source))
{
$source = $url;
}
return $source;
}
/**
* Ensure that name starts and ends with slash
* @param string $name
* @return string
*/
private static function normalize($name)
{
return sprintf('\\%s\\', trim($name, '\\'));
}
}
API documentation generated by ApiGen