Files
opensourcepos/app/Models/Item_quantity.php
objecttothis 0e361107ca Explicitly define variables
Signed-off-by: objecttothis <objecttothis@gmail.com>
2024-10-01 00:47:03 +02:00

125 lines
3.3 KiB
PHP

<?php
namespace App\Models;
use CodeIgniter\Model;
use stdClass;
/**
* Item_quantity class
*/
class Item_quantity extends Model
{
protected $table = 'item_quantities';
protected $primaryKey = 'item_id';
protected $useAutoIncrement = false;
protected $useSoftDeletes = false;
protected $allowedFields = [
'quantity'
];
protected $item_id;
protected $location_id;
protected $quantity;
/**
* @param int $item_id
* @param int $location_id
* @return bool
*/
public function exists(int $item_id, int $location_id): bool
{
$builder = $this->db->table('item_quantities');
$builder->where('item_id', $item_id);
$builder->where('location_id', $location_id);
return ($builder->get()->getNumRows() == 1); //TODO: ===
}
/**
* @param array $location_detail
* @param int $item_id
* @param int $location_id
* @return bool
*/
public function save_value(array $location_detail, int $item_id, int $location_id): bool
{
if(!$this->exists($item_id, $location_id))
{
$builder = $this->db->table('item_quantities');
return $builder->insert($location_detail);
}
$builder = $this->db->table('item_quantities');
$builder->where('item_id', $item_id);
$builder->where('location_id', $location_id);
return $builder->update($location_detail);
}
/**
* @param int $item_id
* @param int $location_id
* @return array|Item_quantity|stdClass|null
*/
public function get_item_quantity(int $item_id, int $location_id): array|Item_quantity|StdClass|null
{
$builder = $this->db->table('item_quantities');
$builder->where('item_id', $item_id);
$builder->where('location_id', $location_id);
$result = $builder->get()->getRow();
if(empty($result))
{
//Get empty base parent object, as $item_id is NOT an item
$result = model(Item_quantity::class);
//Get all the fields from items table (TODO: to be reviewed)
foreach($this->db->getFieldNames('item_quantities') as $field)
{
$result->$field = '';
}
$result->quantity = 0;
}
return $result;
}
/**
* changes to quantity of an item according to the given amount.
* if $quantity_change is negative, it will be subtracted,
* if it is positive, it will be added to the current quantity
*/
public function change_quantity(int $item_id, int $location_id, int $quantity_change): bool
{
$quantity_old = $this->get_item_quantity($item_id, $location_id);
$quantity_new = $quantity_old->quantity + $quantity_change;
$location_detail = ['item_id' => $item_id, 'location_id' => $location_id, 'quantity' => $quantity_new];
return $this->save_value($location_detail, $item_id, $location_id);
}
/**
* Set to 0 all quantity in the given item
*/
public function reset_quantity(int $item_id): bool
{
$builder = $this->db->table('item_quantities');
$builder->where('item_id', $item_id);
return $builder->update(['quantity' => 0]);
}
/**
* Set to 0 all quantity in the given list of items
*/
public function reset_quantity_list(array $item_ids): bool
{
$builder = $this->db->table('item_quantities');
$builder->whereIn('item_id', $item_ids);
return $builder->update(['quantity' => 0]);
}
}