Contentserv PHP API

CSGuiApiDocumentation
in package

Tags

Table of Contents

ACCESS_PUBLIC  = 'public'
STATUS_API  = 'api'
STATUS_BETA  = 'beta'
STATUS_INTERNAL  = 'internal'
STATUS_STABLE  = 'stable'
addCSSLink()  : void
Adds a cascading style sheet link for this documentation
addMethod()  : CSGuiApiDocumentationMethod
Adds a API method
addSection()  : CSGuiApiDocumentationSection
Adds a section to the API
getMethods()  : array<string|int, mixed>
Returns the defined methods
getStatus()  : string
Gets the status of the API Documentation
getVersion()  : int
Returns the API version number.
getWindowTitle()  : string
Returns the window title - if not set the standard title will be returned
isApi()  : bool
Returns true if the Api has a status tag api
isBeta()  : bool
Returns true if the Api has a status tag beta
isInternal()  : bool
Returns true if the Api has a status tag internal or even no status tag at all
isStable()  : bool
Returns true if the Api has a status tag stable
makeBeginHtml()  : string
Generates the inital output of the HTML output including the title
makeEndHtml()  : string
Generates the final output of the HTML output
makeFooterHtml()  : string
Generates the HTML output for the footer of the API typically used for copyrights, etc.
makeHtml()  : string
Generates the output
makeMethodsDetailsHtml()  : string
Generates the HTML output for the API methods details section
makeMethodsHtml()  : string
Generates the HTML output for the API methods
makeMethodsSummaryHtml()  : string
Generates the HTML output for the API methods summary section
makeSectionHtml()  : string
Generates the HTML output for one section
setAccess()  : void
Sets the access of the API Documentation
setAuthor()  : void
Sets the author of the API Documentation
setCopyright()  : void
Sets the Copyright of the API Documentation
setCSS()  : void
Sets an additional css source in the header
setCSSLink()  : void
Sets the cascading style sheet link for this documentation
setDeprecation()  : void
Sets the Api Documentation deprecated
setDescription()  : void
Sets the Description of the API Documentation
setDocumentation()  : void
Sets the documentation link of the API Documentation
setFooter()  : void
Sets the footer text of the of the API Documentation
setSince()  : void
Sets the since tag of the API Documentation
setStatus()  : void
Sets the status of the API Documentation
setTitle()  : void
Sets the top headline of the API Documentation
setVersion()  : void
Sets the API version number.
setWindowTitle()  : void
Sets the window title through the HTML title tag

Constants

Methods

addCSSLink()

Adds a cascading style sheet link for this documentation

public addCSSLink(mixed $cssLink) : void
Parameters
$cssLink : mixed

string relative or absolute URL as it should appear in the browsers stylesheet href link

Tags
Return values
void —

addMethod()

Adds a API method

public addMethod(string $title[, string $description = '' ][, string $access = '' ][, string $deprecation = '' ]) : CSGuiApiDocumentationMethod
Parameters
$title : string

the title of the method

$description : string = ''

the description of the method

$access : string = ''

the access of the method

$deprecation : string = ''

if set with a deprecation warning the method will be marked as deprecated

Tags
access

public

Return values
CSGuiApiDocumentationMethod —

a method object, that can be used to add params, etc.

getMethods()

Returns the defined methods

public getMethods() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

the methods as CSGuiApiDocumentationMethod objects

getStatus()

Gets the status of the API Documentation

public getStatus() : string
Tags
access

public

Return values
string —

the status, e.g. CSGuiApiDocumentation::STATUS_BETA or CSGuiApiDocumentation::STATUS_STABLE

getVersion()

Returns the API version number.

public getVersion() : int
Tags
access

public

Return values
int —

The API version number

getWindowTitle()

Returns the window title - if not set the standard title will be returned

public getWindowTitle() : string
Tags
access

public

Return values
string —

the window title

isApi()

Returns true if the Api has a status tag api

public isApi() : bool
Tags
Return values
bool —

