PHP_UML
[ class tree: PHP_UML ] [ index: PHP_UML ] [ all elements ]

Class: PHP_UML_Output_ApiRenderer

Source Location: /PHP_UML-1.6.2/UML/Output/ApiRenderer.php

Class Overview


Top class for the API "renderers" used by the ExporterAPI implementations


Author(s):

Variables

Methods


Child classes:

PHP_UML_Output_HtmlNew_DocElement
General class for an renderer in the HtmlNew implementation
PHP_UML_Output_Php_DocElement
General class for an renderer in the PHP implementation

Inherited Variables

Inherited Methods


Class Details

[line 25]
Top class for the API "renderers" used by the ExporterAPI implementations


[ Top ]


Class Variables

$exporter =

[line 75]

Reference to the Exporter object (giving access to the ApiContextPackage)
  • Access: protected



[ Top ]

$hiddenClasses = array()

[line 51]

Classes that won't appear directly in the main API lists

for readability (even though each one has its own detail page)

  • Access: protected

Type:   array


[ Top ]

$hiddenClassifiers = array()

[line 63]

Hidden classifiers
  • Access: protected

Type:   array


[ Top ]

$hiddenInterfaces = array()

[line 57]

Hidden interfaces
  • Access: protected

Type:   array


[ Top ]

$ignoredTag = array()

[line 69]

These docblocks will not be displayed in the docblocks list
  • Access: protected

Type:   array


[ Top ]

$mainTpl =

[line 44]

Main template (we pre-store it to avoid reading repeatedly)
  • Access: protected

Type:   string


[ Top ]



Method Detail

__construct (Constructor)   [line 89]

PHP_UML_Output_ApiRenderer __construct( PHP_UML_Output_ExporterAPI $exporter)

Constructor for an ApiRenderer.
  • Access: public

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::__construct()
Constructor
PHP_UML_Output_Php_DocElement::__construct()
Constructor

Parameters:

PHP_UML_Output_ExporterAPI   $exporter   —  Reference to an exporter

[ Top ]

displayUnresolved   [line 207]

string displayUnresolved( string $type)

Renders an unresolved type
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::displayUnresolved()
Renders an unresolved type as an HTML span
PHP_UML_Output_Php_DocElement::displayUnresolved()
Renders an unresolved type as an HTML span

Parameters:

string   $type   —  Type, provided as a string

[ Top ]

generateFunctionId   [line 337]

string generateFunctionId( PHP_UML_Metamodel_Operation $o)

Returns an ID to identify a function
  • Access: protected

Parameters:

PHP_UML_Metamodel_Operation   $o   —  Element

[ Top ]

generatePropertyId   [line 325]

string generatePropertyId( PHP_UML_Metamodel_Property $o)

Returns an ID for a property
  • Access: protected

Parameters:

PHP_UML_Metamodel_Property   $o   —  Element

[ Top ]

getAbsPath   [line 217]

string getAbsPath( PHP_UML_Metamodel_Package $p, [string $delimiter = '/'])

Returns the path from the top package to a given package
  • Access: protected

Parameters:

PHP_UML_Metamodel_Package   $p   —  The package
string   $delimiter   —  Delimiter

[ Top ]

getAllImplemented   [line 284]

array getAllImplemented( PHP_UML_Metamodel_NamedElement $c)

Returns the array containing all the interfaces of a classifier
  • Access: protected

Parameters:

PHP_UML_Metamodel_NamedElement   $c   —  A classifier or a package

[ Top ]

getAllImplementing   [line 296]

array getAllImplementing( PHP_UML_Metamodel_NamedElement $c)

Returns the array containing all the classes that implement a given interface
  • Access: protected

Parameters:

PHP_UML_Metamodel_NamedElement   $c   —  A classifier or a package

[ Top ]

getAllInherited   [line 260]

array getAllInherited( PHP_UML_Metamodel_NamedElement $c)

Returns the array containing all the extended classes of a classifier This array must have been previously set in the Context object
  • Access: protected

Parameters:

PHP_UML_Metamodel_NamedElement   $c   —  A classifier or a package

[ Top ]

getAllInheriting   [line 272]

array getAllInheriting( PHP_UML_Metamodel_NamedElement $c)

Returns the array containing all the classes that extends a classifier
  • Access: protected

Parameters:

PHP_UML_Metamodel_NamedElement   $c   —  A classifier or a package

[ Top ]

getContextPackage   [line 140]

PHP_UML_Output_ApiContextPackage getContextPackage( )

Return the current ApiContextPackage object
  • Access: protected

[ Top ]

getDefaultValue   [line 120]

string getDefaultValue( PHP_UML_Metamodel_TypedElement $obj)

Renders a default value
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getDefaultValue()
PHP_UML_Output_Php_DocElement::getDefaultValue()

Parameters:

PHP_UML_Metamodel_TypedElement   $obj   —  A property or a parameter

[ Top ]

getDescription   [line 100]

void getDescription( PHP_UML_Metamodel_Stereotype $s, [ $annotatedElement = ''])

  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getDescription()
PHP_UML_Output_Php_DocElement::getDescription()

Parameters:

