Class: File_Therion_Join

Source Location: /File_Therion-0.4.1/File/Therion/Join.php

Class Overview

File_Therion_BasicObject
   |
   --File_Therion_Join

Class representing a join definition object.

Author(s):

Benedikt Hallinger <beni at php.net>

Copyright:

2016 Benedikt Hallinger

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

File_Therion_BasicObject::$objStack
File_Therion_BasicObject::$_simpledata

Inherited Methods

Class: File_Therion_BasicObject

File_Therion_BasicObject::addComment(): Add a comment.
File_Therion_BasicObject::getData(): Get some simple data of this object.
File_Therion_BasicObject::getOption(): Get option of this object.
File_Therion_BasicObject::getOptionsString(): Generate basic options string.
File_Therion_BasicObject::handleCommonOption(): Handle known options supported by several objects.
File_Therion_BasicObject::setData(): Set some simple data of this object.
File_Therion_BasicObject::setOption(): Set options of this object.
File_Therion_BasicObject::_verify(): Verify basic compliance of item.

Class Details

[line 27]
Class representing a join definition object.

Joins are used to connect scraps or point/lines in scraps.

Author: Benedikt Hallinger <beni@php.net>
Copyright: 2016 Benedikt Hallinger
Link: http://pear.php.net/package/File_Therion/
License: LGPLv3

[ Top ]

Class Variables

$_joins = array()

[line 54]

Join arguments.

Array elements may be the following:

array(Scrap): Join whole scraps
array(ScrapPoint): scrap point object
array(ScrapLine): scrap line object
array(ScrapLinePoint): line with marked point (eg 'end')

Access: protected

Type:

array

[ Top ]

$_options = array(
        'smooth' => "",
        'count'  => 0
    )

[line 37]

Object options (title, ...).

Var: assoc array
Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 66]

File_Therion_Join __construct(
[array
$args = array()], [array
$options = array()])

Create a new therion Join object.

After creation of the join command you can call addArgument() to add join arguments.

Access: public

Parameters:

array	`$args`	—	Objects to join
array	`$options`	—	key=>value pairs of options to set

[ Top ]

addArgument [line 160]

void addArgument(
array|object Join
$arg)

Add a join argument.

Join arguments may be one of the following object instances:

File_Therion_Scrap: Join whole scraps
File_Therion_ScrapPoint object: Scrap point object
File_Therion_ScrapLine: scrap line object
File_Therion_ScrapLinePoint: Line with marked point (eg 'end')

Throws: InvalidArgumentException when incompatible object is added.
Access: public

Parameters:

array|object Join $arg — argument (scrap, Line, etc) or array of objects

[ Top ]

count [line 275]

int count(
)

Count arguments of this join (SPL Countable).

Return: number of argument objects
Access: public

[ Top ]

getArguments [line 265]

array getArguments(
)

Return joined objects.

Access: public

[ Top ]

parse [line 82]

File_Therion_Join parse(
File_Therion_Line
$line)

Parses given Therion_Line-objects into internal data structures.

Note that this will generate fresh subobjects to reflect the named IDs.

Return: Join object
Throws: InvalidArgumentException
Access: public

Parameters:

File_Therion_Line $line — line forming this object

[ Top ]

toLines [line 255]

{@link toLines(
)

Return Line representation of this command.

Return: File_Therion_Line} object
Access: public

[ Top ]

toString [line 201]

string toString(
)

Return therion compatible string of this join definition.

Return: eg "join lineA lineB -smooth on"
Throws: File_Therion_SyntaxException in case join syntax is invalid
Access: public

[ Top ]

__toString [line 245]

void __toString(
)

Magic __toString() method calls toString().

Access: public

[ Top ]

Class: File_Therion_Join

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

Inherited Methods

Class: File_Therion_BasicObject

Class Details

Class Variables

$_joins = array()

$_options = array( 'smooth' => "", 'count' => 0 )

Method Detail

__construct (Constructor) [line 66]

Parameters:

addArgument [line 160]

Parameters:

count [line 275]

getArguments [line 265]

parse [line 82]

Parameters:

toLines [line 255]

toString [line 201]

__toString [line 245]

$_options = array(
'smooth' => "",
'count' => 0
)