true if is api

isBeta()

Returns true if the Api has a status tag beta

public isBeta() : bool
Tags
Return values
bool —

true if in beta

isInternal()

Returns true if the Api has a status tag internal or even no status tag at all

public isInternal() : bool
Tags
Return values
bool —

true if is internal or empty

isStable()

Returns true if the Api has a status tag stable

public isStable() : bool
Tags
Return values
bool —

true if stable

makeBeginHtml()

Generates the inital output of the HTML output including the title

public makeBeginHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeEndHtml()

Generates the final output of the HTML output

public makeEndHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeFooterHtml()

Generates the HTML output for the footer of the API typically used for copyrights, etc.

public makeFooterHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeHtml()

Generates the output

public makeHtml() : string
Tags
access

public

Return values
string —

the html of the API Documentation

makeMethodsDetailsHtml()

Generates the HTML output for the API methods details section

public makeMethodsDetailsHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeMethodsHtml()

Generates the HTML output for the API methods

public makeMethodsHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeMethodsSummaryHtml()

Generates the HTML output for the API methods summary section

public makeMethodsSummaryHtml() : string
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

makeSectionHtml()

Generates the HTML output for one section

public makeSectionHtml(mixed $section) : string
Parameters
$section : mixed
Tags
access

public

Return values
string —

the corresponding html part of the API Documentation

setAccess()

Sets the access of the API Documentation

public setAccess(string $access) : void
Parameters
$access : string

the access tag of the API Documentation

Tags
access

public

Return values
void —

setAuthor()

Sets the author of the API Documentation

public setAuthor(string $author) : void
Parameters
$author : string

the author of the API Documentation

Tags
access

public

Return values
void —

setCopyright()

Sets the Copyright of the API Documentation

public setCopyright(string $copyright) : void
Parameters
$copyright : string

the copyright of the API Documentation

Tags
access

public

Return values
void —

setCSS()

Sets an additional css source in the header

public setCSS(mixed $css) : void
Parameters
$css : mixed

string cascading style sheet source

Tags
Return values
void —

setCSSLink()

Sets the cascading style sheet link for this documentation

public setCSSLink(mixed $cssLink) : void
Parameters
$cssLink : mixed

string relative or absolute URL as it should appear in the browsers stylesheet href link

Tags
Return values
void —

setDeprecation()

Sets the Api Documentation deprecated

public setDeprecation(string $note) : void
Parameters
$note : string

the deprecation note of the API Documentation

Tags
access

public

Return values
void —

setDescription()

Sets the Description of the API Documentation

public setDescription(string $description) : void
Parameters
$description : string

the Description of the API Documentation

Tags
access

public

Return values
void —

setDocumentation()

Sets the documentation link of the API Documentation

public setDocumentation(string $link) : void
Parameters
$link : string

the link to the documentation of the API Documentation

Tags
access

public

Return values
void —

setFooter()

Sets the footer text of the of the API Documentation

public setFooter(string $text) : void
Parameters
$text : string

the footer text

Tags
access

public

Return values
void —

setSince()

Sets the since tag of the API Documentation

public setSince(string $since) : void
Parameters
$since : string

the since tag of the API Documentation

Tags
access

public

Return values
void —

setStatus()

Sets the status of the API Documentation

public setStatus(string $status) : void
Parameters
$status : string

the status tag of the API Documentation as a CSGuiApiDocumentation::STATUS_ constant

Tags
access

public

Return values
void —

setTitle()

Sets the top headline of the API Documentation

public setTitle(mixed $title) : void
Parameters
$title : mixed
Tags
access

public

Return values
void —

setVersion()

Sets the API version number.

public setVersion(int $iVersion) : void
Parameters
$iVersion : int

The API version number.

Tags
access

public

Return values
void —

setWindowTitle()

Sets the window title through the HTML title tag

public setWindowTitle(string $windowTitle) : void
Parameters
$windowTitle : string

the window title

Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results