PHP_UML_Metamodel_Stereotype   $s   — 
   $annotatedElement   — 

[ Top ]

getFileInfo   [line 359]

string getFileInfo( PHP_UML_Metamodel_NamedElement $p)

Renders the "File" information tag
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getFileInfo()
Returns the HTML code for the "File" information tag
PHP_UML_Output_Php_DocElement::getFileInfo()
Returns the HTML code for the "File" information tag

Parameters:

PHP_UML_Metamodel_NamedElement   $p   —  An element

[ Top ]

getFunctionBlock   [line 349]

string getFunctionBlock( PHP_UML_Metamodel_NamedElement $p)

Renders the block "Function" of a package or a classifier
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getFunctionBlock()
Renders the block "Function" of a package or a classifier as HTML
PHP_UML_Output_Php_DocElement::getFunctionBlock()
Renders the block "Function" of a package or a classifier as HTML

Parameters:

PHP_UML_Metamodel_NamedElement   $p   —  A classifier or a package

[ Top ]

getObjPrefix   [line 145]

void getObjPrefix( PHP_UML_Metamodel_NamedElement $x)

  • Access: protected

Parameters:


[ Top ]

getObjStyle   [line 160]

void getObjStyle( PHP_UML_Metamodel_NamedElement $x)

  • Access: protected

Parameters:


[ Top ]

getParameterList   [line 110]

string getParameterList( PHP_UML_Metamodel_Operation $operation, [bool $withType = false])

Renders the operation's parameters
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getParameterList()
Renders the operation's parameters, as a comma-sep list, between brackets
PHP_UML_Output_Php_DocElement::getParameterList()
Renders the operation's parameters, as a comma-sep list, between brackets

Parameters:

PHP_UML_Metamodel_Operation   $operation   —  The operation
bool   $withType   —  If true, adds an hyperlink

[ Top ]

getPropertyBlock   [line 316]

string getPropertyBlock( PHP_UML_Metamodel_NamedElement $p)

Renders the block "Properties" of a package or a class
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getPropertyBlock()
Renders the block "Properties" of a package or a class as HTML
PHP_UML_Output_Php_DocElement::getPropertyBlock()
Renders the block "Properties" of a package or a class as HTML

Parameters:

PHP_UML_Metamodel_NamedElement   $p   —  A classifier/a package

[ Top ]

getQualifiedName   [line 194]

string getQualifiedName( PHP_UML_Metamodel_Classifier $t)

Returns the complete namespace for an element
  • Access: protected

Parameters:

PHP_UML_Metamodel_Classifier   $t   —  The classifier

[ Top ]

getReturnParam   [line 233]

PHP_UML_Metamodel_Parameter getReturnParam( PHP_UML_Metamodel_Operation $operation)

Returns the return parameter of a function
  • Return: The parameter
  • Access: protected

Parameters:

PHP_UML_Metamodel_Operation   $operation   —  The function

[ Top ]

getTagsAsList   [line 250]

string getTagsAsList( PHP_UML_Metamodel_Stereotype $s)

Renders the properties of a given stereotype
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::getTagsAsList()
Renders the properties of a given stereotype as an HTML list (LI tags).
PHP_UML_Output_Php_DocElement::getTagsAsList()

Parameters:

PHP_UML_Metamodel_Stereotype   $s   —  A stereotype

[ Top ]

getTemplate   [line 129]

string getTemplate( string $str)

Returns the content of a template file
  • Return: The content of the template
  • Access: protected

Parameters:

string   $str   —  Template filename

[ Top ]

render   [line 82]

void render( PHP_UML_Metamodel_Package $p)

Render globally a package
  • Abstract:

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocMenu::render()
Generates and saves the HTML menu
PHP_UML_Output_HtmlNew_DocIndex::render()
Generates and saves the HTML code for the Index page
PHP_UML_Output_HtmlNew_DocResources::render()
PHP_UML_Output_HtmlNew_DocClassifier::render()
Generates and saves the HTML code for a classifier
PHP_UML_Output_HtmlNew_DocPackage::render()
Generates and saves the HTML code for a package
PHP_UML_Output_Php_DocClassifier::render()
Generates and saves the HTML code for a classifier

Parameters:

PHP_UML_Metamodel_Package   $p   —  Starting package (model)

[ Top ]

replaceInTpl   [line 371]

string replaceInTpl( string $main, string $nav, string $tit, string $name)

Replace the template's placeholders with their value
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::replaceInTpl()
Replace the template's placeholders with their value
PHP_UML_Output_Php_DocElement::replaceInTpl()
Replace the template's placeholders with their value

Parameters:

string   $main   —  Main content (generated by PHP_UML)
string   $nav   —  Navigation content (navig bar)
string   $tit   —  Title content
string   $name   —  Element name

[ Top ]

save   [line 307]

void save( string $elementName, string $str)

Saves a string in a file (in the folder referenced in the context object)
  • Abstract:
  • Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocElement::save()
PHP_UML_Output_Php_DocElement::save()

Parameters:

string   $elementName   —  Filename (without the extension)
string   $str   —  Content

[ Top ]


Documentation generated on Mon, 11 Mar 2019 16:01:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.