Class: PHP_UML_Output_Php_DocElement

Source Location: /PHP_UML-1.6.2/UML/Output/Php/DocElement.php

Class Overview

PHP_UML_Output_ApiRenderer
   |
   --PHP_UML_Output_Php_DocElement

General class for an renderer in the PHP implementation

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Methods

Child classes:

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

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_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]
General class for an renderer in the PHP implementation

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

[ Top ]

Method Detail

__construct (Constructor) [line 36]

PHP_UML_Output_Php_DocElement __construct(
PHP_UML_Output_ExporterAPI
$exporter)

Constructor

Access: public

Overrides PHP_UML_Output_ApiRenderer::__construct() (Constructor for an ApiRenderer.)

Parameters:

PHP_UML_Output_ExporterAPI $exporter — Reference to an exporter

[ Top ]

displayUnresolved [line 124]

string displayUnresolved(
string
$type)

Renders an unresolved type as an HTML span

Access: protected

Overrides PHP_UML_Output_ApiRenderer::displayUnresolved() (Renders an unresolved type)

Parameters:

string $type — Type, provided as a string

[ Top ]

getDefaultValue [line 87]

void getDefaultValue(
PHP_UML_Metamodel_TypedElement
$obj)

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getDefaultValue() (Renders a default value)

Parameters:

PHP_UML_Metamodel_TypedElement $obj —

[ Top ]

getDescription [line 42]

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

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getDescription() (parent method not documented)

Parameters:

PHP_UML_Metamodel_Stereotype	`$s`	—
	`$annotatedElement`	—

[ Top ]

getDocblocks [line 144]

string getDocblocks(
PHP_UML_Metamodel_Stereotype
$s, [int
$nbSpacer = 0])

Renders the properties of a given stereotype.

Docblocks in $ignoredTag are not shown.

Access: protected

Parameters:

PHP_UML_Metamodel_Stereotype	`$s`	—	A stereotype
int	`$nbSpacer`	—	Number of spacers to add

[ Top ]

getFileInfo [line 318]

string getFileInfo(
PHP_UML_Metamodel_NamedElement
$p)

Returns the HTML code for the "File" information tag

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getFileInfo() (Renders the "File" information tag)

Parameters:

PHP_UML_Metamodel_NamedElement $p — An element

[ Top ]

getFunctionBlock [line 270]

string getFunctionBlock(
PHP_UML_Metamodel_NamedElement
$p)

Renders the block "Function" of a package or a classifier as HTML

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getFunctionBlock() (Renders the block "Function" of a package or a classifier)

Parameters:

PHP_UML_Metamodel_NamedElement $p — A classifier or a package

[ Top ]

getLinkTo [line 105]

string getLinkTo(
PHP_UML_Metamodel_Classifier
$t, [
$hideDatatype = true], string
$cssStyle)

Renders a link towards a given element (since datatypes don't own to a "package", we suppose they are located in the top package)

Access: protected

Parameters:

PHP_UML_Metamodel_Classifier	`$t`	—	The element
string	`$cssStyle`	—	CSS style to use
	`$hideDatatype`	—

[ Top ]

getNl [line 326]

void getNl(
)

Access: protected

[ Top ]

getParameterList [line 59]

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

Renders the operation's parameters, as a comma-sep list, between brackets

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getParameterList() (Renders the operation's parameters)

Parameters:

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

[ Top ]

getPropertyBlock [line 178]

string getPropertyBlock(
PHP_UML_Metamodel_NamedElement
$p)

Renders the block "Properties" of a package or a class as HTML

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getPropertyBlock() (Renders the block "Properties" of a package or a class)

Parameters:

PHP_UML_Metamodel_NamedElement $p — A classifier/a package

[ Top ]

getTagsAsList [line 130]

void getTagsAsList(
PHP_UML_Metamodel_Stereotype
$s)

Access: protected

Overrides PHP_UML_Output_ApiRenderer::getTagsAsList() (Renders the properties of a given stereotype)

Parameters:

PHP_UML_Metamodel_Stereotype $s —

[ Top ]

getTemplateDirectory [line 350]

void getTemplateDirectory(
)

Access: protected

[ Top ]

replaceInTpl [line 341]

string replaceInTpl(
string
$main, string
$header, string
$ns, string
$name)

Replace the template's placeholders with their value

Access: protected

Overrides PHP_UML_Output_ApiRenderer::replaceInTpl() (Replace the template's placeholders with their value)

Parameters:

string	`$main`	—	Main HTML content (generated by PHP_UML)
string	`$header`	—	Navigation HTML content (navig bar)
string	`$ns`	—	Title content
string	`$name`	—	Element name

[ Top ]

save [line 355]

void save(

$elementName, 
$str)

Access: protected

Overrides PHP_UML_Output_ApiRenderer::save() (Saves a string in a file (in the folder referenced in the context object))

Parameters:

	`$elementName`	—
	`$str`	—

[ Top ]