PDFGate's PHP SDK

SiteBuilder
in package

FinalYes

Table of Contents

Properties

$markdown  : Parsedown

Methods

__construct()  : mixed
build()  : void
buildNavigation()  : array<int, array{label: string, outputPath: string}>
clearOutputDirectory()  : void
discoverDocuments()  : array<int, string>
ensureDirectory()  : void
extractTitle()  : string
isExternalLink()  : bool
normalizePath()  : string
outputPathForDocument()  : string
outputPathForNavigationDestination()  : string
relativeHref()  : string
removePath()  : void
renderDocument()  : string
rewriteMarkdownLinks()  : string

Properties

Methods

__construct()

public __construct([Parsedown|null $markdown = null ]) : mixed
Parameters
$markdown : Parsedown|null = null

build()

public build(string $docsDirectory, string $outputDirectory) : void
Parameters
$docsDirectory : string
$outputDirectory : string

buildNavigation()

private buildNavigation(string $indexContents, string $indexPath, string $docsDirectory, string $outputDirectory) : array<int, array{label: string, outputPath: string}>
Parameters
$indexContents : string
$indexPath : string
$docsDirectory : string
$outputDirectory : string
Return values
array<int, array{label: string, outputPath: string}>

clearOutputDirectory()

private clearOutputDirectory(string $outputDirectory, array<int, string> $preservedEntries) : void
Parameters
$outputDirectory : string
$preservedEntries : array<int, string>

discoverDocuments()

private discoverDocuments(string $docsDirectory) : array<int, string>
Parameters
$docsDirectory : string
Return values
array<int, string>

ensureDirectory()

private ensureDirectory(string $path) : void
Parameters
$path : string

extractTitle()

private extractTitle(string $markdown, string $sourcePath) : string
Parameters
$markdown : string
$sourcePath : string
Return values
string

isExternalLink()

private isExternalLink(string $destination) : bool
Parameters
$destination : string
Return values
bool

normalizePath()

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

outputPathForDocument()

private outputPathForDocument(string $sourcePath, string $docsDirectory, string $outputDirectory) : string
Parameters
$sourcePath : string
$docsDirectory : string
$outputDirectory : string
Return values
string

outputPathForNavigationDestination()

private outputPathForNavigationDestination(string $destination, string $indexPath, string $docsDirectory, string $outputDirectory) : string
Parameters
$destination : string
$indexPath : string
$docsDirectory : string
$outputDirectory : string
Return values
string

relativeHref()

private relativeHref(string $fromDirectory, string $toPath) : string
Parameters
$fromDirectory : string
$toPath : string
Return values
string

removePath()

private removePath(string $path) : void
Parameters
$path : string

renderDocument()

private renderDocument(string $documentTitle, string $markdown, string $outputPath, array<int, array{label: string, outputPath: string}> $navigation, string $outputDirectory) : string
Parameters
$documentTitle : string
$markdown : string
$outputPath : string
$navigation : array<int, array{label: string, outputPath: string}>
$outputDirectory : string
Return values
string

rewriteMarkdownLinks()

private rewriteMarkdownLinks(string $markdown, string $sourcePath, string $docsDirectory, string $outputDirectory) : string
Parameters
$markdown : string
$sourcePath : string
$docsDirectory : string
$outputDirectory : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results