Detailed Description

PathDescription describes a path between two types.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 18 of file PathDescription.php.

Public Member Functions

 __construct (array $path)
 
 getStartType ()
 
 getStartRole ()
 
 getEndType ()
 
 getEndRole ()
 
 getPath ()
 
 getPathLength ()
 

Protected Attributes

 $startType = ''
 
 $startRole = ''
 
 $endType = ''
 
 $endRole = ''
 
 $path = null
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( array  $path)

Constructor.

Parameters
$pathArray of RelationDescription instances

Definition at line 31 of file PathDescription.php.

Member Function Documentation

◆ getStartType()

getStartType ( )

Get the PersistentObject type at the start point.

Returns
String

Definition at line 49 of file PathDescription.php.

◆ getStartRole()

getStartRole ( )

Get the role name at the start point.

Returns
String

Definition at line 57 of file PathDescription.php.

◆ getEndType()

getEndType ( )

Get the PersistentObject type at the end point.

Returns
String

Definition at line 65 of file PathDescription.php.

◆ getEndRole()

getEndRole ( )

Get the role name at the end point.

Returns
String

Definition at line 73 of file PathDescription.php.

◆ getPath()

getPath ( )

Get the path.

Returns
Array of RelationDesctription instances

Definition at line 81 of file PathDescription.php.

◆ getPathLength()

getPathLength ( )

Get the length of the path.

Returns
int

Definition at line 89 of file PathDescription.php.

Member Data Documentation

◆ $startType

$startType = ''
protected

Definition at line 20 of file PathDescription.php.

◆ $startRole

$startRole = ''
protected

Definition at line 21 of file PathDescription.php.

◆ $endType

$endType = ''
protected

Definition at line 22 of file PathDescription.php.

◆ $endRole

$endRole = ''
protected

Definition at line 23 of file PathDescription.php.

◆ $path

$path = null
protected

Definition at line 25 of file PathDescription.php.