Abstract class for properties of datasets
This class is used to extends datasets with additional properties, and stores only non default values for each data point in a data set.
The class is extended by property implementations including simple value validators, like:
Source for this file: /Graph/src/interfaces/dataset_property.php
Version: | //autogentag// |
Child Class | Description |
---|---|
ezcGraphDataSetStringProperty | Class for string properties of datasets |
ezcGraphDataSetIntProperty | Class for integer properties of datasets |
ezcGraphDataSetColorProperty | Class for color properties of datasets |
ezcGraphDataSetAxisProperty | Class for axis properties of datasets |
ezcGraphDataSetBooleanProperty | Class for boolean properties of datasets |
protected ezcGraphDataSet |
$dataset
Contains a reference to the dataset to check for availability of data keys |
protected array |
$dataValue
Contains specified values for single dataset elements |
protected mixed |
$defaultValue
Default value for this property |
protected abstract void |
checkValue(
&$value
, $value
)
Abstract method to contain the check for validity of the value |
public bool |
offsetExists(
$key
)
Returns if an option exists. |
public mixed |
offsetGet(
$key
)
Returns an option value. |
public void |
offsetSet(
$key
, $value
)
Set an option. |
public void |
offsetUnset(
$key
)
Unset an option. |
public mixed |
__get(
$name
)
Get the default value for this property |
public void |
__set(
$name
, $value
)
Set the default value for this property |
Abstract method to contain the check for validity of the value
Name | Type | Description |
---|---|---|
$value |
mixed | |
&$value |
Method | Description |
---|---|
ezcGraphDataSetStringProperty::checkValue() |
Converts value to an ezcGraphColor object |
ezcGraphDataSetIntProperty::checkValue() |
Converts value to an ezcGraphColor object |
ezcGraphDataSetColorProperty::checkValue() |
Converts value to an ezcGraphColor object |
ezcGraphDataSetAxisProperty::checkValue() |
Chacks if value is really an axis |
ezcGraphDataSetBooleanProperty::checkValue() |
Converts value to an ezcGraphColor object |
Returns if an option exists.
Allows isset() using ArrayAccess.
Name | Type | Description |
---|---|---|
$key |
string | The name of the option to get. |
Method | Description |
---|---|
ArrayAccess::offsetExists |
Returns an option value.
Get an option value by ArrayAccess.
Name | Type | Description |
---|---|---|
$key |
string | The name of the option to get. |
Type | Description |
---|---|
ezcBasePropertyNotFoundException |
If a the value for the property options is not an instance of |
Method | Description |
---|---|
ArrayAccess::offsetGet |
Set an option.
Sets an option using ArrayAccess.
Name | Type | Description |
---|---|---|
$key |
string | The option to set. |
$value |
mixed | The value for the option. |
Type | Description |
---|---|
ezcBaseValueException |
If a the value for a property is out of range. |
ezcBasePropertyNotFoundException |
If a the value for the property options is not an instance of |
Method | Description |
---|---|
ArrayAccess::offsetSet |
Method | Description |
---|---|
ezcGraphDataSetAxisProperty::offsetSet() |
Set an option. |
Unset an option.
Unsets an option using ArrayAccess.
Name | Type | Description |
---|---|---|
$key |
string | The options to unset. |
Type | Description |
---|---|
ezcBaseValueException |
If a the value for a property is out of range. |
ezcBasePropertyNotFoundException |
If a the value for the property options is not an instance of |
Method | Description |
---|---|
ArrayAccess::offsetUnset |
Get the default value for this property
Name | Type | Description |
---|---|---|
$name |
string | Property name |
Set the default value for this property
Name | Type | Description |
---|---|---|
$name |
string | Property name |
$value |
mixed | Property value |