From 7d5cc45540d61417462f70eb7a4148cd3398fe54 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Thu, 21 Apr 2022 23:52:00 +0200 Subject: [PATCH] doc fixes --- Controller/ApiController.php | 26 ++++++++++++++++---------- Controller/BackendController.php | 32 ++++++++++++++++---------------- Models/BillElementMapper.php | 2 +- Models/BillMapper.php | 2 +- Models/SalesBillMapper.php | 1 + 5 files changed, 35 insertions(+), 28 deletions(-) diff --git a/Controller/ApiController.php b/Controller/ApiController.php index 5d80643..4a9ee6d 100755 --- a/Controller/ApiController.php +++ b/Controller/ApiController.php @@ -69,7 +69,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiBillUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiBillUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateBillUpdate($request))) { $response->set($request->uri->__toString(), new FormValidation($val)); @@ -78,7 +78,8 @@ final class ApiController extends Controller return; } - $old = clone BillMapper::get()->where('id', (int) $request->getData('bill')); + /** @var \Modules\Billing\Models\Bill $old */ + $old = BillMapper::get()->where('id', (int) $request->getData('bill')); $new = $this->updateBillFromRequest($request, $response, $data); $this->updateModel($request->header->account, $old, $new, BillMapper::class, 'bill', $request->getOrigin()); @@ -136,7 +137,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiBillCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiBillCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateBillCreate($request))) { $response->set($request->uri->__toString(), new FormValidation($val)); @@ -243,7 +244,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiMediaAddToBill(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiMediaAddToBill(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateMediaAddToBill($request))) { $response->set($request->uri->__toString(), new FormValidation($val)); @@ -252,6 +253,7 @@ final class ApiController extends Controller return; } + /** @var \Modules\Billing\Models\Bill $bill */ $bill = BillMapper::get()->where('id', (int) $request->getData('bill'))->execute(); $path = $this->createBillDir($bill); @@ -369,7 +371,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiBillElementCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiBillElementCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateBillElementCreate($request))) { $response->set($request->uri->__toString(), new FormValidation($val)); @@ -381,6 +383,7 @@ final class ApiController extends Controller $element = $this->createBillElementFromRequest($request, $response, $data); $this->createModel($request->header->account, $element, BillElementMapper::class, 'bill_element', $request->getOrigin()); + /** @var \Modules\Billing\Models\Bill $old */ $old = BillMapper::get()->where('id', $element->bill)->execute(); $new = $this->updateBillWithBillElement(clone $old, $element, 1); $this->updateModel($request->header->account, $old, $new, BillMapper::class, 'bill_element', $request->getOrigin()); @@ -410,6 +413,7 @@ final class ApiController extends Controller return $element; } + /** @var \Modules\ItemManagement\Models\Item $item */ $item = ItemMapper::get()->with('l11n')->where('id', $element->item)->where('l11n/language', $response->getLanguage())->execute(); $element->itemNumber = $item->number; $element->itemName = $item->getL11n('name1')->description; @@ -485,10 +489,11 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiBillPdfArchiveCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiBillPdfArchiveCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { Autoloader::addPath(__DIR__ . '/../../../Resources/'); + /** @var \Modules\Billing\Models\Bill $bill */ $bill = BillMapper::get() ->with('type') ->with('type/template') @@ -569,7 +574,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiBillPdfCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiBillPdfCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { } @@ -586,7 +591,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiNoteCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiNoteCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateNoteCreate($request))) { $response->set('bill_note_create', new FormValidation($val)); @@ -595,7 +600,7 @@ final class ApiController extends Controller return; } - /** @var Bill $bill */ + /** @var \Modules\Billing\Models\Bill $bill */ $bill = BillMapper::get()->where('id', (int) $request->getData('id'))->execute(); $request->setData('virtualpath', $this->createBillDir($bill), true); @@ -641,13 +646,14 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiSupplierBillUpload(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiSupplierBillUpload(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { $originalType = (int) ($request->getData('type') ?? $this->app->appSettings->get( names: SettingsEnum::ORIGINAL_MEDIA_TYPE, module: self::NAME )->content); + /** @var \Modules\Billing\Models\BillType $purchaseTransferType */ $purchaseTransferType = BillTypeMapper::get() ->where('transferType', BillTransferType::PURCHASE) ->limit(1) diff --git a/Controller/BackendController.php b/Controller/BackendController.php index cfe8eca..8914426 100755 --- a/Controller/BackendController.php +++ b/Controller/BackendController.php @@ -52,7 +52,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingSalesList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingSalesList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/sales-bill-list'); @@ -105,7 +105,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingSalesInvoice(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingSalesInvoice(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/sales-bill'); @@ -142,7 +142,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingSalesInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingSalesInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/invoice-create'); @@ -163,7 +163,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingPurchaseInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingPurchaseInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/invoice-create'); @@ -184,7 +184,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingStockInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingStockInvoiceCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/invoice-create'); @@ -205,7 +205,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingPurchaseList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingPurchaseList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/purchase-bill-list'); @@ -258,7 +258,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingPurchaseInvoice(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingPurchaseInvoice(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/purchase-bill'); @@ -302,7 +302,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingStockList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingStockList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/purchase-bill-list'); @@ -337,7 +337,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingStockInvoice(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingStockInvoice(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/purchase-bill'); @@ -362,7 +362,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewRegionAnalysis(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewRegionAnalysis(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $head = $response->get('Content')->getData('head'); $head->addAsset(AssetType::CSS, 'Resources/chartjs/Chartjs/chart.css'); @@ -562,7 +562,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillAnalysis(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillAnalysis(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $head = $response->get('Content')->getData('head'); $head->addAsset(AssetType::CSS, 'Resources/chartjs/Chartjs/chart.css'); @@ -588,7 +588,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewSalesRepAnalysis(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewSalesRepAnalysis(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $head = $response->get('Content')->getData('head'); $head->addAsset(AssetType::CSS, 'Resources/chartjs/Chartjs/chart.css'); @@ -670,7 +670,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewBillingPurchaseInvoiceUpload(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewBillingPurchaseInvoiceUpload(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/purchase-bill-upload'); @@ -691,7 +691,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewPrivatePurchaseBillUpload(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewPrivatePurchaseBillUpload(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/user-purchase-bill-upload'); @@ -712,7 +712,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewPrivatePurchaseBillDashboard(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewPrivatePurchaseBillDashboard(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/user-purchase-bill-dashboard'); @@ -763,7 +763,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewPrivateBillingPurchaseInvoice(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewPrivateBillingPurchaseInvoice(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/Billing/Theme/Backend/user-purchase-bill'); diff --git a/Models/BillElementMapper.php b/Models/BillElementMapper.php index 3c0f23c..0ace13c 100755 --- a/Models/BillElementMapper.php +++ b/Models/BillElementMapper.php @@ -66,7 +66,7 @@ final class BillElementMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/BillMapper.php b/Models/BillMapper.php index 371b5e4..304f14f 100755 --- a/Models/BillMapper.php +++ b/Models/BillMapper.php @@ -128,7 +128,7 @@ class BillMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/SalesBillMapper.php b/Models/SalesBillMapper.php index 6d76f0c..affd4d5 100755 --- a/Models/SalesBillMapper.php +++ b/Models/SalesBillMapper.php @@ -240,6 +240,7 @@ final class SalesBillMapper extends BillMapper ->limit($limit) ->groupBy(ClientMapper::TABLE . '_d1.clientmgmt_client_id'); + /** @var \Modules\ClientManagement\Models\Client[] $clients */ $clients = ClientMapper::getAll()->execute($query); $data = ClientMapper::getRaw()->execute();