CSGuiApiDocumentationMethod
extends CSGuiApiDocumentationSection
in package
The CSGuiApiDocumentationMethod provides a standardized Method in a CSGuiApiDocumentation
This class has no public constructor, use the factory method instead.
Tags
Table of Contents
- addParam() : string
- Adds a parameter to the method
- addReturnCode() : void
- Adds a HTTP Status Return Code Definition to the method
- addTag() : void
- Adds a tag with a key and a value to the taglist of the section
- getAccess() : string
- Gets the access value of the method, e.g. 'public'
- getDeprecation() : string
- Gets the deprecation message
- getDescription() : string
- Returns the description of the section
- getID() : string
- Returns the ID of the section as a 9-character MD5 Hash of the title
- getNote() : string
- Gets the note of the method
- getParam() : string
- Adds a parameter to the method
- getParams() : array<string|int, mixed>
- Returns the Parameters of this method
- getReturnCodes() : array<string|int, mixed>
- Returns the HTTP Status Codes set for this method
- getReturnDescription() : string
- Gets the return description of the method
- getReturnType() : string
- Gets the return type of the method
- getSince() : string
- Gets the since value of the method
- getStatus() : string
- Gets the status value of the method, e.g.
- getTags() : array<string|int, mixed>
- Returns the tags of the section
- getTitle() : string
- Returns the title of the section
- isApi() : bool
- Returns true if the method has a status tag api
- isBeta() : bool
- Returns true if the method has a status tag beta
- isDeprecated() : string
- Gets whether the method is deprecated
- isInternal() : bool
- Returns true if the method has a status tag internal
- isStable() : bool
- Returns true if the method has a status tag stable
- setAccess() : void
- Sets the access value of the method, e.g 'public'
- setDeprecation() : void
- Sets the access value of the method, e.g 'public'
- setDescription() : void
- Sets the description text between the headline and the tags
- setNote() : void
- Sets a note for the method
- setReturns() : void
- Sets the return value of the method
- setSince() : void
- Sets the since value of the method
- setStatus() : void
- Sets the status value of the method, e.g 'beta', 'stable' or 'api'
- setTitle() : void
- Sets the title text of the section
Methods
addParam()
Adds a parameter to the method
public
addParam(string $name[, string $description = '' ][, string $type = '' ][, string $default = '' ][, mixed $kind = '' ]) : string
Parameters
- $name : string
-
the name of the parameter
- $description : string = ''
-
the description of the parameter
- $type : string = ''
-
the type of the parameter
- $default : string = ''
-
the default of the parameter
- $kind : mixed = ''
Tags
Return values
string —the since documentations of the method
addReturnCode()
Adds a HTTP Status Return Code Definition to the method
public
addReturnCode(mixed $number, mixed $description) : void
Parameters
- $number : mixed
-
the HTTP Status Code like 200
- $description : mixed
-
the Description like "Ok if the Object exits"
Tags
Return values
void —addTag()
Adds a tag with a key and a value to the taglist of the section
public
addTag(string $key, string $val) : void
Parameters
- $key : string
-
the key of the tag
- $val : string
-
the value of the tag
Tags
Return values
void —getAccess()
Gets the access value of the method, e.g. 'public'
public
getAccess() : string
Tags
Return values
string —the access documentations of the method
getDeprecation()
Gets the deprecation message
public
getDeprecation() : string
Tags
Return values
string —the deprecation note of the method
getDescription()
Returns the description of the section
public
getDescription() : string
Tags
Return values
string —the description
getID()
Returns the ID of the section as a 9-character MD5 Hash of the title
public
getID() : string
Tags
Return values
string —the ID
getNote()
Gets the note of the method
public
getNote() : string
Tags
Return values
string —the note of the method
getParam()
Adds a parameter to the method
public
getParam(mixed $name) : string
Parameters
- $name : mixed
Tags
Return values
string —the since documentations of the method
getParams()
Returns the Parameters of this method
public
getParams() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —an array with the parameters of this method with the param name as key and an array with the name, description, type and default
getReturnCodes()
Returns the HTTP Status Codes set for this method
public
getReturnCodes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —with the Return Code Number as Key and Code Description as Value
getReturnDescription()
Gets the return description of the method
public
getReturnDescription() : string
Tags
Return values
string —the return description of the method
getReturnType()
Gets the return type of the method
public
getReturnType() : string
Tags
Return values
string —the return type of the method
getSince()
Gets the since value of the method
public
getSince() : string
Tags
Return values
string —the since documentations of the method
getStatus()
Gets the status value of the method, e.g.
public
getStatus() : string
'beta', 'stable' or 'api'
Tags
Return values
string —the status documentations of the method
getTags()
Returns the tags of the section
public
getTags() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —array with the tags. For each tag one array with a key and with a val is returned
getTitle()
Returns the title of the section
public
getTitle() : string
Tags
Return values
string —the title
isApi()
Returns true if the method has a status tag api
public
isApi() : bool
Tags
Return values
bool —TRUE if in api
isBeta()
Returns true if the method has a status tag beta
public
isBeta() : bool
Tags
Return values
bool —true if in beta
isDeprecated()
Gets whether the method is deprecated
public
isDeprecated() : string
Tags
Return values
string —the deprecation note of the method
isInternal()
Returns true if the method has a status tag internal
public
isInternal() : bool
Tags
Return values
bool —TRUE if is an internal method
isStable()
Returns true if the method has a status tag stable
public
isStable() : bool
Tags
Return values
bool —TRUE if stable
setAccess()
Sets the access value of the method, e.g 'public'
public
setAccess(mixed $access) : void
Parameters
- $access : mixed
Tags
Return values
void —setDeprecation()
Sets the access value of the method, e.g 'public'
public
setDeprecation(string $note) : void
Parameters
- $note : string
-
the deprecation note of the method
Tags
Return values
void —setDescription()
Sets the description text between the headline and the tags
public
setDescription(mixed $description) : void
Parameters
- $description : mixed
Tags
Return values
void —setNote()
Sets a note for the method
public
setNote(string $note) : void
Parameters
- $note : string
-
the note
Tags
Return values
void —setReturns()
Sets the return value of the method
public
setReturns(mixed $type[, mixed $description = '' ]) : void
Parameters
- $type : mixed
- $description : mixed = ''
Tags
Return values
void —setSince()
Sets the since value of the method
public
setSince(string $since) : void
Parameters
- $since : string
-
the since documentation of the method
Tags
Return values
void —setStatus()
Sets the status value of the method, e.g 'beta', 'stable' or 'api'
public
setStatus(mixed $status) : void
Parameters
- $status : mixed
Tags
Return values
void —setTitle()
Sets the title text of the section
public
setTitle(mixed $title) : void
Parameters
- $title : mixed