Class Sequence

A custom sequence datatype, which is stored as a string and is made up of a string prefix and an integer sequence, which is stored in a database.

Alpha\Model\ActiveRecord

Alpha\Model\Type\Sequence 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/Sequence.php

Methods summary

`public`	# `__construct( )` The constructor. The constructor. Since 1.0 Overrides `Alpha\Model\ActiveRecord::__construct`
`public string`	# `getRule( )` Get the validation rule. Get the validation rule. Returns string Since 1.0
`public`	# `setSequenceToNext( )` Sets the sequence number to be the maximum value matching the prefix in the database plus one. Note that calling this method increments the maximum value in the database. Sets the sequence number to be the maximum value matching the prefix in the database plus one. Note that calling this method increments the maximum value in the database. 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 string`	# `getValue( )` Used to get the Sequence value as a string. Used to get the Sequence value as a string. Returns string Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::getValue()`
`public`	# `setValue( string $val )` Accepts a string to set the Sequence prefix/sequence values to, in the format PREFIX-00000000000. Accepts a string to set the Sequence prefix/sequence values to, in the format PREFIX-00000000000. Parameters `$val` Throws `Alpha\Exception\IllegalArguementException` Since 1.0 Implementation of `Alpha\Model\Type\TypeInterface::setValue()`
`public integer`	# `getSize( )` Get the allowable size of the Sequence in the database field. Get the allowable size of the Sequence in the database field. 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	# `'Sequence'`
`integer`	`MAX_SIZE` The absolute maximum size of the value for the this Sequence. The absolute maximum size of the value for the this Sequence. Since 1.0	# `255`

Properties summary

`protected Alpha\Model\String`	`$prefix` The string prefix (must be capital alphabet characters only). The string prefix (must be capital alphabet characters only). Since 1.0	#
`protected Alpha\Model\Integer`	`$sequence` The integer sequence number incremented for each Sequence value with this prefix. The integer sequence number incremented for each Sequence value with this prefix. 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' => 'Sequence ID#', 'prefix' => 'Sequence prefix', 'sequence' => 'Sequence number')`
`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 sequence value!'`
`protected integer`	`$size` The size of the value for the this Sequence. The size of the value for the this Sequence. Since 1.0	# `255`
`protected string`	`$validationRule` The validation rule for the Sequence type. The validation rule for the Sequence type. Since 1.0	#

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 Sequence

Methods summary

Since

Overrides

Returns

Since

Since

Returns

Since

Implementation of

Parameters

Since

Implementation of

Returns

Since

Implementation of

Parameters

Throws

Since

Implementation of

Returns

Since

Returns

Since

Implementation of

Methods inherited from Alpha\Model\ActiveRecord

Constants summary

Since

Since

Properties summary

Since

Since

Since

Since

Since

Since

Properties inherited from Alpha\Model\ActiveRecord