Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
ClassToYuml Class Reference

yuml export tool for class Ubiquity\utils\yuml$ClassToYuml This class is part of Ubiquity More...

+ Inheritance diagram for ClassToYuml:

Public Member Functions

 __construct ($class, $displayProperties=true, $displayAssociations=true, $displayMethods=false, $displayMethodsParams=false, $displayPropertiesTypes=false, $displayAssociationClassProperties=false)
 
 init ($hasManyToOne, $hasOneToMany, $hasManyToMany)
 
 parse ()
 
 manyToOneTostring ()
 
 oneToManyTostring ()
 
 manyToManyTostring ($load=true)
 
 __toString ()
 
 setDisplayProperties ($displayProperties)
 
 setDisplayMethods ($displayMethods)
 
 setDisplayAssociations ($displayAssociations)
 
- Public Member Functions inherited from ClassToYumlRelationsTrait
 loadManyToManys ()
 
 getExtManyToManys ()
 
 removeManyToManyExt ($targetClass)
 

Protected Member Functions

 parseProperty (&$propertiesArray, $property, $prikeys, $types)
 
 parseMethod (&$methodsArray, $method)
 
 _getNote ()
 
 getMethodParameters (\ReflectionMethod $method)
 
 getAccess ($property)
 
- Protected Member Functions inherited from ClassToYumlRelationsTrait
 loadOneToManys ()
 
 loadManyToOne ()
 
 getShortClassName ($class)
 
 _getYumlRelationsType ($relations, $branche)
 
 _getYumlManyToOne ()
 
 _getYumlOneToMany ()
 
 _getYumlManyToMany ()
 

Protected Attributes

 $class
 
 $displayProperties = true
 
 $displayMethods = false
 
 $displayMethodsParams = false
 
 $displayPropertiesTypes = false
 
 $displayAssociations
 
 $displayAssociationClassProperties = false
 
 $displayForeignKeys = true
 
 $properties
 
 $parseResult
 
 $note
 
- Protected Attributes inherited from ClassToYumlRelationsTrait
 $oneToManys = [ ]
 
 $manyToOne = [ ]
 
 $manyToManys = [ ]
 
 $extManyToManys = [ ]
 

Detailed Description

yuml export tool for class Ubiquity\utils\yuml$ClassToYuml This class is part of Ubiquity

Author
jcheron myadd.nosp@m.ress.nosp@m.mail@.nosp@m.gmai.nosp@m.l.com
Version
1.0.4

Definition at line 17 of file ClassToYuml.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $class,
  $displayProperties = true,
  $displayAssociations = true,
  $displayMethods = false,
  $displayMethodsParams = false,
  $displayPropertiesTypes = false,
  $displayAssociationClassProperties = false 
)

Definition at line 30 of file ClassToYuml.php.

Member Function Documentation

◆ __toString()

__toString ( )

Definition at line 167 of file ClassToYuml.php.

◆ _getNote()

_getNote ( )
protected

Definition at line 123 of file ClassToYuml.php.

◆ getAccess()

getAccess (   $property)
protected

Definition at line 140 of file ClassToYuml.php.

◆ getMethodParameters()

getMethodParameters ( \ReflectionMethod  $method)
protected

Definition at line 127 of file ClassToYuml.php.

◆ init()

init (   $hasManyToOne,
  $hasOneToMany,
  $hasManyToMany 
)

Definition at line 40 of file ClassToYuml.php.

◆ manyToManyTostring()

manyToManyTostring (   $load = true)

Definition at line 160 of file ClassToYuml.php.

◆ manyToOneTostring()

manyToOneTostring ( )

Definition at line 150 of file ClassToYuml.php.

◆ oneToManyTostring()

oneToManyTostring ( )

Definition at line 155 of file ClassToYuml.php.

◆ parse()

parse ( )

Definition at line 52 of file ClassToYuml.php.

◆ parseMethod()

parseMethod ( $methodsArray,
  $method 
)
protected

Definition at line 110 of file ClassToYuml.php.

◆ parseProperty()

parseProperty ( $propertiesArray,
  $property,
  $prikeys,
  $types 
)
protected

Definition at line 95 of file ClassToYuml.php.

◆ setDisplayAssociations()

setDisplayAssociations (   $displayAssociations)

Definition at line 187 of file ClassToYuml.php.

◆ setDisplayMethods()

setDisplayMethods (   $displayMethods)

Definition at line 182 of file ClassToYuml.php.

◆ setDisplayProperties()

setDisplayProperties (   $displayProperties)

Definition at line 177 of file ClassToYuml.php.

Field Documentation

◆ $class

$class
protected

Definition at line 18 of file ClassToYuml.php.

◆ $displayAssociationClassProperties

$displayAssociationClassProperties = false
protected

Definition at line 24 of file ClassToYuml.php.

◆ $displayAssociations

$displayAssociations
protected

Definition at line 23 of file ClassToYuml.php.

◆ $displayForeignKeys

$displayForeignKeys = true
protected

Definition at line 25 of file ClassToYuml.php.

◆ $displayMethods

$displayMethods = false
protected

Definition at line 20 of file ClassToYuml.php.

◆ $displayMethodsParams

$displayMethodsParams = false
protected

Definition at line 21 of file ClassToYuml.php.

◆ $displayProperties

$displayProperties = true
protected

Definition at line 19 of file ClassToYuml.php.

◆ $displayPropertiesTypes

$displayPropertiesTypes = false
protected

Definition at line 22 of file ClassToYuml.php.

◆ $note

$note
protected

Definition at line 28 of file ClassToYuml.php.

◆ $parseResult

$parseResult
protected

Definition at line 27 of file ClassToYuml.php.

◆ $properties

$properties
protected

Definition at line 26 of file ClassToYuml.php.


The documentation for this class was generated from the following file: