phpDocumentor

RelativePathToRootConverter
in package

FinalYes

Table of Contents

Properties

$router  : Router

Methods

__construct()  : mixed
convert()  : string|null
Converts the given path to be relative to the root of the documentation target directory.
createFqsenFromReference()  : Fqsen
getPathPrefixBasedOnDepth()  : string
Calculates how deep the given destination is and returns a prefix.
isReferenceToFqsen()  : bool
withoutLeadingSlash()  : string

Properties

Methods

convert()

Converts the given path to be relative to the root of the documentation target directory.

public convert(string $destination, string $pathOrReference) : string|null

It is not possible to use absolute paths in documentation templates since they may be used locally, or in a subfolder. As such we need to calculate the number of levels to go up from the current document's directory and then append the given path.

For example:

Suppose you are in <root>/classes/my/class.html and you want open
<root>/my/index.html then you provide 'my/index.html' to this method
and it will convert it into ../../my/index.html (<root>/classes/my is
two nesting levels until the root).

This method does not try to normalize or optimize the paths in order to save on development time and performance, and because it adds no real value.

In addition, when a path starts with an @-sign, it is interpreted as a reference to a structural element and we use the router to try and find a path to which this refers.

Parameters
$destination : string
$pathOrReference : string
Tags
todo

References can only point to an element that is a class, interface, trait, method, property or class constant at this moment. This is because an FQSEN does not contain the necessary data to distinguish whether the FQCN is actually a class or a namespace reference. As such we assume a class as that is the most common occurrence.

Return values
string|null

createFqsenFromReference()

private createFqsenFromReference(string $path) : Fqsen
Parameters
$path : string
Return values
Fqsen

getPathPrefixBasedOnDepth()

Calculates how deep the given destination is and returns a prefix.

private getPathPrefixBasedOnDepth(string $destination) : string

The calculated prefix is used to get back to the root (i.e. three levels deep means ../../..) or an empty string is returned when you are already at the same level as the root.

This prefix will include a trailing forward slash (/) when it actually needs to direct the caller to go elsewhere.

Parameters
$destination : string
Return values
string

withoutLeadingSlash()

private withoutLeadingSlash(string $path) : string
Parameters
$path : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results