Skip to content

Commit 16c52f4

Browse files
caothu159caothu159
committed
Merge pull request #142 from diepxuan/docs/stored-procedures-filt
docs: bổ sung documentation cho 3 file AsCAFilt* (Filter)
1 parent 202878c commit 16c52f4

10 files changed

Lines changed: 666 additions & 42 deletions

‎src/StoredProcedures/AsCACalLaiKU.php‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@
88
* @author Tran Ngoc Duc <ductn@diepxuan.com>
99
* @author Tran Ngoc Duc <caothu91@gmail.com>
1010
*
11-
* @lastupdate 2026-02-25 15:28:16
11+
* @lastupdate 2026-04-06 08:36:15
1212
*/
1313

1414
namespace Diepxuan\Simba\StoredProcedures;
1515

16+
use Diepxuan\Simba\Helper\ParamHelper;
1617
use Diepxuan\Simba\SModel\SModel;
1718
use Illuminate\Support\Collection;
18-
use Diepxuan\Simba\Helper\ParamHelper;
19+
1920
/**
2021
* Class AsCACalLaiKU.
2122
*
@@ -75,11 +76,11 @@ class AsCACalLaiKU
7576
*
7677
* @param array $params mảng tham số với các khóa tương ứng tên tham số (có thể có tiền tố '@' hoặc không)
7778
*
78-
* @return mixed kết quả trả về từ procedure (có thể chứa output parameter)
79+
* @return Collection kết quả từ procedure (chứa output parameter pRet)
7980
*/
8081
public static function call(array $params): Collection
8182
{
82-
$paramObj = ParamHelper::fromArray($params);
83+
$paramObj = ParamHelper::fromArray($params);
8384
$connection = (new SModel())->getConnectionName();
8485

8586
return ProcedureCaller::call('asCACalLaiKU', [
@@ -89,6 +90,37 @@ public static function call(array $params): Collection
8990
'pMa_ct' => $paramObj->pMa_ct ?? null,
9091
'pMa_ku' => $paramObj->pMa_ku ?? null,
9192
'pUser' => $paramObj->pUser ?? null,
93+
'pRet' => ['type' => 'INT', 'output' => true],
9294
], $connection);
9395
}
96+
97+
/**
98+
* Call stored procedure asCACalLaiKU with named parameters (helper method).
99+
*
100+
* @param null|string $Ma_cty Mã công ty
101+
* @param null|int $Thang Tháng tính lãi
102+
* @param null|int $Nam Năm tính lãi
103+
* @param null|string $Ma_ct Mã chứng từ
104+
* @param null|string $Ma_ku Mã khế ước
105+
* @param null|string $User Người dùng
106+
*
107+
* @return Collection Kết quả từ procedure
108+
*/
109+
public static function callWithParams(
110+
?string $Ma_cty = null,
111+
?int $Thang = null,
112+
?int $Nam = null,
113+
?string $Ma_ct = null,
114+
?string $Ma_ku = null,
115+
?string $User = null,
116+
): Collection {
117+
return self::call([
118+
'pMa_cty' => $Ma_cty,
119+
'pThang' => $Thang,
120+
'pNam' => $Nam,
121+
'pMa_ct' => $Ma_ct,
122+
'pMa_ku' => $Ma_ku,
123+
'pUser' => $User,
124+
]);
125+
}
94126
}

‎src/StoredProcedures/AsCARecalCA2.php‎

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,78 @@
88
* @author Tran Ngoc Duc <ductn@diepxuan.com>
99
* @author Tran Ngoc Duc <caothu91@gmail.com>
1010
*
11-
* @lastupdate 2026-02-12 13:15:00
11+
* @lastupdate 2026-04-06 08:36:15
1212
*/
1313

1414
namespace Diepxuan\Simba\StoredProcedures;
1515

16+
use Diepxuan\Simba\Helper\ParamHelper;
1617
use Diepxuan\Simba\SModel\SModel;
1718
use Illuminate\Support\Collection;
18-
use Diepxuan\Simba\Helper\ParamHelper;
1919

