phpDocumentor
PHP Version 5.3
FunctionDescriptor | Generates a relative URL with functions for use in the generated HTML documentation. |
<?php
/**
* phpDocumentor
*
* PHP Version 5.3
*
* @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Transformer\Router\UrlGenerator\Standard;
use phpDocumentor\Descriptor;
use phpDocumentor\Transformer\Router\UrlGenerator\UrlGeneratorInterface;
/**
* Generates a relative URL with functions for use in the generated HTML documentation..
*/
class FunctionDescriptor implements UrlGeneratorInterface
{
/**
* Generates a URL from the given node or returns false if unable.
*
* @param string|Descriptor\FunctionDescriptor $node
*
* @return string|false
*/
public function __invoke($node)
{
$converter = new QualifiedNameToUrlConverter();
return '/namespaces/' . $converter->fromNamespace($node->getNamespace()) . '.html#function_' . $node->getName();
}
}