mirror/opensourcepos
1
0
Fork 0
mirror of https://github.com/opensourcepos/opensourcepos.git synced 2026-07-25 22:27:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

refactor(models): rename snake_case methods to camelCase per PSR-12

Browse Source 
Rename get_info, get_sale_items, get_sale_payments across Item, Sale
models and all call sites in controllers, libraries, and tests.

Signed-off-by: Travis Garrison <travis@chiraqbookstore.com>
This commit is contained in:
Travis Garrison
2026-07-07 16:26:06 +04:00
parent dd55e44e93
commit 9aec82927c
9 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/Controllers/Item_kits.php
View File

@@ -30,14 +30,14 @@ class Item_kits extends Secure_Controller
*/
private function _add_totals_to_item_kit(object $item_kit): object // TODO: Hungarian notation
{
$kit_item_info = $this->item->get_info($item_kit->kit_item_id ?? $item_kit->item_id);
$kit_item_info = $this->item->getInfo($item_kit->kit_item_id ?? $item_kit->item_id);
$item_kit->total_cost_price = 0;
$item_kit->total_unit_price = $kit_item_info->unit_price;
$total_quantity = 0;
foreach ($this->item_kit_items->get_info($item_kit->item_kit_id) as $item_kit_item) {
$item_info = $this->item->get_info($item_kit_item['item_id']);
$item_info = $this->item->getInfo($item_kit_item['item_id']);
foreach (get_object_vars($item_info) as $property => $value) {
$item_info->$property = $value;
}
@@ -142,7 +142,7 @@ class Item_kits extends Secure_Controller
foreach ($this->item_kit_items->get_info($item_kit_id) as $item_kit_item) {
$item['kit_sequence'] = $item_kit_item['kit_sequence'];
$item['name'] = $this->item->get_info($item_kit_item['item_id'])->name;
$item['name'] = $this->item->getInfo($item_kit_item['item_id'])->name;
$item['item_id'] = $item_kit_item['item_id'];
$item['quantity'] = $item_kit_item['quantity'];

10
app/Controllers/Items.php
View File

@@ -311,7 +311,7 @@ class Items extends Secure_Controller
unset($data['definition_names'][$definition_id]);
}
$item_info = $this->item->get_info($item_id);
$item_info = $this->item->getInfo($item_id);
$data['allow_temp_item'] = ($data['allow_temp_item'] === 1 && $item_id !== NEW_ENTRY && $item_info->item_type != ITEM_TEMP) ? 0 : 1;
@@ -417,7 +417,7 @@ class Items extends Secure_Controller
$data['selected_low_sell_item_id'] = $item_info->low_sell_item_id;
if ($item_id !== NEW_ENTRY && $item_info->item_id !== $item_info->low_sell_item_id) {
$low_sell_item_info = $this->item->get_info($item_info->low_sell_item_id);
$low_sell_item_info = $this->item->getInfo($item_info->low_sell_item_id);
$data['selected_low_sell_item'] = implode(NAME_SEPARATOR, [$low_sell_item_info->name, $low_sell_item_info->pack_name]);
} else {
$data['selected_low_sell_item'] = '';
@@ -435,7 +435,7 @@ class Items extends Secure_Controller
*/
public function getInventory(int $item_id = NEW_ENTRY): string
{
$item_info = $this->item->get_info($item_id); // TODO: Duplicate code
$item_info = $this->item->getInfo($item_id); // TODO: Duplicate code
foreach (get_object_vars($item_info) as $property => $value) {
$item_info->$property = $value;
@@ -462,7 +462,7 @@ class Items extends Secure_Controller
*/
public function getCountDetails(int $item_id = NEW_ENTRY): string
{
$item_info = $this->item->get_info($item_id); // TODO: Duplicate code
$item_info = $this->item->getInfo($item_id); // TODO: Duplicate code
foreach (get_object_vars($item_info) as $property => $value) {
$item_info->$property = $value;
@@ -857,7 +857,7 @@ class Items extends Secure_Controller
public function postSaveInventory($item_id = NEW_ENTRY): ResponseInterface
{
$employee_id = $this->employee->get_logged_in_employee_info()->person_id;
$cur_item_info = $this->item->get_info($item_id);
$cur_item_info = $this->item->getInfo($item_id);
$location_id = $this->request->getPost('stock_location');
$new_quantity = $this->request->getPost('newquantity');
$inv_data = [

10
app/Controllers/Sales.php
View File

@@ -131,7 +131,7 @@ class Sales extends Secure_Controller
*/
public function getRow(int $row_id): ResponseInterface
{
$sale_info = $this->sale->get_info($row_id)->getRow();
$sale_info = $this->sale->getInfo($row_id)->getRow();
$data_row = get_sale_data_row($sale_info);
return $this->response->setJSON($data_row);
@@ -1088,7 +1088,7 @@ class Sales extends Secure_Controller
$cash_rounding = $this->sale_lib->reset_cash_rounding();
$data['cash_rounding'] = $cash_rounding;
$sale_info = $this->sale->get_info($sale_id)->getRowArray();
$sale_info = $this->sale->getInfo($sale_id)->getRowArray();
$this->sale_lib->copy_entire_sale($sale_id);
$data = [];
$data['cart'] = $this->sale_lib->get_cart();
@@ -1339,7 +1339,7 @@ class Sales extends Secure_Controller
{
$data = [];
$sale_info = $this->sale->get_info($sale_id)->getRowArray();
$sale_info = $this->sale->getInfo($sale_id)->getRowArray();
$data['selected_customer_id'] = $sale_info['customer_id'];
$data['selected_customer_name'] = $sale_info['customer_name'];
$employee_info = $this->employee->getInfo($sale_info['employee_id']);
@@ -1354,7 +1354,7 @@ class Sales extends Secure_Controller
$data['payments'] = [];
foreach ($this->sale->get_sale_payments($sale_id)->getResult() as $payment) {
foreach ($this->sale->getSalePayments($sale_id)->getResult() as $payment) {
foreach (get_object_vars($payment) as $property => $value) {
$payment->$property = $value;
}
@@ -1506,7 +1506,7 @@ class Sales extends Secure_Controller
} else {
$cash_adjustment = CASH_ADJUSTMENT_FALSE;
$amount_tendered += $payment_amount;
$sale_info = $this->sale->get_info($sale_id)->getRowArray();
$sale_info = $this->sale->getInfo($sale_id)->getRowArray();
if ($amount_tendered > $sale_info['amount_due']) {
$cash_refund = $amount_tendered - $sale_info['amount_due'];

2
app/Libraries/Receiving_lib.php
View File

@@ -297,7 +297,7 @@ class Receiving_lib
}
$insertKey = $maxKey + 1;
$itemInfo = $this->item->get_info((int) $itemId);
$itemInfo = $this->item->getInfo((int) $itemId);
$price = $price != null ? $price : $itemInfo->cost_price;

4
app/Libraries/Sale_lib.php
View File

@@ -1368,7 +1368,7 @@ class Sale_lib
// Establish cash_mode for this sale by inspecting the payments
if ($this->session->get('cash_rounding')) {
$cash_types_only = true;
foreach ($this->sale->get_sale_payments($sale_id)->getResult() as $row) {
foreach ($this->sale->getSalePayments($sale_id)->getResult() as $row) {
if ($row->payment_type != lang('Sales.cash') && $row->payment_type != lang('Sales.cash_adjustment')) {
$cash_types_only = false;
}
@@ -1385,7 +1385,7 @@ class Sale_lib
}
// Now load payments
foreach ($this->sale->get_sale_payments($sale_id)->getResult() as $row) {
foreach ($this->sale->getSalePayments($sale_id)->getResult() as $row) {
$this->add_payment($row->payment_type, $row->payment_amount, $row->cash_adjustment);
}

4
app/Models/Item.php
View File

@@ -329,7 +329,7 @@ class Item extends Model
/**
* Gets information about a particular item
*/
public function get_info(int $item_id): object
public function getInfo(int $item_id): object
{
$builder = $this->db->table('items');
$builder->select('items.*');
@@ -1096,7 +1096,7 @@ class Item extends Model
public function change_cost_price(int $item_id, float $items_received, float $new_price, ?float $old_price = null): bool
{
if ($old_price === null) {
$item_info = $this->get_info($item_id);
$item_info = $this->getInfo($item_id);
$old_price = $item_info->cost_price;
}

2
app/Models/Receiving.php
View File

@@ -132,7 +132,7 @@ class Receiving extends Model
foreach ($items as $line => $item_data) {
$config = config(OSPOS::class)->settings;
$cur_item_info = $item->get_info($item_data['item_id']);
$cur_item_info = $item->getInfo($item_data['item_id']);
$receivings_items_data = [
'receiving_id' => $receiving_id,

12
app/Models/Sale.php
View File

@@ -40,7 +40,7 @@ class Sale extends Model
/**
* Get sale info
*/
public function get_info(int $sale_id): ResultInterface
public function getInfo(int $sale_id): ResultInterface
{
$config = config(OSPOS::class)->settings;
$this->create_temp_table(['sale_id' => $sale_id]);
@@ -608,7 +608,7 @@ class Sale extends Model
$customer = $customer->getInfo($customer_id);
foreach ($items as $line => $item_data) {
$cur_item_info = $item->get_info($item_data['item_id']);
$cur_item_info = $item->getInfo($item_data['item_id']);
if ($item_data['price'] == 0.00) {
$item_data['discount'] = 0.00;
@@ -806,10 +806,10 @@ class Sale extends Model
$item = model(Item::class);
$item_quantity = model(Item_quantity::class);
$items = $this->get_sale_items($sale_id)->getResultArray();
$items = $this->getSaleItems($sale_id)->getResultArray();
foreach ($items as $item_data) {
$cur_item_info = $item->get_info($item_data['item_id']);
$cur_item_info = $item->getInfo($item_data['item_id']);
if ($cur_item_info->stock_type == HAS_STOCK) {
// Create query to update inventory tracking
@@ -841,7 +841,7 @@ class Sale extends Model
/**
* Gets sale item
*/
public function get_sale_items(int $sale_id): ResultInterface
public function getSaleItems(int $sale_id): ResultInterface
{
$builder = $this->db->table('sales_items');
$builder->where('sale_id', $sale_id);
@@ -907,7 +907,7 @@ class Sale extends Model
/**
* Gets sale payments
*/
public function get_sale_payments(int $sale_id): ResultInterface
public function getSalePayments(int $sale_id): ResultInterface
{
$builder = $this->db->table('sales_payments');
$builder->where('sale_id', $sale_id);

14
tests/Controllers/ItemsCsvImportTest.php
View File

@@ -248,7 +248,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertIsInt((int) $row->item_id);
$this->assertGreaterThan(0, (int) $row->item_id);
$savedItem = $this->item->get_info((int) $row->item_id);
$savedItem = $this->item->getInfo((int) $row->item_id);
$this->assertEquals('CSV Imported Item', $savedItem->name);
$this->assertEquals('Description from CSV', $savedItem->description);
$this->assertEquals('Electronics', $savedItem->category);
@@ -445,7 +445,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertTrue($this->item->save_value($updatedData, $updatedData['item_id']));
$updatedItem = $this->item->get_info($updatedData['item_id']);
$updatedItem = $this->item->getInfo($updatedData['item_id']);
$this->assertEquals('Updated Name', $updatedItem->name);
$this->assertEquals('Updated Category', $updatedItem->category);
$this->assertEquals(15.00, (float)$updatedItem->cost_price);
@@ -635,7 +635,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertTrue($this->item->save_value($itemData));
$savedItem = $this->item->get_info($itemData['item_id']);
$savedItem = $this->item->getInfo($itemData['item_id']);
$this->assertEquals(-1, (int)$savedItem->reorder_level);
}
@@ -674,7 +674,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertTrue($this->item->save_value($itemData));
$savedItem = $this->item->get_info($itemData['item_id']);
$savedItem = $this->item->getInfo($itemData['item_id']);
$this->assertSame(
$case['expected_cost_price'],
@@ -704,7 +704,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertTrue($this->item->save_value($itemData));
$savedItem = $this->item->get_info($itemData['item_id']);
$savedItem = $this->item->getInfo($itemData['item_id']);
$this->assertEquals('8471', $savedItem->hsn_code);
}
@@ -797,7 +797,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
$this->assertIsInt($itemData['item_id']);
$this->assertGreaterThan(0, $itemData['item_id']);
$savedItem = $this->item->get_info($itemData['item_id']);
$savedItem = $this->item->getInfo($itemData['item_id']);
$this->assertEquals('Item Without Barcode', $savedItem->name);
}
@@ -891,7 +891,7 @@ class ItemsCsvImportTest extends CIUnitTestCase
];
$this->inventory->insert($inventoryData);
$savedItem = $this->item->get_info($itemData['item_id']);
$savedItem = $this->item->getInfo($itemData['item_id']);
$this->assertEquals('Complete Test Item', $savedItem->name);
$this->assertEquals('Electronics', $savedItem->category);
$this->assertEquals(50.00, (float)$savedItem->cost_price);