20+
/**
21+
* Class AsCARecalCA2.
22+
*
23+
* Stored procedure: asCARecalCA2
24+
* Mục đích: Tính toán lại chứng từ loại 2 (CA2 - Cost Accounting 2).
25+
* Procedure thực hiện tính toán lại các bút toán chi phí loại 2, cập nhật các số liệu phát sinh nợ/có vào bảng CaCt2.
26+
*
27+
* Tham số (theo định nghĩa thực tế trong SQL Server):
28+
* - @pMa_cty (nvarchar(3)): Mã công ty. Bắt buộc.
29+
* - @pStt_rec (nvarchar(20)): Số tham chiếu. Bắt buộc.
30+
* - @pLUser (nvarchar(20)): Người dùng thực hiện. Bắt buộc.
31+
* - @pRet (int, OUTPUT): Tham số đầu ra chứa mã lỗi (@@error).
32+
* - 0: Thành công.
33+
* - Khác 0: Mã lỗi SQL Server.
34+
*
35+
* Giá trị trả về:
36+
* - Procedure không trả về result set.
37+
* - Kết quả được trả về qua output parameter @pRet.
38+
*
39+
* Lưu ý:
40+
* - Output parameter @pRet được xử lý tự động bởi ProcedureCaller.
41+
*/
2042
class AsCARecalCA2
2143
{
44+
/**
45+
* Gọi stored procedure asCARecalCA2.
46+
*
47+
* @param array $params Mảng tham số với các khóa tương ứng tên tham số.
48+
* Các parameters có thể thiếu, sẽ dùng giá trị default.
49+
*
50+
* @return Collection kết quả từ procedure (chứa output parameter pRet)
51+
*/
2252
public static function call(array $params): Collection
2353
{
24-
$paramObj = ParamHelper::fromArray($params);
54+
$paramObj = ParamHelper::fromArray($params);
2555
$connection = (new SModel())->getConnectionName();
2656

2757
return ProcedureCaller::call('asCARecalCA2', [
28-
58+
'pMa_cty' => $paramObj->pMa_cty ?? null,
59+
'pStt_rec' => $paramObj->pStt_rec ?? null,
60+
'pLUser' => $paramObj->pLUser ?? null,
61+
'pRet' => ['type' => 'INT', 'output' => true],
2962
], $connection);
3063
}
64+
65+
/**
66+
* Call stored procedure asCARecalCA2 with named parameters (helper method).
67+
*
68+
* @param null|string $Ma_cty Mã công ty
69+
* @param null|string $Stt_rec Số tham chiếu
70+
* @param null|string $LUser Người dùng
71+
*
72+
* @return Collection Kết quả từ procedure
73+
*/
74+
public static function callWithParams(
75+
?string $Ma_cty = null,
76+
?string $Stt_rec = null,
77+
?string $LUser = null,
78+
): Collection {
79+
return self::call([
80+
'pMa_cty' => $Ma_cty,
81+
'pStt_rec' => $Stt_rec,
82+
'pLUser' => $LUser,
83+
]);
84+
}
3185
}

‎src/StoredProcedures/AsCARptTMNH01.php‎

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,60 @@
88
* @author Tran Ngoc Duc <ductn@diepxuan.com>
99
* @author Tran Ngoc Duc <caothu91@gmail.com>
1010
*
11-
* @lastupdate 2026-02-12 13:15:00
11+
* @lastupdate 2026-04-06 08:36:16
1212
*/
1313

1414
namespace Diepxuan\Simba\StoredProcedures;
1515

16+
use Diepxuan\Simba\Helper\ParamHelper;
1617
use Diepxuan\Simba\SModel\SModel;
1718
use Illuminate\Support\Collection;
18-
use Diepxuan\Simba\Helper\ParamHelper;
1919

