Class Yurt
Summary
Instance fields
| - $config | The characteristics of this yurt, retrieved from config file |
| # $results | Data computed by yurt parts |
Instance methods
| + setResults($key1, $key2, $value) | Used by YurtParts to store a result |
| + getResults($key1, $key2) | Return a result computed by a part |
| + __construct($configFile) | Builds a Yurt object from config file |
| + getConfig($key1 = '', $key2 = '') | Returns the characteristics of this yurt. |
| + generateDocument($outputDir) | Generates a document containing the plans of the yurt. |
Details
Instance fields
private $config = ''The characteristics of this yurt, retrieved from config file
Defined in line 21 of file Yurt.php
Instance methods
public function setResults( |
$key1)
|
Used by YurtParts to store a result
Parameters
$key1 |
|
$key2 |
|
$value |
public function getResults( |
$key1)
|
Return a result computed by a part
Parameters
$key1 |
|
$key2 |
public function __construct( |
$configFile)
|
public function getConfig( |
$key1 = '')
|
Returns the characteristics of this yurt.
Returns the complete array or part of it, depending on the values of $key1 and $key2
Parameters
Returns the complete array or part of it, depending on the values of $key1 and $key2
$key1 |
|
$key2 |
public function generateDocument( |
$outputDir)
|
Generates a document containing the plans of the yurt.
Unique entry point of yurt API
Parameters
Unique entry point of yurt API
$outputDir |
The directory where the plans are saved |
Returns
true in case of normal execution