Source for file Sequence.inc
Documentation is available at Sequence.inc
require_once $config->get('sysRoot'). 'alpha/model/types/AlphaTypeInterface.inc';
* 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.
* @package alpha::model::types
* @author John Collins <dev@alphaframework.org>
* @version $Id: Sequence.inc 1453 2011-12-04 15:12:54Z johnc $
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
* 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
* * 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.
* The string prefix (must be capital alphabet characters only)
* The integer sequence number incremented for each Sequence value with this prefix
* The name of the database table for the class
* An array of data display labels for the class properties
protected $dataLabels = array("OID"=> "Sequence ID#","prefix"=> "Sequence prefix","sequence"=> "Sequence number");
* The message to display to the user when validation fails
protected $helper = 'Not a valid sequence value!';
* The size of the value for the this Sequence
* The validation rule for the Sequence type
* The absolute maximum size of the value for the this Sequence
// ensure to call the parent constructor
$this->prefix->setHelper('Sequence prefix must be uppercase string!');
* Get the validation rule
* 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.
$this->set('sequence', 0);
$this->set('sequence', $this->get('sequence')+ 1);
* Getter for the validation helper string
* Set the validation helper text
* Used to get the Sequence value as a string
* Accepts a string to set the Sequence prefix/sequence values to, in the
* format PREFIX-00000000000
* @throws IllegalArguementException
* Get the allowable size of the Sequence in the database field
* Used to convert the object to a printable string
|