Class DEnumItem

The DEnumItem (Dynamic Enum Item) complex data type. Has a one-to-many relationship with the DEnum type.

Alpha\Model\Type\DEnumItem implements Alpha\Model\Type\TypeInterface

Namespace: Alpha\Model\Type
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> 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. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Model/Type/DEnumItem.php

Methods summary
`public`	# `__construct( )` The constructor. The constructor. Since 1.0 Overrides `Alpha\Model\ActiveRecord::__construct()`
`public array`	# `loadItems( integer $EnumID )` Loads all of the items for the given parent DEnum ID. Loads all of the items for the given parent DEnum ID. Parameters `$EnumID` int $EnumID The ID of the parent DEnum object. Returns `array` array Throws `Alpha\Exception\AlphaException` Alpha\Exception\AlphaException Since 1.0
`public Alpha\Model\Type\String`	# `getValue( )` used to get the current DEnum item. used to get the current DEnum item. Returns `Alpha\Model\Type\String` Alpha\Model\Type\String Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::getValue()`
`public`	# `setValue( string $item )` used to set the current DEnum item. used to set the current DEnum item. Parameters `$item` string $item Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::setValue()`
`public string`	# `getHelper( )` Getter for the validation helper string. Getter for the validation helper string. Returns `string` 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` string $helper Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::setHelper()`
`public string`	# `__toString( )` Used to convert the object to a printable string. Used to convert the object to a printable string. Returns `string` string Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::__toString()`

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

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

Properties summary
`protected Alpha\Model\Type\String`	`$value`		# The value that will appear in the drop-down. The value that will appear in the drop-down. Since 1.0
`protected Alpha\Model\Type\Integer`	`$DEnumID`		# The ID of the parent DEnum object. The ID of the parent DEnum object. Since 1.0
`protected array`	`$dataLabels`	`array('OID' => 'DEnumItem ID#', 'value' => 'Dropdown value')`	# an array of data display labels for the class properties. an array of data display labels for the class properties. Since 1.0
`protected string`	`$helper`	`'Not a valid DEnumItem value!'`	# The message to display to the user when validation fails. The message to display to the user when validation fails. Since 1.0

Properties inherited from Alpha\Model\ActiveRecord
`$OID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num`

Namespaces

Classes

Interfaces

Class DEnumItem

Since

Overrides

Parameters

Returns

Throws

Since

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Implementation of

Since

Since

Since

Since

Since