silverstripe-framework/ORM/FieldType/DBCurrency.php

78 lines
2.0 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\ORM\FieldType;
use Deprecation;
/**
* Represents a decimal field containing a currency amount.
* The currency class only supports single currencies. For multi-currency support, use {@link Money}
2014-08-15 08:53:05 +02:00
*
*
* Example definition via {@link DataObject::$db}:
* <code>
* static $db = array(
* "Price" => "Currency",
* "Tax" => "Currency(5)",
* );
* </code>
*
* @package framework
* @subpackage orm
*/
class DBCurrency extends DBDecimal {
2014-08-15 08:53:05 +02:00
/**
* @config
* @var string
*/
private static $currency_symbol = '$';
2014-08-15 08:53:05 +02:00
public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
}
2014-08-15 08:53:05 +02:00
/**
* Returns the number as a currency, eg $1,000.00.
*/
public function Nice() {
// return "<span title=\"$this->value\">$" . number_format($this->value, 2) . '</span>';
$val = $this->config()->currency_symbol . number_format(abs($this->value), 2);
if($this->value < 0) return "($val)";
else return $val;
}
2014-08-15 08:53:05 +02:00
/**
* Returns the number as a whole-number currency, eg $1,000.
*/
public function Whole() {
$val = $this->config()->currency_symbol . number_format(abs($this->value), 0);
if($this->value < 0) return "($val)";
else return $val;
}
2014-08-15 08:53:05 +02:00
public function setValue($value, $record = null, $markChanged = true) {
$matches = null;
if(is_numeric($value)) {
$this->value = $value;
2014-08-15 08:53:05 +02:00
} else if(preg_match('/-?\$?[0-9,]+(.[0-9]+)?([Ee][0-9]+)?/', $value, $matches)) {
$this->value = str_replace(array('$',',',$this->config()->currency_symbol),'',$matches[0]);
2014-08-15 08:53:05 +02:00
} else {
$this->value = 0;
}
}
2014-08-15 08:53:05 +02:00
/**
* @deprecated 4.0 Use the "Currency.currency_symbol" config setting instead
* @param [type] $value [description]
*/
2014-08-15 08:53:05 +02:00
public static function setCurrencySymbol($value) {
Deprecation::notice('4.0', 'Use the "Currency.currency_symbol" config setting instead');
DBCurrency::config()->currency_symbol = $value;
}
}