From 70d6e0abb16c26301053d5c09c6752fd81a9c565 Mon Sep 17 00:00:00 2001 From: Julian Hyatt <54834203+julianzimmermann@users.noreply.github.com> Date: Tue, 24 Sep 2024 15:36:11 +0200 Subject: [PATCH] add erp order cancellation base (#276) * add ERP Order Cancellation Bundle * add erp order cancellation api (#275) --- .github/workflows/main.yml | 35 +++ .gitignore | 8 + LICENSE | 9 + Makefile | 30 +++ codeception.yml | 43 +++ composer.json | 42 +++ phpstan.neon | 10 + .../erp_order_cancellation_api.transfer.xml | 14 + ...ErpOrderCancellationApiBusinessFactory.php | 55 ++++ .../ErpOrderCancellationApiFacade.php | 113 ++++++++ ...ErpOrderCancellationApiFacadeInterface.php | 66 +++++ .../Model/ErpOrderCancellationApi.php | 254 ++++++++++++++++++ .../ErpOrderCancellationApiInterface.php | 49 ++++ .../ErpOrderCancellationApiValidator.php | 18 ++ ...OrderCancellationApiValidatorInterface.php | 15 ++ .../ErpOrderCancellationApiResourcePlugin.php | 77 ++++++ ...ErpOrderCancellationApiValidatorPlugin.php | 33 +++ ...pOrderCancellationApiToApiFacadeBridge.php | 45 ++++ ...derCancellationApiToApiFacadeInterface.php | 25 ++ ...nApiToErpOrderCancellationFacadeBridge.php | 63 +++++ ...iToErpOrderCancellationFacadeInterface.php | 37 +++ ...iToApiQueryBuilderQueryContainerBridge.php | 48 ++++ ...ApiQueryBuilderQueryContainerInterface.php | 30 +++ .../ErpOrderCancellationApiConfig.php | 13 + ...OrderCancellationApiDependencyProvider.php | 130 +++++++++ ...OrderCancellationApiPersistenceFactory.php | 42 +++ .../ErpOrderCancellationApiRepository.php | 137 ++++++++++ ...rderCancellationApiRepositoryInterface.php | 16 ++ tests/_bootstrap.php | 17 ++ tests/_data/.gitkeep | 0 tests/_output/.gitignore | 2 + tests/_support/.gitkeep | 0 32 files changed, 1476 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 codeception.yml create mode 100644 composer.json create mode 100644 phpstan.neon create mode 100644 src/FondOfImpala/Shared/ErpOrderCancellationApi/Transfer/erp_order_cancellation_api.transfer.xml create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiBusinessFactory.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacade.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacadeInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApi.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApiInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Validator/ErpOrderCancellationApiValidator.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Validator/ErpOrderCancellationApiValidatorInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiResourcePlugin.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiValidatorPlugin.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeBridge.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeBridge.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/QueryContainer/ErpOrderCancellationApiToApiQueryBuilderQueryContainerBridge.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/QueryContainer/ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/ErpOrderCancellationApiConfig.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/ErpOrderCancellationApiDependencyProvider.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiPersistenceFactory.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepository.php create mode 100644 src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepositoryInterface.php create mode 100644 tests/_bootstrap.php create mode 100644 tests/_data/.gitkeep create mode 100644 tests/_output/.gitignore create mode 100644 tests/_support/.gitkeep diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..e5494ea --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,35 @@ +name: CI + +on: + push: + branches: [ main ] + +jobs: + continous-integration: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + php-versions: [ "8.1", "8.2", "8.3" ] + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup PHP, with composer and extensions + uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php + with: + php-version: ${{ matrix.php-versions }} + extensions: mbstring, dom, fileinfo, pgsql, json + coverage: xdebug #optional + - name: Get composer cache directory + id: composercache + run: echo "::set-output name=dir::$(composer config cache-files-dir)" + - name: Cache composer dependencies + uses: actions/cache@v2 + with: + path: ${{ steps.composercache.outputs.dir }} + # Use composer.json for key, if composer.lock is not committed. + # key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }} + key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} + restore-keys: ${{ runner.os }}-composer- + - name: Install dependencies and run ci tasks + run: make install ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d46af7d --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.idea +.DS_Store + +src/Generated +src/Orm +vendor + +composer.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..32464b1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright (c) 2024-present FOND OF GmbH + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..401e5de --- /dev/null +++ b/Makefile @@ -0,0 +1,30 @@ +.PHONY: install +install: + composer install + +.PHONY: phpcs +phpcs: + ./vendor/bin/phpcs --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfImpala/* ./tests/* + +.PHONY: phpcbf +phpcbf: + ./vendor/bin/phpcbf --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfImpala/* ./tests/* + +.PHONY: phpstan +phpstan: + ./vendor/bin/phpstan --memory-limit=-1 analyse ./src/FondOfImpala ./tests + +.PHONY: codeception +codeception: + ./vendor/bin/codecept run --env standalone + +.PHONY: ci +ci: phpcs codeception phpstan + +.PHONY: clean +clean: + rm -Rf composer.lock + rm -Rf ./vendor + find ./tests/_output/ -not -name .gitignore -not -name .gitkeep -delete + rm -Rf src/Generated/* + rm -Rf src/Orm/* diff --git a/codeception.yml b/codeception.yml new file mode 100644 index 0000000..17dcfab --- /dev/null +++ b/codeception.yml @@ -0,0 +1,43 @@ +namespace: fond-of-impala/erp-order-cancellation-api + +suites: + unit: + path: . + +settings: + shuffle: true + lint: true + +bootstrap: _bootstrap.php + +paths: + tests: tests + output: tests/_output + support: tests/_support + data: tests/_data + +coverage: + enabled: true + include: + - src/*.php + +modules: + enabled: + - \FondOfCodeception\Module\Spryker + config: + \FondOfCodeception\Module\Spryker: + generate_transfer: false + generate_map_classes: false + generate_propel_classes: false + generate_ide_auto_completion: false + +env: + standalone: + modules: + config: + \FondOfCodeception\Module\Spryker: + generate_transfer: true + generate_map_classes: true + generate_propel_classes: true + generate_ide_auto_completion: true + monorepo: diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..88d6ccb --- /dev/null +++ b/composer.json @@ -0,0 +1,42 @@ +{ + "name": "fond-of-impala/erp-order-cancellation-api", + "description": "Erp order cancellation api module.", + "license": "MIT", + "authors": [ + { + "name": "Julian Hyatt", + "email": "dev@jzit.de" + } + ], + "require": { + "php": ">=8.1", + "fond-of-impala/erp-order-cancellation": "^1.0.0", + "spryker/api": "^0.4.0", + "spryker/api-extension": "^0.1.0", + "spryker/api-query-builder": "^0.1.0" + }, + "require-dev": { + "fond-of-codeception/spryker": "*", + "spryker/code-sniffer": "*", + "spryker-sdk/phpstan-spryker": "*" + }, + "minimum-stability": "dev", + "prefer-stable": true, + "autoload": { + "psr-4": { + "FondOfImpala\\": "src/FondOfImpala/" + } + }, + "autoload-dev": { + "psr-4": { + "FondOfImpala\\": "tests/FondOfImpala/", + "Generated\\": "src/Generated/", + "Orm\\": "src/Orm/" + } + }, + "config": { + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true + } + } +} diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..d356f6f --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,10 @@ +parameters: + level: 5 + reportUnmatchedIgnoredErrors: false + scanDirectories: + - src/Orm/Zed + ignoreErrors: + - '#.* on an unknown class Generated\\(Client|Glue|Service|Yves|Zed)\\.*#' + - '#Dead catch - Exception is never thrown in the try block.#' + - + message: '#Strict comparison using === between int and null will always evaluate to false.#' diff --git a/src/FondOfImpala/Shared/ErpOrderCancellationApi/Transfer/erp_order_cancellation_api.transfer.xml b/src/FondOfImpala/Shared/ErpOrderCancellationApi/Transfer/erp_order_cancellation_api.transfer.xml new file mode 100644 index 0000000..a738962 --- /dev/null +++ b/src/FondOfImpala/Shared/ErpOrderCancellationApi/Transfer/erp_order_cancellation_api.transfer.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiBusinessFactory.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiBusinessFactory.php new file mode 100644 index 0000000..408a4d1 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiBusinessFactory.php @@ -0,0 +1,55 @@ +getApiFacade(), + $this->getErpOrderCancellationFacade(), + $this->getRepository(), + ); + } + + /** + * @return \FondOfImpala\Zed\ErpOrderCancellationApi\Dependency\Facade\ErpOrderCancellationApiToApiFacadeInterface + */ + protected function getApiFacade(): ErpOrderCancellationApiToApiFacadeInterface + { + return $this->getProvidedDependency(ErpOrderCancellationApiDependencyProvider::FACADE_API); + } + + /** + * @return \FondOfImpala\Zed\ErpOrderCancellationApi\Dependency\Facade\ErpOrderCancellationApiToErpOrderCancellationFacadeInterface + */ + protected function getErpOrderCancellationFacade(): ErpOrderCancellationApiToErpOrderCancellationFacadeInterface + { + return $this->getProvidedDependency(ErpOrderCancellationApiDependencyProvider::FACADE_ERP_ORDER_CANCELLATION); + } + + /** + * @return \FondOfImpala\Zed\ErpOrderCancellationApi\Business\Validator\ErpOrderCancellationApiValidatorInterface + */ + public function createErpOrderCancellationApiValidator(): ErpOrderCancellationApiValidatorInterface + { + return new ErpOrderCancellationApiValidator(); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacade.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacade.php new file mode 100644 index 0000000..8cd532a --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacade.php @@ -0,0 +1,113 @@ +getFactory() + ->createErpOrderCancellationApi() + ->create($apiDataTransfer); + } + + /** + * {@inheritDoc} + * + * @api + * + * @param int $idErpOrderCancellation + * @param \Generated\Shared\Transfer\ApiDataTransfer $apiDataTransfer + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function updateErpOrderCancellation(int $idErpOrderCancellation, ApiDataTransfer $apiDataTransfer): ApiItemTransfer + { + return $this->getFactory() + ->createErpOrderCancellationApi() + ->update($idErpOrderCancellation, $apiDataTransfer); + } + + /** + * {@inheritDoc} + * + * @api + * + * @param int $idErpOrderCancellation + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function getErpOrderCancellation(int $idErpOrderCancellation): ApiItemTransfer + { + return $this->getFactory() + ->createErpOrderCancellationApi() + ->get($idErpOrderCancellation); + } + + /** + * {@inheritDoc} + * + * @api + * + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + public function findErpOrderCancellations(ApiRequestTransfer $apiRequestTransfer): ApiCollectionTransfer + { + return $this->getFactory() + ->createErpOrderCancellationApi() + ->find($apiRequestTransfer); + } + + /** + * {@inheritDoc} + * + * @api + * + * @param int $idErpOrderCancellation + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function deleteErpOrderCancellation(int $idErpOrderCancellation): ApiItemTransfer + { + return $this->getFactory() + ->createErpOrderCancellationApi() + ->delete($idErpOrderCancellation); + } + + /** + * {@inheritDoc} + * + * @api + * + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return array<\Generated\Shared\Transfer\ApiValidationErrorTransfer> + */ + public function validateErpOrderCancellation(ApiRequestTransfer $apiRequestTransfer): array + { + return $this->getFactory() + ->createErpOrderCancellationApiValidator() + ->validate($apiRequestTransfer); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacadeInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacadeInterface.php new file mode 100644 index 0000000..ffa203b --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/ErpOrderCancellationApiFacadeInterface.php @@ -0,0 +1,66 @@ + + */ + public function validateErpOrderCancellation(ApiRequestTransfer $apiRequestTransfer): array; +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApi.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApi.php new file mode 100644 index 0000000..8579a7b --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApi.php @@ -0,0 +1,254 @@ +apiFacade = $apiFacade; + $this->erpOrderCancellationFacade = $erpOrderCancellationFacade; + $this->repository = $repository; + } + + /** + * @param \Generated\Shared\Transfer\ApiDataTransfer $apiDataTransfer + * + * @throws \Spryker\Zed\Api\Business\Exception\EntityNotSavedException + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function create(ApiDataTransfer $apiDataTransfer): ApiItemTransfer + { + $erpOrderCancellationTransfer = (new ErpOrderCancellationTransfer())->fromArray($apiDataTransfer->getData(), true); + $erpOrderCancellationResponseTransfer = $this->erpOrderCancellationFacade->createErpOrderCancellation($erpOrderCancellationTransfer); + $erpOrderCancellationTransfer = $erpOrderCancellationResponseTransfer->getErpOrderCancellation(); + + if ($erpOrderCancellationTransfer === null || !$erpOrderCancellationResponseTransfer->getIsSuccessful()) { + throw new EntityNotSavedException( + sprintf('Could not create erp order cancellation.'), + ApiConfig::HTTP_CODE_INTERNAL_ERROR, + ); + } + + return $this->apiFacade->createApiItem( + $erpOrderCancellationTransfer, + (string)$erpOrderCancellationTransfer->getIdErpOrderCancellation(), + ); + } + + /** + * @param int $idErpOrderCancellation + * @param \Generated\Shared\Transfer\ApiDataTransfer $apiDataTransfer + * + * @throws \Spryker\Zed\Api\Business\Exception\EntityNotSavedException + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function update(int $idErpOrderCancellation, ApiDataTransfer $apiDataTransfer): ApiItemTransfer + { + $this->getByIdErpOrderCancellation($idErpOrderCancellation); + + $erpOrderCancellationTransfer = (new ErpOrderCancellationTransfer()) + ->fromArray($apiDataTransfer->getData(), true) + ->setIdErpOrderCancellation($idErpOrderCancellation); + + $erpOrderCancellationResponseTransfer = $this->erpOrderCancellationFacade->updateErpOrderCancellation($erpOrderCancellationTransfer); + $erpOrderCancellationTransfer = $erpOrderCancellationResponseTransfer->getErpOrderCancellation(); + + if ($erpOrderCancellationTransfer === null || !$erpOrderCancellationResponseTransfer->getIsSuccessful()) { + throw new EntityNotSavedException( + sprintf('Could not update erp order cancellation.'), + ApiConfig::HTTP_CODE_INTERNAL_ERROR, + ); + } + + return $this->apiFacade->createApiItem( + $erpOrderCancellationTransfer, + (string)$erpOrderCancellationTransfer->getIdErpOrderCancellation(), + ); + } + + /** + * @param int $idErpOrderCancellation + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function get(int $idErpOrderCancellation): ApiItemTransfer + { + $erpOrderCancellationTransfer = $this->getByIdErpOrderCancellation($idErpOrderCancellation); + + return $this->apiFacade->createApiItem($erpOrderCancellationTransfer, (string)$idErpOrderCancellation); + } + + /** + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + public function find(ApiRequestTransfer $apiRequestTransfer): ApiCollectionTransfer + { + $data = []; + $apiCollectionTransfer = $this->repository->find($this->resolveStateFilter($apiRequestTransfer)); + + foreach ($apiCollectionTransfer->getData() as $index => $item) { + if (!isset($item[static::KEY_ID_ERP_ORDER_CANCELLATION])) { + continue; + } + + $data[$index] = $this->getByIdErpOrderCancellation($item[static::KEY_ID_ERP_ORDER_CANCELLATION])->toArray(); + } + + return $apiCollectionTransfer->setData($data); + } + + /** + * @param int $idErpOrderCancellation + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function delete(int $idErpOrderCancellation): ApiItemTransfer + { + $this->getByIdErpOrderCancellation($idErpOrderCancellation); + + $this->erpOrderCancellationFacade->deleteErpOrderCancellationByIdErpOrderCancellation($idErpOrderCancellation); + + return $this->apiFacade->createApiItem(null, (string)$idErpOrderCancellation); + } + + /** + * @param int $idErpOrderCancellation + * + * @throws \Spryker\Zed\Api\Business\Exception\EntityNotFoundException + * + * @return \Generated\Shared\Transfer\ErpOrderCancellationTransfer + */ + protected function getByIdErpOrderCancellation(int $idErpOrderCancellation): ErpOrderCancellationTransfer + { + $erpOrderCancellationTransfer = $this->erpOrderCancellationFacade->findErpOrderCancellationByIdErpOrderCancellation($idErpOrderCancellation); + + if ($erpOrderCancellationTransfer === null) { + throw new EntityNotFoundException( + sprintf('Could not find erp order cancellation.'), + ApiConfig::HTTP_CODE_NOT_FOUND, + ); + } + + return $erpOrderCancellationTransfer; + } + + /** + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Generated\Shared\Transfer\ApiRequestTransfer + */ + protected function resolveStateFilter(ApiRequestTransfer $apiRequestTransfer): ApiRequestTransfer + { + $filter = $apiRequestTransfer->getFilter(); + + if ($filter === null || $filter->getCriteriaJson() === null) { + return $apiRequestTransfer; + } + + try { + $jsonData = json_decode($filter->getCriteriaJson(), true); + } catch (Throwable $exception) { + return $apiRequestTransfer; + } + + if (array_key_exists(static::KEY_RULES, $jsonData) === false || !is_array($jsonData[static::KEY_RULES])) { + return $apiRequestTransfer; + } + + foreach ($jsonData[static::KEY_RULES] as &$rule) { + if (array_key_exists(static::KEY_FIELD, $rule) && $rule[static::KEY_FIELD] === static::KEY_STATE) { + $rule[static::KEY_VALUE] = $this->resolveStateValue($rule[static::KEY_VALUE]); + } + } + unset($rule); + + $filter->setCriteriaJson(json_encode($jsonData)); + + return $apiRequestTransfer->setFilter($filter); + } + + /** + * @param string $state + * + * @throws \PHPUnit\Util\Exception + * + * @return int + */ + protected function resolveStateValue(string $state): int + { + $availableStates = array_flip(FoiErpOrderCancellationTableMap::getValueSet(FoiErpOrderCancellationTableMap::COL_STATE)); + if (array_key_exists($state, $availableStates)) { + return $availableStates[$state]; + } + + throw new Exception(sprintf('State "%s" not found', $state)); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApiInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApiInterface.php new file mode 100644 index 0000000..21fc156 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Model/ErpOrderCancellationApiInterface.php @@ -0,0 +1,49 @@ + + */ + public function validate(ApiRequestTransfer $apiRequestTransfer): array + { + return []; + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Validator/ErpOrderCancellationApiValidatorInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Validator/ErpOrderCancellationApiValidatorInterface.php new file mode 100644 index 0000000..5d4b028 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Business/Validator/ErpOrderCancellationApiValidatorInterface.php @@ -0,0 +1,15 @@ + + */ + public function validate(ApiRequestTransfer $apiRequestTransfer): array; +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiResourcePlugin.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiResourcePlugin.php new file mode 100644 index 0000000..68e0c07 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiResourcePlugin.php @@ -0,0 +1,77 @@ +getFacade()->createErpOrderCancellation($apiDataTransfer); + } + + /** + * @param int $id + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function get($id): ApiItemTransfer + { + return $this->getFacade()->getErpOrderCancellation($id); + } + + /** + * @param int $id + * @param \Generated\Shared\Transfer\ApiDataTransfer $apiDataTransfer + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function update($id, ApiDataTransfer $apiDataTransfer): ApiItemTransfer + { + return $this->getFacade()->updateErpOrderCancellation($id, $apiDataTransfer); + } + + /** + * @param int $id + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function remove($id): ApiItemTransfer + { + return $this->getFacade()->deleteErpOrderCancellation($id); + } + + /** + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + public function find(ApiRequestTransfer $apiRequestTransfer): ApiCollectionTransfer + { + return $this->getFacade()->findErpOrderCancellations($apiRequestTransfer); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiValidatorPlugin.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiValidatorPlugin.php new file mode 100644 index 0000000..44c2234 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Communication/Plugin/Api/ErpOrderCancellationApiValidatorPlugin.php @@ -0,0 +1,33 @@ + + */ + public function validate(ApiRequestTransfer $apiRequestTransfer): array + { + return $this->getFacade()->validateErpOrderCancellation($apiRequestTransfer); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeBridge.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeBridge.php new file mode 100644 index 0000000..d8ff84b --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeBridge.php @@ -0,0 +1,45 @@ +apiFacade = $apiFacade; + } + + /** + * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null $transfer + * @param string|null $id + * + * @return \Generated\Shared\Transfer\ApiItemTransfer + */ + public function createApiItem(?AbstractTransfer $transfer = null, ?string $id = null): ApiItemTransfer + { + return $this->apiFacade->createApiItem($transfer, $id); + } + + /** + * @param array<\Spryker\Shared\Kernel\Transfer\AbstractTransfer> $transfers + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + public function createApiCollection(array $transfers): ApiCollectionTransfer + { + return $this->apiFacade->createApiCollection($transfers); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeInterface.php new file mode 100644 index 0000000..d45bdd1 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToApiFacadeInterface.php @@ -0,0 +1,25 @@ + $transfers + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + public function createApiCollection(array $transfers): ApiCollectionTransfer; +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeBridge.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeBridge.php new file mode 100644 index 0000000..6a739a3 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeBridge.php @@ -0,0 +1,63 @@ +erpOrderCancellationFacade = $erpOrderCancellationFacade; + } + + /** + * @param \Generated\Shared\Transfer\ErpOrderCancellationTransfer $erpOrderCancellationTransfer + * + * @return \Generated\Shared\Transfer\ErpOrderCancellationResponseTransfer + */ + public function createErpOrderCancellation(ErpOrderCancellationTransfer $erpOrderCancellationTransfer): ErpOrderCancellationResponseTransfer + { + return $this->erpOrderCancellationFacade->createErpOrderCancellation($erpOrderCancellationTransfer); + } + + /** + * @param \Generated\Shared\Transfer\ErpOrderCancellationTransfer $erpOrderCancellationTransfer + * + * @return \Generated\Shared\Transfer\ErpOrderCancellationResponseTransfer + */ + public function updateErpOrderCancellation(ErpOrderCancellationTransfer $erpOrderCancellationTransfer): ErpOrderCancellationResponseTransfer + { + return $this->erpOrderCancellationFacade->updateErpOrderCancellation($erpOrderCancellationTransfer); + } + + /** + * @param int $idErpOrderCancellation + * + * @return void + */ + public function deleteErpOrderCancellationByIdErpOrderCancellation(int $idErpOrderCancellation): void + { + $this->erpOrderCancellationFacade->deleteErpOrderCancellationByIdErpOrderCancellation($idErpOrderCancellation); + } + + /** + * @param int $idErpOrderCancellation + * + * @return \Generated\Shared\Transfer\ErpOrderCancellationTransfer|null + */ + public function findErpOrderCancellationByIdErpOrderCancellation(int $idErpOrderCancellation): ?ErpOrderCancellationTransfer + { + return $this->erpOrderCancellationFacade->findErpOrderCancellationByIdErpOrderCancellation($idErpOrderCancellation); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeInterface.php new file mode 100644 index 0000000..3792aa4 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/Facade/ErpOrderCancellationApiToErpOrderCancellationFacadeInterface.php @@ -0,0 +1,37 @@ +apiQueryBuilderQueryContainer = $apiQueryBuilderQueryContainer; + } + + /** + * @param \Generated\Shared\Transfer\ApiQueryBuilderQueryTransfer $apiQueryBuilderQueryTransfer + * + * @return \Generated\Shared\Transfer\PropelQueryBuilderCriteriaTransfer + */ + public function toPropelQueryBuilderCriteria( + ApiQueryBuilderQueryTransfer $apiQueryBuilderQueryTransfer + ): PropelQueryBuilderCriteriaTransfer { + return $this->apiQueryBuilderQueryContainer->toPropelQueryBuilderCriteria($apiQueryBuilderQueryTransfer); + } + + /** + * @param \Propel\Runtime\ActiveQuery\ModelCriteria $query + * @param \Generated\Shared\Transfer\ApiQueryBuilderQueryTransfer $apiQueryBuilderQueryTransfer + * + * @return \Propel\Runtime\ActiveQuery\ModelCriteria + */ + public function buildQueryFromRequest( + ModelCriteria $query, + ApiQueryBuilderQueryTransfer $apiQueryBuilderQueryTransfer + ): ModelCriteria { + return $this->apiQueryBuilderQueryContainer->buildQueryFromRequest($query, $apiQueryBuilderQueryTransfer); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/QueryContainer/ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/QueryContainer/ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface.php new file mode 100644 index 0000000..cd61a20 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Dependency/QueryContainer/ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface.php @@ -0,0 +1,30 @@ +addErpOrderCancellationFacade($container); + + return $this->addApiFacade($container); + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addErpOrderCancellationFacade(Container $container): Container + { + $container[static::FACADE_ERP_ORDER_CANCELLATION] = static function (Container $container) { + return new ErpOrderCancellationApiToErpOrderCancellationFacadeBridge( + $container->getLocator()->erpOrderCancellation()->facade(), + ); + }; + + return $container; + } + + /** + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addApiFacade(Container $container): Container + { + $container[static::FACADE_API] = static function (Container $container) { + return new ErpOrderCancellationApiToApiFacadeBridge( + $container->getLocator()->api()->facade(), + ); + }; + + return $container; + } + + /** + * @codeCoverageIgnore + * + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + public function providePersistenceLayerDependencies(Container $container): Container + { + $container = parent::providePersistenceLayerDependencies($container); + + $this->addErpOrderCancellationPropelQuery($container); + $this->addApiFacade($container); + + return $this->addApiQueryBuilderQueryContainer($container); + } + + /** + * @codeCoverageIgnore + * + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addErpOrderCancellationPropelQuery(Container $container): Container + { + $container[static::PROPEL_QUERY_ERP_ORDER_CANCELLATION] = static function () { + return FoiErpOrderCancellationQuery::create(); + }; + + return $container; + } + + /** + * @codeCoverageIgnore + * + * @param \Spryker\Zed\Kernel\Container $container + * + * @return \Spryker\Zed\Kernel\Container + */ + protected function addApiQueryBuilderQueryContainer(Container $container): Container + { + $container[static::QUERY_CONTAINER_API_QUERY_BUILDER] = static function (Container $container) { + return new ErpOrderCancellationApiToApiQueryBuilderQueryContainerBridge( + $container->getLocator()->apiQueryBuilder()->queryContainer(), + ); + }; + + return $container; + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiPersistenceFactory.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiPersistenceFactory.php new file mode 100644 index 0000000..9b70235 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiPersistenceFactory.php @@ -0,0 +1,42 @@ +getProvidedDependency(ErpOrderCancellationApiDependencyProvider::PROPEL_QUERY_ERP_ORDER_CANCELLATION); + } + + /** + * @return \FondOfImpala\Zed\ErpOrderCancellationApi\Dependency\QueryContainer\ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface + */ + public function getApiQueryBuilderQueryContainer(): ErpOrderCancellationApiToApiQueryBuilderQueryContainerInterface + { + return $this->getProvidedDependency(ErpOrderCancellationApiDependencyProvider::QUERY_CONTAINER_API_QUERY_BUILDER); + } + + /** + * @return \FondOfImpala\Zed\ErpOrderCancellationApi\Dependency\Facade\ErpOrderCancellationApiToApiFacadeInterface + */ + public function getApiFacade(): ErpOrderCancellationApiToApiFacadeInterface + { + return $this->getProvidedDependency(ErpOrderCancellationApiDependencyProvider::FACADE_API); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepository.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepository.php new file mode 100644 index 0000000..e3758ca --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepository.php @@ -0,0 +1,137 @@ +buildQuery($apiRequestTransfer); + + $data = $query->find() + ->toArray(); + + $apiCollectionTransfer = $this->getFactory() + ->getApiFacade() + ->createApiCollection([]) + ->setData($data); + + if (count($apiCollectionTransfer->getData()) === 0) { + return $apiCollectionTransfer; + } + + return $this->addPagination($query, $apiCollectionTransfer, $apiRequestTransfer); + } + + /** + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Propel\Runtime\ActiveQuery\ModelCriteria + */ + protected function buildQuery(ApiRequestTransfer $apiRequestTransfer): ModelCriteria + { + $apiQueryBuilderQueryTransfer = $this->buildApiQueryBuilderQuery($apiRequestTransfer); + + $query = $this->getFactory() + ->getErpOrderCancellationQuery() + ->clear(); + + return $this->getFactory() + ->getApiQueryBuilderQueryContainer() + ->buildQueryFromRequest($query, $apiQueryBuilderQueryTransfer); + } + + /** + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @return \Generated\Shared\Transfer\ApiQueryBuilderQueryTransfer + */ + protected function buildApiQueryBuilderQuery(ApiRequestTransfer $apiRequestTransfer): ApiQueryBuilderQueryTransfer + { + $columnSelectionTransfer = $this->buildColumnSelection(); + + return (new ApiQueryBuilderQueryTransfer()) + ->setApiRequest($apiRequestTransfer) + ->setColumnSelection($columnSelectionTransfer); + } + + /** + * @return \Generated\Shared\Transfer\PropelQueryBuilderColumnSelectionTransfer + */ + protected function buildColumnSelection(): PropelQueryBuilderColumnSelectionTransfer + { + $columnSelectionTransfer = new PropelQueryBuilderColumnSelectionTransfer(); + $tableColumns = FoiErpOrderCancellationTableMap::getFieldNames(TableMap::TYPE_FIELDNAME); + + foreach ($tableColumns as $columnAlias) { + $columnTransfer = (new PropelQueryBuilderColumnTransfer()) + ->setName(FoiErpOrderCancellationTableMap::TABLE_NAME . '.' . $columnAlias) + ->setAlias($columnAlias); + + $columnSelectionTransfer->addTableColumn($columnTransfer); + } + + return $columnSelectionTransfer; + } + + /** + * @param \Propel\Runtime\ActiveQuery\ModelCriteria $query + * @param \Generated\Shared\Transfer\ApiCollectionTransfer $apiCollectionTransfer + * @param \Generated\Shared\Transfer\ApiRequestTransfer $apiRequestTransfer + * + * @throws \Exception + * + * @return \Generated\Shared\Transfer\ApiCollectionTransfer + */ + protected function addPagination( + ModelCriteria $query, + ApiCollectionTransfer $apiCollectionTransfer, + ApiRequestTransfer $apiRequestTransfer + ): ApiCollectionTransfer { + $query->setOffset(0) + ->setLimit(-1); + + $apiFilterTransfer = $apiRequestTransfer->getFilter() ?? new ApiFilterTransfer(); + $limit = $apiFilterTransfer->getLimit(); + $offset = $apiFilterTransfer->getOffset(); + $total = $query->count(); + + $page = $limit > 0 && $offset >= 0 ? ($offset / $limit + 1) : 1; + $pageTotal = $limit > 0 && $total >= 0 ? (int)ceil($total / $limit) : 1; + + if ($page > $pageTotal) { + throw new Exception('Out of bounds.'); + } + + $apiPaginationTransfer = (new ApiPaginationTransfer()) + ->setItemsPerPage($apiFilterTransfer->getLimit()) + ->setPage($page) + ->setTotal($total) + ->setPageTotal($pageTotal); + + return $apiCollectionTransfer->setPagination($apiPaginationTransfer); + } +} diff --git a/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepositoryInterface.php b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepositoryInterface.php new file mode 100644 index 0000000..30f3c85 --- /dev/null +++ b/src/FondOfImpala/Zed/ErpOrderCancellationApi/Persistence/ErpOrderCancellationApiRepositoryInterface.php @@ -0,0 +1,16 @@ +