2009-10-23 03:29:55 +02:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* An abstract base class for the string field types (i.e. Varchar and Text)
|
2010-04-23 03:04:16 +02:00
|
|
|
* @package sapphire
|
2009-10-23 03:29:55 +02:00
|
|
|
* @subpackage model
|
|
|
|
* @author Pete Bacon Darwin
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
abstract class StringField extends DBField {
|
|
|
|
protected $nullifyEmpty = true;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Construct a string type field with a set of optional parameters
|
|
|
|
* @param $name string The name of the field
|
|
|
|
* @param $options array An array of options e.g. array('nullifyEmpty'=>false). See {@link StringField::setOptions()} for information on the available options
|
|
|
|
*/
|
|
|
|
function __construct($name = null, $options = array()) {
|
|
|
|
// Workaround: The singleton pattern calls this constructor with true/1 as the second parameter, so we must ignore it
|
|
|
|
if(is_array($options)){
|
|
|
|
$this->setOptions($options);
|
|
|
|
}
|
|
|
|
parent::__construct($name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the optional parameters for this field.
|
|
|
|
* @param $options array of options
|
|
|
|
* The options allowed are:
|
|
|
|
* <ul><li>"nullifyEmpty"
|
|
|
|
* This is a boolean flag.
|
|
|
|
* True (the default) means that empty strings are automatically converted to nulls to be stored in the database.
|
|
|
|
* Set it to false to ensure that nulls and empty strings are kept intact in the database.
|
|
|
|
* </li></ul>
|
|
|
|
* @return unknown_type
|
|
|
|
*/
|
|
|
|
function setOptions(array $options = array()) {
|
|
|
|
if(array_key_exists("nullifyEmpty", $options)) {
|
|
|
|
$this->nullifyEmpty = $options["nullifyEmpty"] ? true : false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set whether this field stores empty strings rather than converting them to null
|
|
|
|
* @param $value boolean True if empty strings are to be converted to null
|
|
|
|
*/
|
|
|
|
function setNullifyEmpty($value) {
|
|
|
|
$this->nullifyEmpty == $value ? true : false;
|
|
|
|
}
|
|
|
|
/**
|
|
|
|
* Get whether this field stores empty strings rather than converting them to null
|
|
|
|
* @return bool True if empty strings are to be converted to null
|
|
|
|
*/
|
|
|
|
function getNullifyEmpty() {
|
|
|
|
return $this->nullifyEmpty;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* (non-PHPdoc)
|
|
|
|
* @see core/model/fieldtypes/DBField#hasValue()
|
|
|
|
*/
|
|
|
|
function hasValue() {
|
|
|
|
return ($this->value || $this->value == '0') || ( !$this->nullifyEmpty && $this->value === '');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* (non-PHPdoc)
|
|
|
|
* @see core/model/fieldtypes/DBField#prepValueForDB($value)
|
|
|
|
*/
|
|
|
|
function prepValueForDB($value) {
|
|
|
|
if ( !$this->nullifyEmpty && $value === '' ) {
|
|
|
|
return "'" . Convert::raw2sql($value) . "'";
|
|
|
|
} else {
|
|
|
|
return parent::prepValueForDB($value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-11-21 02:41:24 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return another DBField object with this value in lowercase.
|
|
|
|
*/
|
|
|
|
function Lower() {
|
|
|
|
return DBField::create(get_class($this), strtolower($this->value), $this->name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return another DBField object with this value in uppercase.
|
|
|
|
*/
|
|
|
|
function Upper() {
|
|
|
|
return DBField::create(get_class($this), strtoupper($this->value), $this->name);
|
|
|
|
}
|
|
|
|
|
2009-10-23 03:29:55 +02:00
|
|
|
}
|