Class: PHP_UML_Output_HtmlNew_DocClassifier

Source Location: /PHP_UML-1.6.2/UML/Output/HtmlNew/DocClassifier.php

Class Overview

PHP_UML_Output_ApiRenderer
   |
   --PHP_UML_Output_HtmlNew_DocElement
      |
      --PHP_UML_Output_HtmlNew_DocClassifier

Implementation of the HTML renderer for a classifier (class, interface, datatype)

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Methods

Child classes:

PHP_UML_Output_HtmlNew_DocClass: Implementation of the class renderer

PHP_UML_Output_HtmlNew_DocInterface: Implementation of the class renderer

PHP_UML_Output_HtmlNew_DocDatatype: Implementation of the datatype renderer

Inherited Variables

Class: PHP_UML_Output_ApiRenderer

PHP_UML_Output_ApiRenderer::$exporter
PHP_UML_Output_ApiRenderer::$hiddenClasses
PHP_UML_Output_ApiRenderer::$hiddenClassifiers
PHP_UML_Output_ApiRenderer::$hiddenInterfaces
PHP_UML_Output_ApiRenderer::$ignoredTag
PHP_UML_Output_ApiRenderer::$mainTpl

Inherited Methods

Class: PHP_UML_Output_HtmlNew_DocElement

