Page MenuHomePhorge
Files F120836221

Wallet.php
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

Wallet.php
View Options

<?php
namespace App;
use Iatstuti\Database\Support\NullableFields;
use Illuminate\Database\Eloquent\Model;
/**
* The eloquent definition of a wallet -- a container with a chunk of change.
*
* A wallet is owned by an {@link \App\User}.
*/
class Wallet extends Model
{
use NullableFields;
/**
Our table name for the shall be 'wallet'.
@var string
*/
public $incrementing = false;
protected $keyType = 'string';
public $timestamps = false;
protected $attributes = [
'balance' => 0.00,
'currency' => 'CHF'
];
protected $fillable = [
'currency'
];
protected $nullable = [
'description'
];
protected $casts = [
'balance' => 'float',
];
protected $guarded = ['balance'];
/**
* Add a controller to this wallet.
*
* @param User $user The user to add as a controller to this wallet.
*
* @return void
*/
public function addController($user)
{
if (!$this->controllers()->get()->contains($user)) {
return $this->controllers()->save($user);
}
}
/**
* Remove a controller from this wallet.
*
* @param User $user The user to remove as a controller from this wallet.
*
* @return void
*/
public function removeController($user)
{
if ($this->controllers()->get()->contains($user)) {
return $this->controllers()->detach($user);
}
}
/**
* Add an amount of pecunia to this wallet's balance.
*
* @param float $amount The amount of pecunia to add.
*
* @return Wallet
*/
public function credit(float $amount)
{
$this->balance += $amount;
$this->save();
return $this;
}
/**
* Deduct an amount of pecunia from this wallet's balance.
*
* @param float $amount The amount of pecunia to deduct.
*
* @return Wallet
*/
public function debit(float $amount)
{
$this->balance -= $amount;
$this->save();
return $this;
}
/**
* Controllers of this wallet.
*
* @return User[]
*/
public function controllers()
{
return $this->belongsToMany(
'App\User', // The foreign object definition
'user_accounts', // The table name
'wallet_id', // The local foreign key
'user_id' // The remote foreign key
);
}
/**
* Entitlements billed to this wallet.
*
* @return Entitlement[]
*/
public function entitlements()
{
return $this->hasMany('App\Entitlement');
}
/**
* The owner of the wallet -- the wallet is in his/her back pocket.
*
* @return User
*/
public function owner()
{
return $this->belongsTo('App\User', 'user_id', 'id');
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Apr 24, 1:27 PM (9 h, 58 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
84/a8/851008fd65167c62dde02c4f9a8e
Default Alt Text
Wallet.php (2 KB)

Event Timeline