\phpDocumentor\Transformer\Router\UrlGenerator\StandardFileDescriptor

Summary

Methods

Properties

Constants

__invoke()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: phpDocumentor/Transformer/Router/UrlGenerator/Standard/FileDescriptor.php
Package: Default
Class hierarchy: \phpDocumentor\Transformer\Router\UrlGenerator\Standard\FileDescriptor
Implements: \phpDocumentor\Transformer\Router\UrlGenerator\UrlGeneratorInterface

Methods

__invoke()

__invoke(string|\phpDocumentor\Descriptor\FileDescriptor  $node) : string|false

Generates a URL from the given node or returns false if unable.

Parameters

string|\phpDocumentor\Descriptor\FileDescriptor

$node

Returns

string|false

<?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;

class FileDescriptor implements UrlGeneratorInterface
{
    /**
     * Generates a URL from the given node or returns false if unable.
     *
     * @param string|Descriptor\FileDescriptor $node
     *
     * @return string|false
     */
    public function __invoke($node)
    {
        $converter = new QualifiedNameToUrlConverter();

        return '/files/' . $converter->fromFile($node->getPath()) .'.html';
    }
}