Class DEnum

The DEnum (Dynamic Enum) complex data type. Similiar to Enum, except list items are stored in a database table and are editable.

Alpha\Model\ActiveRecord

Alpha\Model\Type\DEnum implements Alpha\Model\Type\TypeInterface

Namespace: Alpha\Model\Type
Copyright:

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Model/Type/DEnum.php

Methods summary

`public`	# `__construct( string $name = null )` Constructor that sets up the DEnum options. Constructor that sets up the DEnum options. Parameters `$name` Overrides `Alpha\Model\ActiveRecord::__construct`
`public`	# `saveIfNew( )` Saves a new DEnum record with the same name as this instance if one does not already exist Saves a new DEnum record with the same name as this instance if one does not already exist Since 3.0
`public`	# `setName( string $name )` Setter for the name of the DEnum used in the database. Setter for the name of the DEnum used in the database. Parameters `$name` Since 1.0
`public array`	# `getOptions( boolean $alphaSort = false )` Get the array of DEnum options from the database. Get the array of DEnum options from the database. Parameters `$alphaSort` Returns array Throws `Alpha\Exception\AlphaException` Since 1.0
`public string`	# `getHelper( )` Getter for the validation helper string. Getter for the validation helper string. Returns string Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::getHelper()`
`public`	# `setHelper( string $helper )` Set the validation helper text. Set the validation helper text. Parameters `$helper` Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::setHelper()`
`public Alpha\Model\Type\SmallText`	# `getName( )` Getter for the name. Getter for the name. Returns `Alpha\Model\Type\SmallText` Since 1.0
`public integer`	# `getValue( )` Used to get the current DEnum item selected index value. Used to get the current DEnum item selected index value. Returns integer Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::getValue()`
`public string`	# `getDisplayValue( )` Used to get the current DEnum item string value. Used to get the current DEnum item string value. Returns string Since 1.0
`public`	# `setValue( string $item )` Used to select the current DEnum item. Used to select the current DEnum item. Parameters `$item` Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::setValue()`
`public integer`	# `getItemCount( )` Gets the count from the database of the DEnumItems associated with this object. Gets the count from the database of the DEnumItems associated with this object. Returns integer Throws `Alpha\Exception\AlphaException` Since 1.0
`public integer`	# `getOptionID( string $optionName )` Used to get the DenumItem ID for the given option name. Used to get the DenumItem ID for the given option name. Parameters `$optionName` Returns integer Since 1.0
`public string`	# `__toString( )` Used to convert the object to a printable string. Used to convert the object to a printable string. Returns string Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::__toString()`

Methods inherited from Alpha\Model\ActiveRecord

__wakeup(), addProperty(), addToCache(), backupDatabase(), begin(), cast(), checkDatabaseExists(), checkRecordExists(), checkRecordTableExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createDatabase(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropDatabase(), dropTable(), findMissingFields(), get(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getPersistentAttributes(), getPropObject(), getRecordClassNames(), getTableName(), getTaggedAttributes(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadAllOldVersions(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromArray(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), saveRelations(), set(), setDataLabels(), setEnumOptions(), setID(), setLastQuery(), setMaintainHistory(), toArray(), validate()

Constants summary

`string`	`TABLE_NAME` The name of the database table for the class. The name of the database table for the class. Since 1.0	# `'DEnum'`

Properties summary

`protected array`	`$options` An array of valid DEnum options. An array of valid DEnum options. Since 1.0	# `array()`
`protected integer`	`$value` The currently selected DEnum option. The currently selected DEnum option. Since 1.0	#
`protected Alpha\Model\Type\SmallText`	`$name` The name of the DEnum used in the database. The name of the DEnum used in the database. Since 1.0	#
`protected array`	`$dataLabels` An array of data display labels for the class properties. An array of data display labels for the class properties. Since 1.0	# `array('ID' => 'DEnum ID#', 'name' => 'Name')`
`protected string`	`$helper` The message to display to the user when validation fails. The message to display to the user when validation fails. Since 1.0	# `'Not a valid denum option!'`

Properties inherited from Alpha\Model\ActiveRecord

$ID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num

Namespaces

Classes

Interfaces

Class DEnum

Methods summary

Parameters

Overrides

Since

Parameters

Since

Parameters

Returns

Throws

Since

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Returns

Since

Implementation of

Returns

Since

Parameters

Since

Implementation of

Returns

Throws

Since

Parameters

Returns

Since

Returns

Since

Implementation of

Methods inherited from Alpha\Model\ActiveRecord

Constants summary

Since

Properties summary

Since

Since

Since

Since

Since

Properties inherited from Alpha\Model\ActiveRecord