Completed
Push — develop ( 48a3ec...fa4cb4 )
by Mike
05:54
created

UrlGenerator/Standard/FunctionDescriptor.php (1 issue)

Labels
Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * This file is part of phpDocumentor.
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 *
10
 * @author    Mike van Riel <[email protected]>
11
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
12
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
13
 * @link      http://phpdoc.org
14
 */
15
16
namespace phpDocumentor\Transformer\Router\UrlGenerator\Standard;
17
18
use phpDocumentor\Descriptor;
19
use phpDocumentor\Transformer\Router\UrlGenerator\UrlGeneratorInterface;
20
21
/**
22
 * Generates a relative URL with functions for use in the generated HTML documentation..
23
 */
24
class FunctionDescriptor implements UrlGeneratorInterface
25
{
26
    /**
27
     * Generates a URL from the given node or returns false if unable.
28
     *
29
     * @param string|Descriptor\FunctionDescriptor $node
30
     *
31
     * @return string|false
32
     */
33 2
    public function __invoke($node)
34
    {
35 2
        $converter = new QualifiedNameToUrlConverter();
36
37 2
        return '/namespaces/' . $converter->fromNamespace($node->getNamespace()) . '.html#function_' . $node->getName();
0 ignored issues
show
It seems like $node is not always an object, but can also be of type string. Maybe add an additional type check?

If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe:

function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
Loading history...
38
    }
39
}
40