silverstripe-framework/forms/MoneyField.php

191 lines
4.9 KiB
PHP
Raw Normal View History

<?php
/**
* A form field that can save into a {@link Money} database field.
2014-08-15 08:53:05 +02:00
* See {@link CurrencyField} for a similiar implementation
* that can save into a single float database field without indicating the currency.
2014-08-15 08:53:05 +02:00
*
* @author Ingo Schommer, SilverStripe Ltd. (<firstname>@silverstripe.com)
2014-08-15 08:53:05 +02:00
*
* @package forms
* @subpackage fields-formattedinput
*/
class MoneyField extends FormField {
2014-08-15 08:53:05 +02:00
/**
* @var string $_locale
*/
protected $_locale;
2014-08-15 08:53:05 +02:00
/**
* Limit the currencies
* @var array $allowedCurrencies
*/
protected $allowedCurrencies;
2014-08-15 08:53:05 +02:00
/**
* @var FormField
*/
protected $fieldAmount = null;
2014-08-15 08:53:05 +02:00
/**
* @var FormField
*/
protected $fieldCurrency = null;
2014-08-15 08:53:05 +02:00
public function __construct($name, $title = null, $value = "") {
// 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);
2014-08-15 08:53:05 +02:00
parent::__construct($name, $title, $value);
}
2014-08-15 08:53:05 +02:00
/**
* @return string
*/
public function Field($properties = array()) {
return "<div class=\"fieldgroup\">" .
2014-08-15 08:53:05 +02:00
"<div class=\"fieldgroup-field\">" . $this->fieldCurrency->SmallFieldHolder() . "</div>" .
"<div class=\"fieldgroup-field\">" . $this->fieldAmount->SmallFieldHolder() . "</div>" .
"</div>";
}
2014-08-15 08:53:05 +02:00
/**
* @param string $name - Name of field
* @return FormField
*/
protected function FieldCurrency($name) {
$allowedCurrencies = $this->getAllowedCurrencies();
if($allowedCurrencies) {
$field = new DropdownField(
2014-08-15 08:53:05 +02:00
"{$name}[Currency]",
_t('MoneyField.FIELDLABELCURRENCY', 'Currency'),
ArrayLib::is_associative($allowedCurrencies)
? $allowedCurrencies
: array_combine($allowedCurrencies,$allowedCurrencies)
);
} else {
$field = new TextField(
2014-08-15 08:53:05 +02:00
"{$name}[Currency]",
_t('MoneyField.FIELDLABELCURRENCY', 'Currency')
);
}
2014-08-15 08:53:05 +02:00
return $field;
}
2014-08-15 08:53:05 +02:00
public 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());
}
2014-08-15 08:53:05 +02:00
// @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
return $this;
}
2014-08-15 08:53:05 +02:00
/**
2014-08-15 08:53:05 +02:00
* 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)
*/
public function saveInto(DataObjectInterface $dataObject) {
$fieldName = $this->name;
if($dataObject->hasMethod("set$fieldName")) {
$dataObject->$fieldName = DBField::create_field('Money', array(
"Currency" => $this->fieldCurrency->dataValue(),
"Amount" => $this->fieldAmount->dataValue()
));
} else {
$dataObject->$fieldName->setCurrency($this->fieldCurrency->dataValue());
$dataObject->$fieldName->setAmount($this->fieldAmount->dataValue());
}
}
/**
* Returns a readonly version of this field.
*/
public function performReadonlyTransformation() {
$clone = clone $this;
$clone->fieldAmount = $clone->fieldAmount->performReadonlyTransformation();
$clone->fieldCurrency = $clone->fieldCurrency->performReadonlyTransformation();
$clone->setReadonly(true);
return $clone;
}
2014-08-15 08:53:05 +02:00
/**
* @todo Implement removal of readonly state with $bool=false
* @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
*/
public function setReadonly($bool) {
parent::setReadonly($bool);
2014-08-15 08:53:05 +02:00
$this->fieldAmount->setReadonly($bool);
$this->fieldCurrency->setReadonly($bool);
return $this;
}
public function setDisabled($bool) {
parent::setDisabled($bool);
2014-08-15 08:53:05 +02:00
$this->fieldAmount->setDisabled($bool);
$this->fieldCurrency->setDisabled($bool);
return $this;
}
2014-08-15 08:53:05 +02:00
/**
* @param array $arr
*/
public function setAllowedCurrencies($arr) {
$this->allowedCurrencies = $arr;
2014-08-15 08:53:05 +02:00
// @todo Has to be done twice in case allowed currencies changed since construction
$oldVal = $this->fieldCurrency->dataValue();
$this->fieldCurrency = $this->FieldCurrency($this->name);
$this->fieldCurrency->setValue($oldVal);
return $this;
}
2014-08-15 08:53:05 +02:00
/**
* @return array
*/
public function getAllowedCurrencies() {
return $this->allowedCurrencies;
}
2014-08-15 08:53:05 +02:00
public function setLocale($locale) {
$this->_locale = $locale;
return $this;
}
2014-08-15 08:53:05 +02:00
public function getLocale() {
return $this->_locale;
}
/**
* Validate this field
*
* @param Validator $validator
* @return bool
*/
public function validate($validator) {
return !(is_null($this->fieldAmount) || is_null($this->fieldCurrency));
}
}