20+
/**
21+
* Class AsCARptTMNH01.
22+
*
23+
* Stored procedure: asCARptTMNH01
24+
* Mục đích: Báo cáo lưu chuyển tiền tệ mẫu 01 (TMNH01).
25+
* Procedure thực hiện truy vấn và trả về báo cáo lưu chuyển tiền tệ theo tài khoản và khoảng thời gian.
26+
*
27+
* Tham số (theo định nghĩa thực tế trong SQL Server):
28+
* - @pMa_Cty (nvarchar(3)): Mã công ty. Default 'A01'.
29+
* - @pTk (nvarchar(20)): Tài khoản. Default '111'.
30+
* - @pNgay_Ct1 (smalldatetime): Từ ngày. Default '2015-10-01'.
31+
* - @pNgay_ct2 (smalldatetime): Đến ngày. Default '2015-10-31'.
32+
* - @pMa_Nt (nvarchar(3)): Mã ngoại tệ. Default ''.
33+
*
34+
* Giá trị trả về:
35+
* - Procedure trả về result set chứa dữ liệu báo cáo lưu chuyển tiền tệ.
36+
* - Không có output parameter pRet (procedure SELECT, không INSERT/UPDATE).
37+
*
38+
* Ví dụ gọi:
39+
* ```php
40+
* $result = AsCARptTMNH01::call([
41+
* 'pMa_Cty' => '001',
42+
* 'pTk' => '111',
43+
* 'pNgay_Ct1' => '2026-01-01',
44+
* 'pNgay_ct2' => '2026-01-31',
45+
* 'pMa_Nt' => 'VND',
46+
* ]);
47+
* ```
48+
*
49+
* Lưu ý:
50+
* - Procedure chỉ thực hiện SELECT, không thay đổi dữ liệu.
51+
*/
2052
class AsCARptTMNH01
2153
{
54+
/**
55+
* Gọi stored procedure asCARptTMNH01.
56+
*
57+
* @param array $params Mảng tham số với các khóa tương ứng tên tham số.
58+
* Các parameters có thể thiếu, sẽ dùng giá trị default.
59+
*
60+
* @return Collection kết quả từ procedure (dữ liệu báo cáo)
61+
*/
2262
public static function call(array $params): Collection
2363
{
24-
$paramObj = ParamHelper::fromArray($params);
64+
$paramObj = ParamHelper::fromArray($params);
2565
$connection = (new SModel())->getConnectionName();
2666

2767
return ProcedureCaller::call('asCARptTMNH01', [
@@ -32,4 +72,31 @@ public static function call(array $params): Collection
3272
'pMa_Nt' => $paramObj->pMa_Nt ?? '',
3373
], $connection);
3474
}
75+
76+
/**
77+
* Call stored procedure asCARptTMNH01 with named parameters (helper method).
78+
*
79+
* @param null|string $Ma_Cty Mã công ty
80+
* @param null|string $Tk Tài khoản
81+
* @param null|string $Ngay_Ct1 Từ ngày
82+
* @param null|string $Ngay_ct2 Đến ngày
83+
* @param null|string $Ma_Nt Mã ngoại tệ
84+
*
85+
* @return Collection Kết quả từ procedure
86+
*/
87+
public static function callWithParams(
88+
?string $Ma_Cty = null,
89+
?string $Tk = null,
90+
?string $Ngay_Ct1 = null,
91+
?string $Ngay_ct2 = null,
92+
?string $Ma_Nt = null,
93+
): Collection {
94+
return self::call([
95+
'pMa_Cty' => $Ma_Cty,
96+
'pTk' => $Tk,
97+
'pNgay_Ct1' => $Ngay_Ct1,
98+
'pNgay_ct2' => $Ngay_ct2,
99+
'pMa_Nt' => $Ma_Nt,
100+
]);
101+
}
35102
}

‎src/StoredProcedures/AsCARptTMNH02.php‎

Lines changed: 75 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,95 @@
88
* @author Tran Ngoc Duc <ductn@diepxuan.com>
99
* @author Tran Ngoc Duc <caothu91@gmail.com>
1010
*
11-
* @lastupdate 2026-02-12 13:15:00
11+
* @lastupdate 2026-04-06 08:36:17
1212
*/
1313

1414
namespace Diepxuan\Simba\StoredProcedures;
1515

16+
use Diepxuan\Simba\Helper\ParamHelper;
1617
use Diepxuan\Simba\SModel\SModel;
1718
use Illuminate\Support\Collection;
18-
use Diepxuan\Simba\Helper\ParamHelper;
1919

