| alpha--model--types

# Class: Sequence Source Location: /model/types/Sequence.inc ## Class Sequence Class Overview
Implements interfaces: AlphaTypeInterface A customer 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. Located in /model/types/Sequence.inc [line 50]
    AlphaDAO
       |
       --Sequence
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: Sequence.inc 1341 2011-03-17 15:02:02Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     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.
Since: | 1.0
License: | The BSD License
| Properties $dataLabels $helper $prefix $sequence $size $validationRule | Methods __construct getHelper getRule getSize getValue setHelper setSequenceToNext setValue __toString
[ Top ] Inherited Properties, Constants, and Methods
Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
Inherited From AlphaDAO AlphaDAO::$created_by AlphaDAO::$created_ts AlphaDAO::$defaultAttributes AlphaDAO::$lastQuery AlphaDAO::$OID AlphaDAO::$transientAttributes AlphaDAO::$uniqueAttributes AlphaDAO::$updated_by AlphaDAO::$updated_ts AlphaDAO::$version_num | Inherited From AlphaDAO AlphaDAO::__construct() The constructor which sets up some housekeeping attributes AlphaDAO::addProperty() Adds in a new class property without loosing existing data (does an ALTER TABLE query on the database). AlphaDAO::begin() Starts a new database transaction. AlphaDAO::bindParams() Dynamically binds all of the attributes for the current BO to the supplied prepared statement parameters. If arrays of attribute names and values are provided, only those will be bound to the supplied statement. AlphaDAO::bindResult() Dynamically binds the result of the supplied prepared statement to a 2d array, where each element in the array is another array representing a database row. AlphaDAO::cast() Cast a BO to another type of BO. A new BO will be returned with the same OID and version_num as the old BO, so this is NOT a true cast but is a copy. All attribute values will be copied accross. AlphaDAO::checkBOTableExists() Static method to check the database and see if the table for the indicated BO class name exists (assumes table name will be $BOClassName less "Object"). AlphaDAO::checkClassDefExists() Checks if the definition for the BO class name provided exists on the file system. AlphaDAO::checkIndexes() Checks to see if all of the indexes are in place for the BO's table, creates those that are missing. AlphaDAO::checkRecordExists() Checks that a record exists for the BO in the database. AlphaDAO::checkTableExists() Checks to see if the table exists in the database for the current business class. AlphaDAO::checkTableNeedsUpdate() Checks to see if the table in the database matches (for fields) the business class definition, i.e. if the database table is in sync with the class definition. AlphaDAO::commit() Commits the current database transaction. AlphaDAO::createForeignIndex() Creates a foreign key constraint (index) in the database on the given attribute. AlphaDAO::createUniqueIndex() Creates a unique index in the database on the given attribute(s). AlphaDAO::delete() Deletes the current object from the database. AlphaDAO::deleteAllByAttribute() Delete all object instances from the database by the specified attribute matching the value provided. AlphaDAO::disconnect() Disconnects the current database connection if one exists (self::$connection is set) AlphaDAO::dropTable() Drops the table if the model requirements have changed. All data is lost! AlphaDAO::findMissingFields() Returns an array containing any properties on the class which have not been created on the database table yet. AlphaDAO::findOffendingValue() Parses a MySQL error for the value that violated a unique constraint. AlphaDAO::get() Generic getter method for accessing class properties. Will use the method get.ucfirst($prop) instead if that method exists at a child level (by default). Set $noChildMethods to true if you don't want to use any get.ucfirst($prop) method even if it exists, false otherwise (default). AlphaDAO::getBOClassNames() Loops over the core and custom BO directories and builds an array of all of the BO class names in the system. AlphaDAO::getConnection() Gets the current connection singleton, or creates a new one if none exists AlphaDAO::getCount() Gets the count from the database for the amount of objects of this class. AlphaDAO::getCreateTS() Method for getting the date/time of when the BO was created. AlphaDAO::getCreatorId() Method for getting the OID of the person who created this BO. AlphaDAO::getDataLabel() Gets the data label for the given attribute name. AlphaDAO::getDataLabels() Gets the data labels array. AlphaDAO::getDefaultAttributes() Get the array of default attribute names. AlphaDAO::getFriendlyClassName() Converts "BusinessObject" to "Business" and returns. AlphaDAO::getID() Gets the OID for the object in zero-padded format (same as getOID()). This version is designed to be overridden in case you want to do something different with the ID of your objects outside of the standard 11 digit OID sequence used internally in Alpha. AlphaDAO::getIndexes() Gets an array of all of the names of the active database indexes for this class. AlphaDAO::getLastQuery() Get the last database query run on this object. AlphaDAO::getMAX() Gets the maximum OID value from the database for this class type. AlphaDAO::getOID() Gets the OID for the object in zero-padded format (same as getID()). This version is final so cannot be overridden. AlphaDAO::getPersistentAttributes() Get the array of persistent attribute names, i.e. those that are saved in the database. AlphaDAO::getPropObject() Gets the property object rather than the value for complex attributes. Returns false if the property exists but is private. AlphaDAO::getTableName() Getter for the TABLE_NAME, which should be set by a child of this class. AlphaDAO::getTransientAttributes() Get the array of transient attribute names. AlphaDAO::getUpdateTS() Method for getting the date/time of when the BO was last updated. AlphaDAO::getUpdatorId() Method for getting the OID of the person who updated this BO. AlphaDAO::getVersion() Gets the version_num of the object from the database (returns 0 if the BO is not saved yet). AlphaDAO::getVersionNumber() Method for getting version number of the object. AlphaDAO::hasAttribute() Check to see if an attribute exists on the BO. AlphaDAO::isInstalled() Static method that tries to determine if the system database has been installed or not. AlphaDAO::isTableOverloaded() Checks to see if the table name matches the classname, and if not if the table name matches the classname name of another BO, i.e. the table is used to store multiple types of BOs. AlphaDAO::isTagged() Returns true if the BO has a Relation property called tags, false otherwise. AlphaDAO::isTransient() Inspector to see if the business object is transient (not presently stored in the database). AlphaDAO::load() Populates the child object with the properties retrived from the database for the object $OID. AlphaDAO::loadAll() Loads all of the objects of this class into an array which is returned. AlphaDAO::loadAllByAttribute() Loads all of the objects of this class by the specified attribute into an array which is returned. AlphaDAO::loadAllByAttributes() Loads all of the objects of this class by the specified attributes into an array which is returned. AlphaDAO::loadAllByDayUpdated() Loads all of the objects of this class that where updated (updated_ts value) on the date indicated. AlphaDAO::loadAllFieldValuesByAttribute() Loads all of the specified attribute values of this class by the specified attribute into an array which is returned. AlphaDAO::loadByAttribute() Populates the child object from the database table by the given attribute value. AlphaDAO::loadClassDef() Loads the definition from the file system for the BO class name provided. AlphaDAO::makeTable() Builds a new database table for the BO class. AlphaDAO::markPersistent() Removes the name of the attribute provided from the list of transient (non-saved) attributes for this BO, ensuring that it will be saved on the next attempt. AlphaDAO::markTransient() Adds the name of the attribute provided to the list of transient (non-saved) attributes for this BO. AlphaDAO::markUnique() Adds the name of the attribute(s) provided to the list of unique (constrained) attributes for this BO. AlphaDAO::populateFromPost() Populates the current business object from global POST data. AlphaDAO::rebuildTable() Re-builds the table if the model requirements have changed. All data is lost! AlphaDAO::reload() Reloads the object from the database, overwritting any attribute values in memory. AlphaDAO::rollback() Aborts the current database transaction. AlphaDAO::save() Saves the object. If $this->OID is empty or null it will INSERT, otherwise UPDATE. AlphaDAO::saveAttribute() Saves the field specified with the value supplied. Only works for persistent BOs. Note that no Alpha type validation is performed with this method! AlphaDAO::set() Generic setter method for setting class properties. Will use the method set.ucfirst($prop) instead if that method exists at a child level (by default). Set $noChildMethods to true if you don't want to use any get.ucfirst($prop) method even if it exists, false otherwise (default). AlphaDAO::setEnumOptions() Populate all of the enum options for this object from the database. AlphaDAO::validate() Validates the object to be saved. |
[ Top ] Constant Summary
MAX_SIZE | The absolute maximum size of the value for the this Sequence
TABLE_NAME | The name of the database table for the class
[ Top ] Property Summary
array | $dataLabels | An array of data display labels for the class properties
string | $helper | The message to display to the user when validation fails
String | $prefix | The string prefix (must be capital alphabet characters only)
Integer | $sequence | The integer sequence number incremented for each Sequence value with this prefix
integer | $size | The size of the value for the this Sequence
string | $validationRule | The validation rule for the Sequence type
[ Top ] Method Summary
Sequence | __construct() | The constructor
string | getHelper() | Getter for the validation helper string
string | getRule() | Get the validation rule
integer | getSize() | Get the allowable size of the Sequence in the database field
string | getValue() | Used to get the Sequence value as a string
void | setHelper() | Set the validation helper text
void | 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.
void | setValue() | Accepts a string to set the Sequence prefix/sequence values to, in the format PREFIX-00000000000
string | __toString() | Used to convert the object to a printable string
[ Top ] Properties array $dataLabels = array("OID"=>"Sequence ID#","prefix"=>"Sequence prefix","sequence"=>"Sequence number") [line 81] An array of data display labels for the class properties API Tags:
Access: | protected
Information Tags:
Since: | 1.0
Redefinition of: AlphaDAO::$dataLabels An array of the data labels used for displaying class attributes [ Top ] string $helper = 'Not a valid sequence value!' [line 89] The message to display to the user when validation fails API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] String $prefix [line 57] The string prefix (must be capital alphabet characters only) API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Integer $sequence [line 65] The integer sequence number incremented for each Sequence value with this prefix API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] integer $size = 255 [line 97] The size of the value for the this Sequence API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] string $validationRule [line 105] The validation rule for the Sequence type API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Methods Constructor __construct [line 120]
`Sequence __construct( )`
The constructor API Tags:
Access: | public
Information Tags:
Since: | 1.0
Redefinition of: AlphaDAO::__construct() The constructor which sets up some housekeeping attributes [ Top ] getHelper [line 172]
`string getHelper( )`
Getter for the validation helper string API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::getHelper() Get the validation helper text [ Top ] getRule [line 144]
`string getRule( )`
Get the validation rule API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getSize [line 228]
`integer getSize( )`
Get the allowable size of the Sequence in the database field API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getValue [line 192]
`string getValue( )`
Used to get the Sequence value as a string API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::getValue() Get the value [ Top ] setHelper [line 182]
`void setHelper( string $helper )`
Set the validation helper text Parameters:
string | $helper: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::setHelper() Set the validation helper text [ Top ] setSequenceToNext [line 154]
`void 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. API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] setValue [line 207]
`void setValue( string $val )`
Accepts a string to set the Sequence prefix/sequence values to, in the format PREFIX-00000000000 Parameters:
string | $val: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
Implementation of: AlphaTypeInterface::setValue() Set the value of the type [ Top ] __toString [line 238]
`string __toString( )`
Used to convert the object to a printable string API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::__toString() Convert the valud of the complex type to a string [ Top ] Constants MAX_SIZE = 255 [line 113] The absolute maximum size of the value for the this Sequence Information Tags:
Since: | 1.0
[ Top ] TABLE_NAME = 'Sequence' [line 73] The name of the database table for the class Information Tags:
Since: | 1.0
[ Top ] Documentation generated on Thu, 17 Mar 2011 16:44:49 +0000 by phpDocumentor 1.4.3