Configuration

Configure the type after its mapping is registered. One explicit setup in Application::bootstrap(), after the parent call, disables automatic plugin bootstrap and registers the mapping before setting options:

php

use Cake\Database\TypeFactory;
use CakeDecimal\Database\Type\DecimalObjectType;

$this->addPlugin('CakeDecimal', ['bootstrap' => false]);
TypeFactory::map('decimal', DecimalObjectType::class);
$type = TypeFactory::build('decimal');
assert($type instanceof DecimalObjectType);
$type->useAutoTrim();
$type->useLocaleParser();

Calling addPlugin() alone does not immediately run plugin bootstrap. Building the type before its mapping is registered would configure the core type instead. A later TypeFactory::map() call discards the built instance and its options; keep the explicit mapping and configuration together.

Both options are disabled by default. Each accepts false to disable it again. Use your registered alias instead of decimal when configuring selected columns.

useAutoTrim() removes trailing fractional zeros when converting database values to PHP. It does not trim request values in marshal() or change the database column scale. It returns void and cannot be chained.

useLocaleParser() enables locale-aware conversion of string request values. It uses the active CakePHP locale and returns the type instance. It does not localize stored database values or configure form validation.

php

use Cake\I18n\I18n;

I18n::setLocale('de_DE');
$value = $type->marshal('1.234,50');
echo (string)$value; // 1234.50

The parser checks grouping widths against the locale, removes valid grouping separators and replaces the decimal separator using strings. It also handles native decimal digits, localized minus signs, and spaces or apostrophes used as grouping separators. Grouping must still have the correct widths; malformed or unrecognized input returns null. No float conversion is used for localized string input. Keep validation to present useful errors to users.

Only enable locale parsing for inputs written in the active locale. Under de_DE, a dot denotes thousands grouping: canonical input 19.90 has an invalid two-digit final group and returns null. Use 19,90 for that locale. Canonical values such as 1.234 can still be valid grouping in that locale and mean 1234. This ambiguity also affects JSON payloads, number inputs and decimal strings produced by casting a Decimal object. Use the default parser for canonical input, or separate localized input from those paths.

The public static DecimalObjectType::$numberClass defaults to Cake\I18n\Number. Locale parsing only supports that class or a subclass. This setting selects the formatter, not a custom Decimal value-object class: conversion always uses PhpCollective\DecimalObject\Decimal.

Configuration ​

Configuration