20+
/**
21+
* Class AsCARptTMNH02.
22+
*
23+
* Stored procedure: asCARptTMNH02
24+
* Mục đích: Báo cáo lưu chuyển tiền tệ mẫu 02 (TMNH02).
25+
* Procedure thực hiện truy vấn và trả về báo cáo lưu chuyển tiền tệ theo tài khoản và khoảng thời gian.
26+
*
27+
* Tham số (theo định nghĩa thực tế trong SQL Server):
28+
* - @pMa_Cty (nvarchar(3)): Mã công ty. Default 'A01'.
29+
* - @pTk (nvarchar(20)): Tài khoản. Default '112'.
30+
* - @pNgay_Ct1 (smalldatetime): Từ ngày. Default '2015-10-01'.
31+
* - @pNgay_ct2 (smalldatetime): Đến ngày. Default '2015-10-31'.
32+
* - @pMa_Nt (nvarchar(3)): Mã ngoại tệ. Default ''.
33+
*
34+
* Giá trị trả về:
35+
* - Procedure trả về result set chứa dữ liệu báo cáo lưu chuyển tiền tệ.
36+
* - Không có output parameter pRet (procedure SELECT, không INSERT/UPDATE).
37+
*
38+
* Ví dụ gọi:
39+
* ```php
40+
* $result = AsCARptTMNH02::call([
41+
* 'pMa_Cty' => '001',
42+
* 'pTk' => '112',
43+
* 'pNgay_Ct1' => '2026-01-01',
44+
* 'pNgay_ct2' => '2026-01-31',
45+
* 'pMa_Nt' => 'VND',
46+
* ]);
47+
* ```
48+
*
49+
* Lưu ý:
50+
* - Procedure chỉ thực hiện SELECT, không thay đổi dữ liệu.
51+
*/
2052
class AsCARptTMNH02
2153
{
54+
/**
55+
* Gọi stored procedure asCARptTMNH02.
56+
*
57+
* @param array $params Mảng tham số với các khóa tương ứng tên tham số.
58+
* Các parameters có thể thiếu, sẽ dùng giá trị default.
59+
*
60+
* @return Collection kết quả từ procedure (dữ liệu báo cáo)
61+
*/
2262
public static function call(array $params): Collection
2363
{
24-
$paramObj = ParamHelper::fromArray($params);
64+
$paramObj = ParamHelper::fromArray($params);
2565
$connection = (new SModel())->getConnectionName();
2666

2767
return ProcedureCaller::call('asCARptTMNH02', [
28-
68+
'pMa_Cty' => $paramObj->pMa_Cty ?? SModel::CTY,
69+
'pTk' => $paramObj->pTk ?? '112',
70+
'pNgay_Ct1' => $paramObj->pNgay_Ct1 ?? '2015-10-01',
71+
'pNgay_ct2' => $paramObj->pNgay_ct2 ?? '2015-10-31',
72+
'pMa_Nt' => $paramObj->pMa_Nt ?? '',
2973
], $connection);
3074
}
75+
76+
/**
77+
* Call stored procedure asCARptTMNH02 with named parameters (helper method).
78+
*
79+
* @param null|string $Ma_Cty Mã công ty
80+
* @param null|string $Tk Tài khoản
81+
* @param null|string $Ngay_Ct1 Từ ngày
82+
* @param null|string $Ngay_ct2 Đến ngày
83+
* @param null|string $Ma_Nt Mã ngoại tệ
84+
*
85+
* @return Collection Kết quả từ procedure
86+
*/
87+
public static function callWithParams(
88+
?string $Ma_Cty = null,
89+
?string $Tk = null,
90+
?string $Ngay_Ct1 = null,
91+
?string $Ngay_ct2 = null,
92+
?string $Ma_Nt = null,
93+
): Collection {
94+
return self::call([
95+
'pMa_Cty' => $Ma_Cty,
96+
'pTk' => $Tk,
97+
'pNgay_Ct1' => $Ngay_Ct1,
98+
'pNgay_ct2' => $Ngay_ct2,
99+
'pMa_Nt' => $Ma_Nt,
100+
]);
101+
}
31102
}

0 commit comments

Comments
 (0)