PHP_UML_Output_HtmlNew_DocElement::__construct(): Constructor
PHP_UML_Output_HtmlNew_DocElement::displayUnresolved(): Renders an unresolved type as an HTML span
PHP_UML_Output_HtmlNew_DocElement::getCommonLinks(): Returns the HTML code for the common items of the navigation bar
PHP_UML_Output_HtmlNew_DocElement::getDefaultValue()
PHP_UML_Output_HtmlNew_DocElement::getDescription()
PHP_UML_Output_HtmlNew_DocElement::getFileInfo(): Returns the HTML code for the "File" information tag
PHP_UML_Output_HtmlNew_DocElement::getFunctionBlock(): Renders the block "Function" of a package or a classifier as HTML
PHP_UML_Output_HtmlNew_DocElement::getFunctionStyle()
PHP_UML_Output_HtmlNew_DocElement::getLinkTo(): Renders a HTML hyperlink towards a given element (since datatypes don't own to a "package", we suppose they are located in the top package)
PHP_UML_Output_HtmlNew_DocElement::getNavigParentPackage(): Returns the HTML for the link "Package" in the navigation bar
PHP_UML_Output_HtmlNew_DocElement::getParameterList(): Renders the operation's parameters, as a comma-sep list, between brackets
PHP_UML_Output_HtmlNew_DocElement::getPropertyBlock(): Renders the block "Properties" of a package or a class as HTML
PHP_UML_Output_HtmlNew_DocElement::getPropertyStyle()
PHP_UML_Output_HtmlNew_DocElement::getTagsAsList(): Renders the properties of a given stereotype as an HTML list (LI tags).
PHP_UML_Output_HtmlNew_DocElement::getTemplateDirectory()
PHP_UML_Output_HtmlNew_DocElement::replaceInTpl(): Replace the template's placeholders with their value
PHP_UML_Output_HtmlNew_DocElement::save()

Class: PHP_UML_Output_ApiRenderer

PHP_UML_Output_ApiRenderer::__construct(): Constructor for an ApiRenderer.
PHP_UML_Output_ApiRenderer::displayUnresolved(): Renders an unresolved type
PHP_UML_Output_ApiRenderer::generateFunctionId(): Returns an ID to identify a function
PHP_UML_Output_ApiRenderer::generatePropertyId(): Returns an ID for a property
PHP_UML_Output_ApiRenderer::getAbsPath(): Returns the path from the top package to a given package
PHP_UML_Output_ApiRenderer::getAllImplemented(): Returns the array containing all the interfaces of a classifier
PHP_UML_Output_ApiRenderer::getAllImplementing(): Returns the array containing all the classes that implement a given interface
PHP_UML_Output_ApiRenderer::getAllInherited(): Returns the array containing all the extended classes of a classifier This array must have been previously set in the Context object
PHP_UML_Output_ApiRenderer::getAllInheriting(): Returns the array containing all the classes that extends a classifier
PHP_UML_Output_ApiRenderer::getContextPackage(): Return the current ApiContextPackage object
PHP_UML_Output_ApiRenderer::getDefaultValue(): Renders a default value
PHP_UML_Output_ApiRenderer::getDescription()
PHP_UML_Output_ApiRenderer::getFileInfo(): Renders the "File" information tag
PHP_UML_Output_ApiRenderer::getFunctionBlock(): Renders the block "Function" of a package or a classifier
PHP_UML_Output_ApiRenderer::getObjPrefix()
PHP_UML_Output_ApiRenderer::getObjStyle()
PHP_UML_Output_ApiRenderer::getParameterList(): Renders the operation's parameters
PHP_UML_Output_ApiRenderer::getPropertyBlock(): Renders the block "Properties" of a package or a class
PHP_UML_Output_ApiRenderer::getQualifiedName(): Returns the complete namespace for an element
PHP_UML_Output_ApiRenderer::getReturnParam(): Returns the return parameter of a function
PHP_UML_Output_ApiRenderer::getTagsAsList(): Renders the properties of a given stereotype
PHP_UML_Output_ApiRenderer::getTemplate(): Returns the content of a template file
PHP_UML_Output_ApiRenderer::render(): Render globally a package
PHP_UML_Output_ApiRenderer::replaceInTpl(): Replace the template's placeholders with their value
PHP_UML_Output_ApiRenderer::save(): Saves a string in a file (in the folder referenced in the context object)

Class Details

[line 26]
Implementation of the HTML renderer for a classifier (class, interface, datatype)

Author: Baptiste Autin <ohlesbeauxjours@yahoo.fr>
Abstract:
License: LGPL License 3

[ Top ]

Method Detail

getCurrentElement [line 56]

PHP_UML_Metamodel_Classifier getCurrentElement(
int
$i)

Return the current object

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getCurrentElement()

PHP_UML_Output_HtmlNew_DocInterface::getCurrentElement()

PHP_UML_Output_HtmlNew_DocDatatype::getCurrentElement()

Parameters:

int $i — Current index in all the elements of the package

[ Top ]

getNextElement [line 65]

PHP_UML_Metamodel_Classifier getNextElement(
int
$i)

Return the next object

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getNextElement()

PHP_UML_Output_HtmlNew_DocInterface::getNextElement()

PHP_UML_Output_HtmlNew_DocDatatype::getNextElement()

Parameters:

int $i — Current index in all the elements of the package

[ Top ]

getPrefix [line 47]

string getPrefix(
)

Return the prefix (filename scheme)

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getPrefix()

PHP_UML_Output_HtmlNew_DocInterface::getPrefix()

PHP_UML_Output_HtmlNew_DocDatatype::getPrefix()

[ Top ]

getPreviousElement [line 74]

PHP_UML_Metamodel_Classifier getPreviousElement(
int
$i)

Return the previous object

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getPreviousElement()

PHP_UML_Output_HtmlNew_DocInterface::getPreviousElement()

PHP_UML_Output_HtmlNew_DocDatatype::getPreviousElement()

Parameters:

int $i — Previous index in all the elements of the package

[ Top ]

getStyleName [line 40]

string getStyleName(
)

Return the CSS style name of the classifier

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getStyleName()

PHP_UML_Output_HtmlNew_DocInterface::getStyleName()

PHP_UML_Output_HtmlNew_DocDatatype::getStyleName()

[ Top ]

getTypeName [line 33]

string getTypeName(
)

Return the type name of the classifier

Abstract:
Access: protected

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocClass::getTypeName()

PHP_UML_Output_HtmlNew_DocInterface::getTypeName()

PHP_UML_Output_HtmlNew_DocDatatype::getTypeName()

[ Top ]

render [line 81]

void render(
int
$i)

Generates and saves the HTML code for a classifier

Access: public

Overrides PHP_UML_Output_ApiRenderer::render() (Render globally a package)

Parameters:

int $i — Index of the element (to be found in the Context object)

[ Top ]