silverstripe-framework/forms/MoneyField.php
Ingo Schommer 7700b223a3 MINOR Documentation for MoneyField
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@113691 467b73ca-7a2a-4603-9d3b-597d59a354a9
2010-11-13 02:05:34 +00:00

163 lines
4.3 KiB
PHP

<?php
/**
* A form field that can save into a {@link Money} database field.
* See {@link CurrencyField} for a similiar implementation
* that can save into a single float database field without indicating the currency.
*
* @author Ingo Schommer, SilverStripe Ltd. (<firstname>@silverstripe.com)
*
* @package sapphire
* @subpackage fields-formattedinput
*/
class MoneyField extends FormField {
/**
* @var string $_locale
*/
protected $_locale;
/**
* Limit the currencies
* @var array $allowedCurrencies
*/
protected $allowedCurrencies;
/**
* @var FormField
*/
protected $fieldAmount = null;
/**
* @var FormField
*/
protected $fieldCurrency = null;
function __construct($name, $title = null, $value = "", $form = null) {
// naming with underscores to prevent values from actually being saved somewhere
$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
$this->fieldCurrency = $this->FieldCurrency($name);
parent::__construct($name, $title, $value, $form);
}
/**
* @return string
*/
function Field() {
return "<div class=\"fieldgroup\">" .
"<div class=\"fieldgroupField\">" . $this->fieldCurrency->SmallFieldHolder() . "</div>" .
"<div class=\"fieldgroupField\">" . $this->fieldAmount->SmallFieldHolder() . "</div>" .
"</div>";
}
/**
* @param string $name - Name of field
* @return FormField
*/
protected function FieldCurrency($name) {
$allowedCurrencies = $this->getAllowedCurrencies();
if($allowedCurrencies) {
$field = new DropdownField(
"{$name}[Currency]",
_t('MoneyField.FIELDLABELCURRENCY', 'Currency'),
ArrayLib::is_associative($allowedCurrencies) ? $allowedCurrencies : array_combine($allowedCurrencies,$allowedCurrencies)
);
} else {
$field = new TextField(
"{$name}[Currency]",
_t('MoneyField.FIELDLABELCURRENCY', 'Currency')
);
}
return $field;
}
function setValue($val) {
$this->value = $val;
if(is_array($val)) {
$this->fieldCurrency->setValue($val['Currency']);
$this->fieldAmount->setValue($val['Amount']);
} elseif($val instanceof Money) {
$this->fieldCurrency->setValue($val->getCurrency());
$this->fieldAmount->setValue($val->getAmount());
}
// @todo Format numbers according to current locale, incl.
// decimal and thousands signs, while respecting the stored
// precision in the database without truncating it during display
// and subsequent save operations
}
/**
* 30/06/2009 - Enhancement:
* SaveInto checks if set-methods are available and use them
* instead of setting the values in the money class directly. saveInto
* initiates a new Money class object to pass through the values to the setter
* method.
*
* (see @link MoneyFieldTest_CustomSetter_Object for more information)
*/
function saveInto($dataObject) {
$fieldName = $this->name;
if($dataObject->hasMethod("set$fieldName")) {
$dataObject->$fieldName = DBField::create('Money', array(
"Currency" => $this->fieldCurrency->Value(),
"Amount" => $this->fieldAmount->Value()
));
} else {
$dataObject->$fieldName->setCurrency($this->fieldCurrency->Value());
$dataObject->$fieldName->setAmount($this->fieldAmount->Value());
}
}
/**
* Returns a readonly version of this field.
*/
function performReadonlyTransformation() {
$clone = clone $this;
$clone->setReadonly(true);
return $clone;
}
/**
* @todo Implement removal of readonly state with $bool=false
* @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
*/
function setReadonly($bool) {
parent::setReadonly($bool);
if($bool) {
$this->fieldAmount = $this->fieldAmount->performReadonlyTransformation();
$this->fieldCurrency = $this->fieldCurrency->performReadonlyTransformation();
}
}
/**
* @param array $arr
*/
function setAllowedCurrencies($arr) {
$this->allowedCurrencies = $arr;
// @todo Has to be done twice in case allowed currencies changed since construction
$oldVal = $this->fieldCurrency->Value();
$this->fieldCurrency = $this->FieldCurrency($this->name);
$this->fieldCurrency->setValue($oldVal);
}
/**
* @return array
*/
function getAllowedCurrencies() {
return $this->allowedCurrencies;
}
function setLocale($locale) {
$this->_locale = $locale;
}
function getLocale() {
return $this->_locale;
}
}
?>