[ ] [ ] [ ]

Packages:
PHP_UML

Classes:

Output
   PHP_UML_Output_ApiContextPackage
   PHP_UML_Output_ApiRenderer
   PHP_UML_Output_Eclipse_AbstractBuilder
   PHP_UML_Output_Eclipse_BuilderImpl2
   PHP_UML_Output_Eclipse_Exporter
   PHP_UML_Output_Exporter
   PHP_UML_Output_ExporterAPI
   PHP_UML_Output_ExporterXSL
   PHP_UML_Output_HtmlNew_DocClass
   PHP_UML_Output_HtmlNew_DocClassifier
   PHP_UML_Output_HtmlNew_DocDatatype
   PHP_UML_Output_HtmlNew_DocElement
   PHP_UML_Output_HtmlNew_DocIndex
   PHP_UML_Output_HtmlNew_DocInterface
   PHP_UML_Output_HtmlNew_DocMenu
   PHP_UML_Output_HtmlNew_DocPackage
   PHP_UML_Output_HtmlNew_DocResources
   PHP_UML_Output_HtmlNew_Exporter
   PHP_UML_Output_Html_Exporter
   PHP_UML_Output_Php_DocClass
   PHP_UML_Output_Php_DocClassifier
   PHP_UML_Output_Php_DocElement
   PHP_UML_Output_Php_DocInterface
   PHP_UML_Output_Php_Exporter
   PHP_UML_Output_XmiDocument
   PHP_UML_Output_Xmi_AbstractBuilder
   PHP_UML_Output_Xmi_BuilderImpl1
   PHP_UML_Output_Xmi_BuilderImpl2
   PHP_UML_Output_Xmi_Exporter

PHP_UML
PHP_UML_Metamodel_Artifact
PHP_UML_Metamodel_Class

Input
   PHP_UML_Input_ImporterFileScanner
   PHP_UML_Input_PHP_FileScanner
   PHP_UML_Input_PHP_Parser
   PHP_UML_Input_PHP_ParserImpl
   PHP_UML_Input_PHP_ParserOptions
   PHP_UML_Input_XMI_Builder
   PHP_UML_Input_XMI_FileScanner

Metamodel
   PHP_UML_Metamodel_Classifier
   PHP_UML_Metamodel_Datatype
   PHP_UML_Metamodel_Helper
   PHP_UML_Metamodel_Interface
   PHP_UML_Metamodel_NamedElement
   PHP_UML_Metamodel_Operation
   PHP_UML_Metamodel_Package
   PHP_UML_Metamodel_Parameter
   PHP_UML_Metamodel_Property
   PHP_UML_Metamodel_Stereotype
   PHP_UML_Metamodel_Superstructure
   PHP_UML_Metamodel_Tag
   PHP_UML_Metamodel_Type
   PHP_UML_Metamodel_TypedElement
   PHP_UML_Metamodel_TypeResolver
   PHP_UML_Metamodel_TypeResolverById
   PHP_UML_Metamodel_TypeResolverByName

PHP_UML
PHP_UML_Exception
PHP_UML_FilePatternFilterIterator
PHP_UML_FileScanner
PHP_UML_SimpleUID
PHP_UML_Warning

Files:

Exception.php
FilePatternFilterIterator.php
FileScanner.php
main.php
SimpleUID.php
test_to_run.php
UML.php
Warning.php

subpackage Input

Builder.php
FileScanner.php
FileScanner.php
Importer.php
ImporterFileScanner.php
Parser.php
ParserImpl.php
ParserOptions.php

subpackage Metamodel

subpackage Output

Class: PHP_UML_Output_HtmlNew_DocMenu

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

Class Overview

PHP_UML_Output_ApiRenderer
   |
   --PHP_UML_Output_HtmlNew_DocElement
      |
      --PHP_UML_Output_HtmlNew_DocMenu

Implementation of the HTML renderer for the treeview menu (on the left panel)

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Methods

Child classes:

PHP_UML_Output_HtmlNew_DocIndex: Implementation of the HTML renderer for the Index page

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 the treeview menu (on the left panel)

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

[ Top ]

Method Detail

getClassifierItem [line 112]

void getClassifierItem(
PHP_UML_Metamodel_Classifier
$c, 
$path, 
$level)

Access: protected

Parameters:

PHP_UML_Metamodel_Classifier	`$c`	—
	`$path`	—
	`$level`	—

[ Top ]

getPackageOperationItem [line 104]

void getPackageOperationItem(
PHP_UML_Metamodel_Operation
$o, 
$path)

Access: protected

Parameters:

PHP_UML_Metamodel_Operation	`$o`	—
	`$path`	—

[ Top ]

getPackagePropertyItem [line 96]

void getPackagePropertyItem(
PHP_UML_Metamodel_Property
$p, 
$path)

Access: protected

Parameters:

PHP_UML_Metamodel_Property	`$p`	—
	`$path`	—

[ Top ]

render [line 33]

void render(
PHP_UML_Metamodel_Package
$p)

Generates and saves the HTML menu

Access: public

Overridden in child classes as:

PHP_UML_Output_HtmlNew_DocIndex::render(): Generates and saves the HTML code for the Index page

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

Parameters:

PHP_UML_Metamodel_Package $p — Starting package

[ Top ]

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