README

Laravel 5 model revaluation helper.

👁 Build Status
👁 Latest Stable Version
👁 Latest Unstable Version
👁 Scrutinizer Code Quality
👁 Code Coverage
👁 Total Downloads
👁 License

Installation

You can install the package using composer

$ composer require overtrue/laravel-revaluation -vvv

Then add the service provider to config/app.php

Overtrue\LaravelRevaluation\RevaluationServiceProvider::class,

Publish the config file:

$ php artisan vendor:publish --provider='Overtrue\LaravelRevaluation\RevaluationServiceProvider'

Finally, use Overtrue\LaravelRevaluation\Traits\HasRevaluableAttributes in model. And specify which attributes in the $revaluable property can be revalued:

<?php

use Illuminate\Database\Eloquent\Model;
use Overtrue\LaravelRevaluation\Traits\HasRevaluableAttributes;

class Order extends Model
{
 use HasRevaluableAttributes;

 // 1. Use the default valuator.
 protected $revaluable = [
 'total', 'paid_in', 'postage',
 ];

 // 2. Use the specified valuator:
 // protected $revaluable = [
 // 'foo' => '\Foo\Support\Valuator\Foo',
 // 'bar' => '\Foo\Support\Valuator\Bar',
 // 'baz', // default valuator
 //];

 //...
}

Usage

Basic usage with default options.

$order = Order::find(1);

$order->total; // 345 (Db: 34500)
$order->raw_total; // 34500

$order->getRevaluatedTotalAttribute() or $order->revaluated_total; // Overtrue\LaravelRevaluation\Valuators\RmbCent
$order->revaluated_total->inYuan(); // 345.00
$order->revaluated_total->asCurrency(); // ￥345.00

// automatic setter.
$order->total = 123;
$order->save();

$order->total; // 123
$order->raw_total; // 12300
$order->revaluated_total->asCurrency(); // ￥123.00

// to array
$order->toArray();
//[
// 'total' => 12300,
// 'revaluated_total' => 123.0,
//]

Custom revaluated attribute prefix

protected $revaluatedAttributePrefix = 'display';

$order->total; // 123.0;
$order->raw_total; // 12300
$order->display_total->asCurrency(); // ￥123.00

// to array
$order->toArray();
//[
// 'total' => 12300,
// 'display_total' => 123.0,
//]

Disable auto append revaluated attributes to array

protected $appendRevaluatedAttributesToArray = false;

$order->total; // 123.0;
$order->raw_total; // 12300
$order->display_total->asCurrency(); // ￥123.00

// to array
$order->toArray();
//[
// 'total' => 12300,
//]

Using revaluated value replace raw attributes value

protected $replaceRawAttributesToArray = true;

$order->total; // 123.0;
$order->raw_total; // 12300
$order->display_total->asCurrency(); // ￥123.00

// to array
$order->toArray();
//[
// 'total' => 123.0,
//]

More usage examples, Please refer to unit testing

PHP 扩展包开发

想知道如何从零开始构建 PHP 扩展包？

请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》

License

MIT