diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php index 32da479a..2658933f 100644 --- a/.php-cs-fixer.php +++ b/.php-cs-fixer.php @@ -18,6 +18,7 @@ ->in(__DIR__ . '/src/Services/CRM/Documentgenerator/Numerator/') ->in(__DIR__ . '/src/Services/Entity/Section/') ->in(__DIR__ . '/src/Services/Department/') + ->in(__DIR__ . '/src/Services/Landing/') ->in(__DIR__ . '/src/Services/Paysystem/') ->in(__DIR__ . '/src/Services/Sale/') ->in(__DIR__ . '/src/Services/Task/') diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ab252fa..13fe3cbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,91 @@ ### Added +- Added service `Services\Landing\Site\Service\Site` with support methods, + see [landing.site.* methods](https://github.com/bitrix24/b24phpsdk/issues/267): + - `add` adds a site + - `getList` retrieves a list of sites + - `update` updates site parameters + - `delete` deletes a site + - `getPublicUrl` returns the full URL of the site(s) + - `getPreview` returns the preview image URL of the site + - `publication` publishes the site and all its pages + - `unpublic` unpublishes the site and all its pages + - `markDelete` marks the site as deleted + - `markUnDelete` restores the site from the trash + - `getAdditionalFields` returns additional fields of the site + - `fullExport` exports the site to ZIP archive + - `getFolders` retrieves the site folders + - `addFolder` adds a folder to the site + - `updateFolder` updates folder parameters + - `publicationFolder` publishes the site's folder + - `unPublicFolder` unpublishes the site's folder + - `markFolderDelete` marks the folder as deleted + - `markFolderUnDelete` restores the folder from the trash +- Added service `Services\Landing\SysPage\Service\SysPage` with support methods, + see [landing.syspage.* methods](https://github.com/bitrix24/b24phpsdk/issues/267): + - `set` sets a special page for the site + - `get` retrieves the list of special pages + - `getSpecialPage` retrieves the address of the special page on the site + - `deleteForLanding` deletes all mentions of the page as a special one + - `deleteForSite` deletes all special pages of the site +- Added service `Services\Landing\Page\Service\Page` with support methods, + see [landing.landing.* methods](https://github.com/bitrix24/b24phpsdk/issues/267): + - `add` adds a page + - `addByTemplate` creates a page from a template + - `copy` copies a page + - `delete` deletes a page + - `update` updates page parameters + - `getList` retrieves a list of pages + - `getAdditionalFields` returns additional fields of the page + - `getPreview` returns the preview image URL of the page + - `getPublicUrl` returns the full URL of the page + - `resolveIdByPublicUrl` resolves page ID by its public URL + - `publish` publishes the page + - `unpublish` unpublishes the page + - `markDeleted` marks the page as deleted + - `markUnDeleted` restores the page from the trash + - `move` moves a page to another site or folder + - `removeEntities` removes entities from the page + - `addBlock` adds a block to the page + - `copyBlock` copies a block within the page + - `deleteBlock` deletes a block from the page + - `moveBlockDown` moves a block down on the page + - `moveBlockUp` moves a block up on the page + - `moveBlock` moves a block to a specific position + - `hideBlock` hides a block on the page + - `showBlock` shows a block on the page + - `markBlockDeleted` marks a block as deleted + - `markBlockUnDeleted` restores a block from the trash + - `addBlockToFavorites` adds a block to favorites + - `removeBlockFromFavorites` removes a block from favorites +- Added service `Services\Landing\Block\Service\Block` with support methods, + see [landing.block.* methods](https://github.com/bitrix24/b24phpsdk/issues/267): + - `list` retrieves a list of page blocks + - `getById` retrieves a block by its identifier + - `getContent` retrieves the content of a block + - `getManifest` retrieves the manifest of a block + - `getRepository` retrieves blocks from the repository + - `getManifestFile` retrieves block manifest from repository + - `getContentFromRepository` retrieves block content from repository + - `updateNodes` updates block content + - `updateAttrs` updates block node attributes + - `updateStyles` updates block styles + - `updateContent` updates block content with arbitrary content + - `updateCards` bulk updates block cards + - `cloneCard` clones a block card + - `addCard` adds a card with modified content + - `removeCard` removes a block card + - `uploadFile` uploads and attaches image to block + - `changeAnchor` changes anchor symbol code + - `changeNodeName` changes tag name +- Added service `Services\Landing\Template\Service\Template` with support methods, + see [landing.template.* methods](https://github.com/bitrix24/b24phpsdk/issues/267): + - `getList` retrieves a list of templates + - `getLandingRef` retrieves a list of included areas for the page + - `getSiteRef` retrieves a list of included areas for the site + - `setLandingRef` sets the included areas for the page + - `setSiteRef` sets the included areas for the site - Added service `Services\Sale\Delivery\Service\Delivery` with support methods, see [sale.delivery.* methods](https://github.com/bitrix24/b24phpsdk/issues/255): - `add` adds a delivery service diff --git a/Makefile b/Makefile index 2385801a..2ae5d29b 100644 --- a/Makefile +++ b/Makefile @@ -61,6 +61,9 @@ help: @echo "test-integration-sale-payment-item-basket - run PaymentItemBasket integration tests" @echo "test-integration-sale-payment-item-shipment - run PaymentItemShipment integration tests" @echo "test-integration-sale-property-relation - run PropertyRelation integration tests" + @echo "test-integration-landing-page - run Landing Page integration tests" + @echo "test-integration-landing-syspage - run Landing SysPage integration tests" + @echo "test-integration-scope-landing-template - run Landing Template integration tests" .PHONY: docker-init @@ -218,6 +221,29 @@ test-integration-scope-log: test-integration-scope-sale: docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_scope_sale +.PHONY: test-integration-scope-landing +test-integration-scope-landing: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_scope_landing + +.PHONY: test-integration-scope-landing-template +test-integration-scope-landing-template: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_scope_landing_template + +.PHONY: test-integration-landing-block +test-integration-landing-block: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_landing_block + +.PHONY: test-integration-landing-site +test-integration-landing-site: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_landing_site + +.PHONY: test-integration-landing-page +test-integration-landing-page: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_landing_page + +.PHONY: test-integration-landing-syspage +test-integration-landing-syspage: + docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_landing_syspage .PHONY: test-integration-scope-disk test-integration-scope-disk: docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_scope_disk diff --git a/phpstan.neon.dist b/phpstan.neon.dist index 04b7340d..f73030ea 100644 --- a/phpstan.neon.dist +++ b/phpstan.neon.dist @@ -30,6 +30,7 @@ parameters: - tests/Integration/Services/CRM/Requisites - tests/Integration/Services/Task - tests/Integration/Services/Sale + - tests/Integration/Services/Landing - tests/Integration/Services/Disk - tests/Integration/Services/Calendar - tests/Integration/Services/CRM/Documentgenerator/Numerator diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 6ffe1808..ad48c39f 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -175,6 +175,18 @@ ./tests/Integration/Services/Sale/Order/ + + ./tests/Integration/Services/Landing/ + + + ./tests/Integration/Services/Landing/Site/ + + + ./tests/Integration/Services/Landing/Page/ + + + ./tests/Integration/Services/Landing/SysPage/ + ./tests/Integration/Services/Sale/CashboxHandler/ @@ -205,6 +217,12 @@ ./tests/Integration/Services/Sale/ShipmentItem/ + + ./tests/Integration/Services/Landing/Template/ + + + ./tests/Integration/Services/Landing/Block/ + ./tests/Integration/Services/CRM/Documentgenerator/Numerator/ diff --git a/rector.php b/rector.php index 513cc900..5a80e08b 100644 --- a/rector.php +++ b/rector.php @@ -64,6 +64,8 @@ __DIR__ . '/tests/Integration/Services/Task', __DIR__ . '/src/Services/Sale', __DIR__ . '/tests/Integration/Services/Sale', + __DIR__ . '/src/Services/Landing', + __DIR__ . '/tests/Integration/Services/Landing', __DIR__ . '/src/Services/Disk', __DIR__ . '/tests/Integration/Services/Disk', __DIR__ . '/src/Services/Calendar', diff --git a/src/Services/Landing/Block/Result/BlockContentItemResult.php b/src/Services/Landing/Block/Result/BlockContentItemResult.php new file mode 100644 index 00000000..b8405fe3 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockContentItemResult.php @@ -0,0 +1,38 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read non-negative-int $id + * @property-read string $sections + * @property-read string $active + * @property-read string $access + * @property-read string $anchor + * @property-read string $php + * @property-read string $designed + * @property-read string $repoId + * @property-read string $content + * @property-read string $content_ext + * @property-read array $css + * @property-read array $js + * @property-read array $assetStrings + * @property-read array $lang + * @property-read array $manifest + * @property-read array $dynamicParams + */ +class BlockContentItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Block/Result/BlockContentResult.php b/src/Services/Landing/Block/Result/BlockContentResult.php new file mode 100644 index 00000000..901fe915 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockContentResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class BlockContentResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getContent(): BlockContentItemResult + { + return new BlockContentItemResult($this->getCoreResponse()->getResponseData()->getResult()); + } +} diff --git a/src/Services/Landing/Block/Result/BlockItemResult.php b/src/Services/Landing/Block/Result/BlockItemResult.php new file mode 100644 index 00000000..0837dcc7 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockItemResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read non-negative-int $id + * @property-read non-negative-int $lid + * @property-read string $code + * @property-read string $name + * @property-read string $active + * @property-read array $meta + */ +class BlockItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Block/Result/BlockManifestItemResult.php b/src/Services/Landing/Block/Result/BlockManifestItemResult.php new file mode 100644 index 00000000..33716047 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockManifestItemResult.php @@ -0,0 +1,35 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read array $block + * @property-read array $cards + * @property-read array $nodes + * @property-read array $style + * @property-read array $assets + * @property-read array $groups + * @property-read int $timestamp + * @property-read array $attrs + * @property-read array $callbacks + * @property-read array $menu + * @property-read string $namespace + * @property-read string $code + * @property-read string $preview + */ +class BlockManifestItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Block/Result/BlockManifestResult.php b/src/Services/Landing/Block/Result/BlockManifestResult.php new file mode 100644 index 00000000..ee3ecf70 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockManifestResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class BlockManifestResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getManifest(): BlockManifestItemResult + { + return new BlockManifestItemResult($this->getCoreResponse()->getResponseData()->getResult()); + } +} diff --git a/src/Services/Landing/Block/Result/BlockResult.php b/src/Services/Landing/Block/Result/BlockResult.php new file mode 100644 index 00000000..11e39e84 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlockResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class BlockResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getBlock(): BlockItemResult + { + return new BlockItemResult($this->getCoreResponse()->getResponseData()->getResult()); + } +} diff --git a/src/Services/Landing/Block/Result/BlocksResult.php b/src/Services/Landing/Block/Result/BlocksResult.php new file mode 100644 index 00000000..eaf61d20 --- /dev/null +++ b/src/Services/Landing/Block/Result/BlocksResult.php @@ -0,0 +1,34 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class BlocksResult extends AbstractResult +{ + /** + * @return BlockItemResult[] + * @throws BaseException + */ + public function getBlocks(): array + { + $res = []; + foreach ($this->getCoreResponse()->getResponseData()->getResult() as $block) { + $res[] = new BlockItemResult($block); + } + + return $res; + } +} diff --git a/src/Services/Landing/Block/Result/RepositoryContentResult.php b/src/Services/Landing/Block/Result/RepositoryContentResult.php new file mode 100644 index 00000000..48fe8e23 --- /dev/null +++ b/src/Services/Landing/Block/Result/RepositoryContentResult.php @@ -0,0 +1,29 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class RepositoryContentResult extends AbstractResult +{ + /** + * @return string HTML content from repository block + * @throws BaseException + */ + public function getContent(): string + { + return $this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Block/Result/RepositoryItemResult.php b/src/Services/Landing/Block/Result/RepositoryItemResult.php new file mode 100644 index 00000000..e3524df5 --- /dev/null +++ b/src/Services/Landing/Block/Result/RepositoryItemResult.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read string $name + * @property-read array $meta + * @property-read string $new + * @property-read array $type + * @property-read string $specialType + * @property-read string $separator + * @property-read string $app_code + * @property-read array $items + */ +class RepositoryItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Block/Result/RepositoryResult.php b/src/Services/Landing/Block/Result/RepositoryResult.php new file mode 100644 index 00000000..b231cb2d --- /dev/null +++ b/src/Services/Landing/Block/Result/RepositoryResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class RepositoryResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getRepository(): RepositoryItemResult + { + return new RepositoryItemResult($this->getCoreResponse()->getResponseData()->getResult()); + } +} diff --git a/src/Services/Landing/Block/Result/UpdateResult.php b/src/Services/Landing/Block/Result/UpdateResult.php new file mode 100644 index 00000000..0d23a674 --- /dev/null +++ b/src/Services/Landing/Block/Result/UpdateResult.php @@ -0,0 +1,29 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class UpdateResult extends AbstractResult +{ + /** + * @return bool True on success + * @throws BaseException + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Block/Result/UploadFileResult.php b/src/Services/Landing/Block/Result/UploadFileResult.php new file mode 100644 index 00000000..d3cb5a3d --- /dev/null +++ b/src/Services/Landing/Block/Result/UploadFileResult.php @@ -0,0 +1,73 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class UploadFileResult extends AbstractResult +{ + /** + * @return array Contains file ID and URL + * @throws BaseException + */ + public function getUploadFileData(): array + { + echo "\n UploadFileResult \n"; + print_r($this->getCoreResponse()->getResponseData()->getResult()); + echo "\n"; + + return $this->getCoreResponse()->getResponseData()->getResult(); + } + + /** + * @return int File ID + * @throws BaseException + */ + public function getId(): int + { + $result = $this->getCoreResponse()->getResponseData()->getResult(); + return (int)$result['id']; + } + + /** + * @return string File URL + * @throws BaseException + */ + public function getUrl(): string + { + $result = $this->getCoreResponse()->getResponseData()->getResult(); + return $result['src']; + } + + /** + * @deprecated Use getId() instead + * @return int|null File ID + * @throws BaseException + */ + public function getFileId(): ?int + { + return $this->getId(); + } + + /** + * @deprecated Use getUrl() instead + * @return string Direct path to uploaded file + * @throws BaseException + */ + public function getFilePath(): string + { + return $this->getUrl(); + } +} diff --git a/src/Services/Landing/Block/Service/Block.php b/src/Services/Landing/Block/Service/Block.php new file mode 100644 index 00000000..5472206e --- /dev/null +++ b/src/Services/Landing/Block/Service/Block.php @@ -0,0 +1,584 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Block\Service; + +use Bitrix24\SDK\Attributes\ApiEndpointMetadata; +use Bitrix24\SDK\Attributes\ApiServiceMetadata; +use Bitrix24\SDK\Core\Contracts\CoreInterface; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\AbstractService; +use Bitrix24\SDK\Services\Landing\Block\Result\BlocksResult; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockResult; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockContentResult; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockManifestResult; +use Bitrix24\SDK\Services\Landing\Block\Result\RepositoryResult; +use Bitrix24\SDK\Services\Landing\Block\Result\RepositoryContentResult; +use Bitrix24\SDK\Services\Landing\Block\Result\UploadFileResult; +use Bitrix24\SDK\Services\Landing\Block\Result\UpdateResult; +use Psr\Log\LoggerInterface; + +#[ApiServiceMetadata(new Scope(['landing']))] +class Block extends AbstractService +{ + public function __construct(CoreInterface $core, LoggerInterface $logger) + { + parent::__construct($core, $logger); + } + + /** + * Get list of page blocks. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-list.html + * + * @param int|array $lid Page identifier or array of identifiers + * @param array $params Parameters: edit_mode (0|1), deleted (0|1) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getlist', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-list.html', + 'Method retrieves a list of page blocks.' + )] + public function list($lid, array $params = []): BlocksResult + { + return new BlocksResult( + $this->core->call( + 'landing.block.getlist', + [ + 'lid' => $lid, + 'params' => $params, + ] + ) + ); + } + + /** + * Get block by ID. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-by-id.html + * + * @param int $blockId Block identifier + * @param array $params Parameters: edit_mode (0|1) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getbyid', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-by-id.html', + 'Method retrieves a block by its identifier.' + )] + public function getById(int $blockId, array $params = []): BlockResult + { + return new BlockResult( + $this->core->call( + 'landing.block.getbyid', + [ + 'block' => $blockId, + 'params' => $params, + ] + ) + ); + } + + /** + * Get content of block. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param int $editMode Editing mode (1) or not (0) + * @param array $params Additional parameters: wrapper_show (0|1) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getcontent', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content.html', + 'Method retrieves the content of a block.' + )] + public function getContent(int $lid, int $blockId, int $editMode = 0, array $params = []): BlockContentResult + { + return new BlockContentResult( + $this->core->call( + 'landing.block.getcontent', + [ + 'lid' => $lid, + 'block' => $blockId, + 'editMode' => $editMode, + 'params' => $params, + ] + ) + ); + } + + /** + * Get block manifest. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $params Parameters: edit_mode (0|1) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getmanifest', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest.html', + 'Method retrieves the manifest of a specific block already placed on the page.' + )] + public function getManifest(int $lid, int $blockId, array $params = []): BlockManifestResult + { + return new BlockManifestResult( + $this->core->call( + 'landing.block.getmanifest', + [ + 'lid' => $lid, + 'block' => $blockId, + 'params' => $params, + ] + ) + ); + } + + /** + * Get list of blocks from repository. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-repository.html + * + * @param string $section Section code of the repository + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getrepository', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-repository.html', + 'Method returns a list of blocks from the repository.' + )] + public function getRepository(string $section): RepositoryResult + { + return new RepositoryResult( + $this->core->call( + 'landing.block.getrepository', + [ + 'section' => $section, + ] + ) + ); + } + + /** + * Get block manifest from repository. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest-file.html + * + * @param string $blockCode Block code + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getmanifestfile', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest-file.html', + 'Method retrieves the manifest of a block from the repository.' + )] + public function getManifestFile(string $blockCode): BlockManifestResult + { + return new BlockManifestResult( + $this->core->call( + 'landing.block.getmanifestfile', + [ + 'code' => $blockCode, + ] + ) + ); + } + + /** + * Get block content from repository. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content-from-repository.html + * + * @param string $blockCode Block code + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.getcontentfromrepository', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content-from-repository.html', + 'Method retrieves the content of a block from the repository "as is" before adding the block to any page.' + )] + public function getContentFromRepository(string $blockCode): RepositoryContentResult + { + return new RepositoryContentResult( + $this->core->call( + 'landing.block.getcontentfromrepository', + [ + 'code' => $blockCode, + ] + ) + ); + } + + /** + * Update block content. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-nodes.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $data Array of selectors and new values + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.updatenodes', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-nodes.html', + 'Method changes the content of the block.' + )] + public function updateNodes(int $lid, int $blockId, array $data): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.updatenodes', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $data, + ] + ) + ); + } + + /** + * Update block node attributes. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-attrs.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $data Data for changing node attributes + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.updateattrs', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-attrs.html', + 'Method for changing the attributes of a block node.' + )] + public function updateAttrs(int $lid, int $blockId, array $data): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.updateattrs', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $data, + ] + ) + ); + } + + /** + * Update block styles. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-styles.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $data Array of selectors with classList and affect parameters + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.updatestyles', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-styles.html', + 'Method changes the styles of the block.' + )] + public function updateStyles(int $lid, int $blockId, array $data): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.updatestyles', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $data, + ] + ) + ); + } + + /** + * Update block content with arbitrary content. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-content.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param string $content New content for the block + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.updatecontent', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-content.html', + 'Method updates the content of a block already placed on the page to any arbitrary content.' + )] + public function updateContent(int $lid, int $blockId, string $content): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.updatecontent', + [ + 'lid' => $lid, + 'block' => $blockId, + 'content' => $content, + ] + ) + ); + } + + /** + * Bulk update block cards. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-cards.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $data Data for bulk updating cards + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.updatecards', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-cards.html', + 'Method for bulk updating block cards.' + )] + public function updateCards(int $lid, int $blockId, array $data): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.updatecards', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $data, + ] + ) + ); + } + + /** + * Clone block card. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-clone-card.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param string $selector Card selector (e.g., '.landing-block-card@0') + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.clonecard', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-clone-card.html', + 'Method clones a block card.' + )] + public function cloneCard(int $lid, int $blockId, string $selector): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.clonecard', + [ + 'lid' => $lid, + 'block' => $blockId, + 'selector' => $selector, + ] + ) + ); + } + + /** + * Add card with modified content. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-add-card.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param string $selector Card selector (e.g., '.landing-block-card@0') + * @param string $content Content of the new card + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.addcard', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-add-card.html', + 'Method fully replicates the work of landing.block.clonecard but allows inserting a card with modified content right away.' + )] + public function addCard(int $lid, int $blockId, string $selector, string $content): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.addcard', + [ + 'lid' => $lid, + 'block' => $blockId, + 'selector' => $selector, + 'content' => $content, + ] + ) + ); + } + + /** + * Remove block card. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-remove-card.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param string $selector Card selector (e.g., '.landing-block-card@0') + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.removecard', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-remove-card.html', + 'Method removes a block card.' + )] + public function removeCard(int $lid, int $blockId, string $selector): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.removecard', + [ + 'lid' => $lid, + 'block' => $blockId, + 'selector' => $selector, + ] + ) + ); + } + + /** + * Upload and attach image to block. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-upload-file.html + * + * @param int $blockId Block identifier + * @param mixed $picture Image data (URL string, file element, or array with name and base64 content) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.uploadfile', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-upload-file.html', + 'Method uploads an image and associates it with the specified block.' + )] + public function uploadFile(int $blockId, mixed $picture): UploadFileResult + { + return new UploadFileResult( + $this->core->call( + 'landing.block.uploadfile', + [ + 'block' => $blockId, + 'picture' => $picture, + ] + ) + ); + } + + /** + * Change anchor symbol code. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-anchor.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param string $anchor New anchor code + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.changeanchor', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-anchor.html', + 'Method changes the symbolic code of the anchor.' + )] + public function changeAnchor(int $lid, int $blockId, string $anchor): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.changeanchor', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $anchor, + ] + ) + ); + } + + /** + * Change tag name. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-node-name.html + * + * @param int $lid Page identifier + * @param int $blockId Block identifier + * @param array $data Array of selectors and new tag names. Example: ['.landing-block-node-text@0' => 'h2'] + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.block.changenodename', + 'https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-node-name.html', + 'Method for changing the tag name.' + )] + public function changeNodeName(int $lid, int $blockId, array $data): UpdateResult + { + return new UpdateResult( + $this->core->call( + 'landing.block.changenodename', + [ + 'lid' => $lid, + 'block' => $blockId, + 'data' => $data, + ] + ) + ); + } +} diff --git a/src/Services/Landing/LandingServiceBuilder.php b/src/Services/Landing/LandingServiceBuilder.php new file mode 100644 index 00000000..a31c9c2f --- /dev/null +++ b/src/Services/Landing/LandingServiceBuilder.php @@ -0,0 +1,102 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing; + +use Bitrix24\SDK\Attributes\ApiServiceBuilderMetadata; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Services\AbstractServiceBuilder; + +/** + * Class LandingServiceBuilder + * + * @package Bitrix24\SDK\Services\Landing + */ +#[ApiServiceBuilderMetadata(new Scope(['landing']))] +class LandingServiceBuilder extends AbstractServiceBuilder +{ + /** + * Get Site service + */ + public function site(): Site\Service\Site + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new Site\Service\Site( + $this->core, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } + + /** + * Get Page service + */ + public function page(): Page\Service\Page + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new Page\Service\Page( + $this->core, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } + + /** + * Get SysPage service + */ + public function sysPage(): SysPage\Service\SysPage + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new SysPage\Service\SysPage( + $this->core, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } + + /** + * Get Template service + */ + public function template(): Template\Service\Template + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new Template\Service\Template( + $this->core, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } + + /** + * Get Block service + */ + public function block(): Block\Service\Block + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new Block\Service\Block( + $this->core, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } +} diff --git a/src/Services/Landing/Page/Result/BlockMovedResult.php b/src/Services/Landing/Page/Result/BlockMovedResult.php new file mode 100644 index 00000000..8e13a509 --- /dev/null +++ b/src/Services/Landing/Page/Result/BlockMovedResult.php @@ -0,0 +1,27 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class BlockMovedResult extends AbstractResult +{ + /** + * Check if block move operation was successful + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/MarkPageDeletedResult.php b/src/Services/Landing/Page/Result/MarkPageDeletedResult.php new file mode 100644 index 00000000..0d87f3f2 --- /dev/null +++ b/src/Services/Landing/Page/Result/MarkPageDeletedResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class MarkPageDeletedResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/MarkPageUnDeletedResult.php b/src/Services/Landing/Page/Result/MarkPageUnDeletedResult.php new file mode 100644 index 00000000..df46c907 --- /dev/null +++ b/src/Services/Landing/Page/Result/MarkPageUnDeletedResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class MarkPageUnDeletedResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/PageAdditionalFieldsResult.php b/src/Services/Landing/Page/Result/PageAdditionalFieldsResult.php new file mode 100644 index 00000000..f5ab31f4 --- /dev/null +++ b/src/Services/Landing/Page/Result/PageAdditionalFieldsResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class PageAdditionalFieldsResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getAdditionalFields(): array + { + return $this->getCoreResponse()->getResponseData()->getResult(); + } +} diff --git a/src/Services/Landing/Page/Result/PageIdByUrlResult.php b/src/Services/Landing/Page/Result/PageIdByUrlResult.php new file mode 100644 index 00000000..ff15dbda --- /dev/null +++ b/src/Services/Landing/Page/Result/PageIdByUrlResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class PageIdByUrlResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getPageId(): int + { + return (int)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/PageItemResult.php b/src/Services/Landing/Page/Result/PageItemResult.php new file mode 100644 index 00000000..c5b94186 --- /dev/null +++ b/src/Services/Landing/Page/Result/PageItemResult.php @@ -0,0 +1,60 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read non-negative-int $ID + * @property-read string $CODE + * @property-read string $TITLE + * @property-read string $DESCRIPTION + * @property-read string $ACTIVE + * @property-read non-negative-int $SITE_ID + * @property-read string $CREATED_BY_ID + * @property-read string $MODIFIED_BY_ID + * @property-read string $DATE_CREATE + * @property-read string $DATE_MODIFY + * @property-read string $FOLDER + * @property-read string $FOLDER_ID + * @property-read string $SITEMAP + * @property-read string $IN_SITEMAP + * @property-read string $TPL_ID + * @property-read string $TPL_CODE + * @property-read string $PREVIEW_PICTURE + * @property-read string $PREVIEW_TEXT + * @property-read string $DETAIL_TEXT + * @property-read string $DETAIL_PICTURE + * @property-read string $META_TITLE + * @property-read string $META_DESCRIPTION + * @property-read string $META_KEYWORDS + * @property-read string $META_ROBOTS + * @property-read string $RULE + * @property-read string $ADDITIONAL_FIELDS + * @property-read string $XML_ID + * @property-read array $LANDING_ID_INDEX + * @property-read array $LANDING_ID_404 + * @property-read array $LANDING_ID_503 + * @property-read string $DOMAIN_ID + * @property-read string $DOMAIN_NAME + * @property-read string $DOMAIN_PROTOCOL + * @property-read string $PUBLIC_URL + * @property-read string $PREVIEW_URL + * @property-read string $VIEWS + * @property-read string $DATE_PUBLIC + * @property-read string $PUBLICATION + */ +class PageItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Page/Result/PagePreviewResult.php b/src/Services/Landing/Page/Result/PagePreviewResult.php new file mode 100644 index 00000000..bcfa7ea7 --- /dev/null +++ b/src/Services/Landing/Page/Result/PagePreviewResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class PagePreviewResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getPreviewPath(): string + { + return (string)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/PagePublicUrlResult.php b/src/Services/Landing/Page/Result/PagePublicUrlResult.php new file mode 100644 index 00000000..f28d6e3a --- /dev/null +++ b/src/Services/Landing/Page/Result/PagePublicUrlResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class PagePublicUrlResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getPublicUrl(): string + { + return (string)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Page/Result/PagesResult.php b/src/Services/Landing/Page/Result/PagesResult.php new file mode 100644 index 00000000..cd95d1f6 --- /dev/null +++ b/src/Services/Landing/Page/Result/PagesResult.php @@ -0,0 +1,34 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class PagesResult extends AbstractResult +{ + /** + * @return PageItemResult[] + * @throws BaseException + */ + public function getPages(): array + { + $res = []; + foreach ($this->getCoreResponse()->getResponseData()->getResult() as $page) { + $res[] = new PageItemResult($page); + } + + return $res; + } +} diff --git a/src/Services/Landing/Page/Service/Page.php b/src/Services/Landing/Page/Service/Page.php new file mode 100644 index 00000000..c6e99420 --- /dev/null +++ b/src/Services/Landing/Page/Service/Page.php @@ -0,0 +1,818 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Page\Service; + +use Bitrix24\SDK\Attributes\ApiEndpointMetadata; +use Bitrix24\SDK\Attributes\ApiServiceMetadata; +use Bitrix24\SDK\Core\Contracts\CoreInterface; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Core\Result\AddedItemResult; +use Bitrix24\SDK\Core\Result\UpdatedItemResult; +use Bitrix24\SDK\Core\Result\DeletedItemResult; +use Bitrix24\SDK\Services\AbstractService; +use Bitrix24\SDK\Services\Landing\Page\Result\PagesResult; +use Bitrix24\SDK\Services\Landing\Page\Result\PageAdditionalFieldsResult; +use Bitrix24\SDK\Services\Landing\Page\Result\PagePreviewResult; +use Bitrix24\SDK\Services\Landing\Page\Result\PagePublicUrlResult; +use Bitrix24\SDK\Services\Landing\Page\Result\PageIdByUrlResult; +use Bitrix24\SDK\Services\Landing\Page\Result\MarkPageDeletedResult; +use Bitrix24\SDK\Services\Landing\Page\Result\MarkPageUnDeletedResult; +use Bitrix24\SDK\Services\Landing\Page\Result\BlockMovedResult; +use Psr\Log\LoggerInterface; + +#[ApiServiceMetadata(new Scope(['landing']))] +class Page extends AbstractService +{ + public function __construct(CoreInterface $core, LoggerInterface $logger) + { + parent::__construct($core, $logger); + } + + /** + * Adds a page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add.html + * + * @param array $fields Field values for creating a page (TITLE, CODE, SITE_ID required, ADDITIONAL_FIELDS optional) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.add', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add.html', + 'Method for adding a page.' + )] + public function add(array $fields): AddedItemResult + { + return new AddedItemResult( + $this->core->call('landing.landing.add', ['fields' => $fields]) + ); + } + + /** + * Adds a page by template. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add-by-template.html + * + * @param int $siteId ID of the site where the page needs to be created + * @param string $code Identifier of the template to be used for creation + * @param array $fields Optional array of fields for the created page (TITLE, DESCRIPTION) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.addByTemplate', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add-by-template.html', + 'Method for adding a page by template.' + )] + public function addByTemplate(int $siteId, string $code, array $fields = []): AddedItemResult + { + $params = [ + 'siteId' => $siteId, + 'code' => $code, + ]; + + if ($fields !== []) { + $params['fields'] = $fields; + } + + return new AddedItemResult( + $this->core->call('landing.landing.addByTemplate', $params) + ); + } + + /** + * Copies the specified page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-copy.html + * + * @param int $lid Page identifier + * @param int|null $toSiteId Optional site identifier to copy to + * @param int|null $toFolderId Optional folder identifier to copy to + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.copy', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-copy.html', + 'Method copies the specified page.' + )] + public function copy(int $lid, ?int $toSiteId = null, ?int $toFolderId = null): AddedItemResult + { + $params = ['lid' => $lid]; + + if ($toSiteId !== null) { + $params['toSiteId'] = $toSiteId; + } + + if ($toFolderId !== null) { + $params['toFolderId'] = $toFolderId; + } + + return new AddedItemResult( + $this->core->call('landing.landing.copy', $params) + ); + } + + /** + * Deletes a page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-delete.html + * + * @param int $lid Entity identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.delete', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-delete.html', + 'Method for deleting a page.' + )] + public function delete(int $lid): DeletedItemResult + { + return new DeletedItemResult( + $this->core->call('landing.landing.delete', ['lid' => $lid]) + ); + } + + /** + * Updates a page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-update.html + * + * @param int $lid Entity identifier + * @param array $fields Editable fields of the entity + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.update', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-update.html', + 'Method for modifying a page.' + )] + public function update(int $lid, array $fields): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.update', [ + 'lid' => $lid, + 'fields' => $fields + ]) + ); + } + + /** + * Retrieves a list of pages. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-list.html + * + * @param array $select Fields to select + * @param array $filter Filter conditions + * @param array $order Sort order + * @param array $group Group fields + * @param bool $getPreview Return page previews + * @param bool $getUrls Return public addresses of pages + * @param bool $checkArea Return flag IS_AREA indicating whether the page is an included area + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.getList', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-list.html', + 'Method for retrieving a list of pages.' + )] + public function getList( + array $select = [], + array $filter = [], + array $order = [], + array $group = [], + bool $getPreview = false, + bool $getUrls = false, + bool $checkArea = false + ): PagesResult { + $params = []; + + if ($select !== []) { + $params['select'] = $select; + } + + if ($filter !== []) { + $params['filter'] = $filter; + } + + if ($order !== []) { + $params['order'] = $order; + } + + if ($group !== []) { + $params['group'] = $group; + } + + if ($getPreview) { + $params['get_preview'] = 1; + } + + if ($getUrls) { + $params['get_urls'] = 1; + } + + if ($checkArea) { + $params['check_area'] = 1; + } + + return new PagesResult( + $this->core->call('landing.landing.getList', ['params' => $params]) + ); + } + + /** + * Retrieves additional fields of the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-additional-fields.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.getadditionalfields', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-additional-fields.html', + 'Method for obtaining additional fields of the page.' + )] + public function getAdditionalFields(int $lid): PageAdditionalFieldsResult + { + return new PageAdditionalFieldsResult( + $this->core->call('landing.landing.getadditionalfields', ['lid' => $lid]) + ); + } + + /** + * Returns the path to the page preview. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-preview.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.getpreview', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-preview.html', + 'Method returns the path to the page preview.' + )] + public function getPreview(int $lid): PagePreviewResult + { + return new PagePreviewResult( + $this->core->call('landing.landing.getpreview', ['lid' => $lid]) + ); + } + + /** + * Returns the web address of the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-public-url.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.getpublicurl', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-public-url.html', + 'Method returns the web address of the page.' + )] + public function getPublicUrl(int $lid): PagePublicUrlResult + { + return new PagePublicUrlResult( + $this->core->call('landing.landing.getpublicurl', ['lid' => $lid]) + ); + } + + /** + * Returns the page identifier by the provided relative URL. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html + * + * @param string $landingUrl Relative URL of the page + * @param int $siteId Site ID + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.resolveIdByPublicUrl', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html', + 'Method returns the page identifier by the provided relative URL of the page.' + )] + public function resolveIdByPublicUrl(string $landingUrl, int $siteId): PageIdByUrlResult + { + return new PageIdByUrlResult( + $this->core->call('landing.landing.resolveIdByPublicUrl', [ + 'landingUrl' => $landingUrl, + 'siteId' => $siteId + ]) + ); + } + + /** + * Publishes a page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-publication.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.publication', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-publication.html', + 'Method for publishing the page.' + )] + public function publish(int $lid): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.publication', ['lid' => $lid]) + ); + } + + /** + * Unpublishes a page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-unpublic.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.unpublic', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-unpublic.html', + 'Method for unpublishing the page.' + )] + public function unpublish(int $lid): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.unpublic', ['lid' => $lid]) + ); + } + + /** + * Marks the page as deleted. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-delete.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.markDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-delete.html', + 'Method marks the page as deleted.' + )] + public function markDeleted(int $lid): MarkPageDeletedResult + { + return new MarkPageDeletedResult( + $this->core->call('landing.landing.markDelete', ['lid' => $lid]) + ); + } + + /** + * Marks the page as not deleted. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-undelete.html + * + * @param int $lid Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.markUnDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-undelete.html', + 'Method marks the page as not deleted.' + )] + public function markUnDeleted(int $lid): MarkPageUnDeletedResult + { + return new MarkPageUnDeletedResult( + $this->core->call('landing.landing.markUnDelete', ['lid' => $lid]) + ); + } + + /** + * Moves the page to another site and/or folder. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-move.html + * + * @param int $lid Identifier of the page to be moved + * @param int $toSiteId Identifier of the site to which the page should be moved + * @param int|null $toFolderId Optional identifier of the site folder to which the page should be moved + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.move', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-move.html', + 'Method moves the page to another site and/or folder.' + )] + public function move(int $lid, int $toSiteId, ?int $toFolderId = null): UpdatedItemResult + { + $params = [ + 'lid' => $lid, + 'toSiteId' => $toSiteId, + ]; + + if ($toFolderId !== null) { + $params['toFolderId'] = $toFolderId; + } + + return new UpdatedItemResult( + $this->core->call('landing.landing.move', $params) + ); + } + + /** + * Removes related landing entities. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-remove-entities.html + * + * @param int $lid Identifier of the landing + * @param array $data Associative array where key 'blocks' contains blocks to be deleted, + * and key 'images' contains block-image pairs for which images need to be deleted + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.removeEntities', + 'https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-remove-entities.html', + 'Method removes related landing entities.' + )] + public function removeEntities(int $lid, array $data): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.removeEntities', [ + 'lid' => $lid, + 'data' => $data + ]) + ); + } + + /** + * Adds a new block to the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-add-block.html + * + * @param int $lid Page identifier + * @param array $fields Array of block fields: + * - CODE: Symbolic code of the block (required) + * - AFTER_ID: After which block ID the new block should be added (optional) + * - ACTIVE: Block activity Y/N (optional) + * - CONTENT: Entirely different content of the block (optional) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.addblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-add-block.html', + 'Method for adding a new block to the page.' + )] + public function addBlock(int $lid, array $fields): AddedItemResult + { + return new AddedItemResult( + $this->core->call('landing.landing.addblock', [ + 'lid' => $lid, + 'fields' => $fields + ]) + ); + } + + /** + * Copies a block from one page to another. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-copy-block.html + * + * @param int $lid Identifier of the page where the block should be copied + * @param int $block Identifier of the block which may be on another page + * @param array $params Array of parameters, currently supporting AFTER_ID - after which block to insert the new one + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.copyblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-copy-block.html', + 'Method copies a block from one page to another.' + )] + public function copyBlock(int $lid, int $block, array $params = []): AddedItemResult + { + $callParams = [ + 'lid' => $lid, + 'block' => $block, + ]; + + if ($params !== []) { + $callParams['params'] = $params; + } + + return new AddedItemResult( + $this->core->call('landing.landing.copyblock', $callParams) + ); + } + + /** + * Completely removes a block from the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-delete-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.deleteblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-delete-block.html', + 'Method for deleting a block from the page.' + )] + public function deleteBlock(int $lid, int $block): DeletedItemResult + { + return new DeletedItemResult( + $this->core->call('landing.landing.deleteblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Moves a block down one position on the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-down-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.downblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-down-block.html', + 'Method moves a block down one position on the page.' + )] + public function moveBlockDown(int $lid, int $block): BlockMovedResult + { + return new BlockMovedResult( + $this->core->call('landing.landing.downblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Moves a block up one position on the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-up-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.upblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-up-block.html', + 'Method moves a block up one position on the page.' + )] + public function moveBlockUp(int $lid, int $block): BlockMovedResult + { + return new BlockMovedResult( + $this->core->call('landing.landing.upblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Moves a block from one page to another. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-move-block.html + * + * @param int $lid Identifier of the page to which the block should be moved + * @param int $block Identifier of the block which may be on another page + * @param array $params Array of parameters, currently supporting AFTER_ID - after which block to insert the new one + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.moveblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-move-block.html', + 'Method moves a block from one page to another.' + )] + public function moveBlock(int $lid, int $block, array $params = []): BlockMovedResult + { + $callParams = [ + 'lid' => $lid, + 'block' => $block, + ]; + + if ($params !== []) { + $callParams['params'] = $params; + } + + return new BlockMovedResult( + $this->core->call('landing.landing.moveblock', $callParams) + ); + } + + /** + * Hides a block from the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-hide-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.hideblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-hide-block.html', + 'Method hides a block from the page.' + )] + public function hideBlock(int $lid, int $block): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.hideblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Displays a block on the page. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-show-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.showblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-show-block.html', + 'Method displays a block on the page.' + )] + public function showBlock(int $lid, int $block): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.showblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Marks a block as deleted but does not physically remove it. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.markdeletedblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html', + 'Method marks a block as deleted but does not physically remove it.' + )] + public function markBlockDeleted(int $lid, int $block): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.markdeletedblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Restores a block that has been marked as deleted. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.markundeletedblock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html', + 'Method restores a block that has been marked as deleted.' + )] + public function markBlockUnDeleted(int $lid, int $block): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.markundeletedblock', [ + 'lid' => $lid, + 'block' => $block + ]) + ); + } + + /** + * Saves an existing block on the page to "My Blocks". + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-favorite-block.html + * + * @param int $lid Page identifier + * @param int $block Block identifier + * @param array $meta Object containing information to save the block: + * - name: Name of the block + * - section: Array of categories to save the block to + * - preview: Image of the block + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.favoriteBlock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-favorite-block.html', + 'Method saves an existing block on the page to My Blocks.' + )] + public function addBlockToFavorites(int $lid, int $block, array $meta): AddedItemResult + { + return new AddedItemResult( + $this->core->call('landing.landing.favoriteBlock', [ + 'lid' => $lid, + 'block' => $block, + 'meta' => $meta + ]) + ); + } + + /** + * Removes a block that was saved in "My Blocks". + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html + * + * @param int $blockId Block identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.landing.unFavoriteBlock', + 'https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html', + 'Method removes a block that was saved in My Blocks.' + )] + public function removeBlockFromFavorites(int $blockId): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.landing.unFavoriteBlock', [ + 'blockId' => $blockId + ]) + ); + } +} diff --git a/src/Services/Landing/Site/Result/FolderPublishedResult.php b/src/Services/Landing/Site/Result/FolderPublishedResult.php new file mode 100644 index 00000000..5cc9d231 --- /dev/null +++ b/src/Services/Landing/Site/Result/FolderPublishedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class FolderPublishedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/FolderUnpublishedResult.php b/src/Services/Landing/Site/Result/FolderUnpublishedResult.php new file mode 100644 index 00000000..300a48ec --- /dev/null +++ b/src/Services/Landing/Site/Result/FolderUnpublishedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class FolderUnpublishedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/FolderUpdatedResult.php b/src/Services/Landing/Site/Result/FolderUpdatedResult.php new file mode 100644 index 00000000..e7e885c1 --- /dev/null +++ b/src/Services/Landing/Site/Result/FolderUpdatedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class FolderUpdatedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/FoldersResult.php b/src/Services/Landing/Site/Result/FoldersResult.php new file mode 100644 index 00000000..84ecc73c --- /dev/null +++ b/src/Services/Landing/Site/Result/FoldersResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class FoldersResult extends AbstractResult +{ + public function getFolders(): array + { + return $this->getCoreResponse()->getResponseData()->getResult(); + } +} diff --git a/src/Services/Landing/Site/Result/SiteAdditionalFieldsResult.php b/src/Services/Landing/Site/Result/SiteAdditionalFieldsResult.php new file mode 100644 index 00000000..00d505cf --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteAdditionalFieldsResult.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Response\Response; +use Bitrix24\SDK\Core\Result\AbstractResult; + +/** + * Class SiteAdditionalFieldsResult + */ +class SiteAdditionalFieldsResult extends AbstractResult +{ + public function __construct(Response $response) + { + parent::__construct($response); + } + + /** + * Get additional fields data + */ + public function getAdditionalFields(): array + { + return $this->getCoreResponse()->getResponseData()->getResult(); + } +} diff --git a/src/Services/Landing/Site/Result/SiteExportResult.php b/src/Services/Landing/Site/Result/SiteExportResult.php new file mode 100644 index 00000000..caf2f99d --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteExportResult.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Response\Response; +use Bitrix24\SDK\Core\Result\AbstractResult; + +/** + * Class SiteExportResult + */ +class SiteExportResult extends AbstractResult +{ + public function __construct(Response $response) + { + parent::__construct($response); + } + + /** + * Get export data (typically contains download URL or file data) + */ + public function getExportData(): array + { + return $this->getCoreResponse()->getResponseData()->getResult(); + } +} diff --git a/src/Services/Landing/Site/Result/SiteItemResult.php b/src/Services/Landing/Site/Result/SiteItemResult.php new file mode 100644 index 00000000..b71c7e27 --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteItemResult.php @@ -0,0 +1,42 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read int $ID Site identifier + * @property-read string|null $CODE Unique symbolic code of the site + * @property-read string $ACTIVE Site activity: Y / N + * @property-read string $TYPE Type of site (PAGE – regular site, STORE – store) + * @property-read string $DELETED Flag for deleted page: Y / N + * @property-read string $TITLE Title of the site + * @property-read string|null $XML_ID External key for developer needs + * @property-read string|null $DESCRIPTION Arbitrary description of the site + * @property-read string|null $DOMAIN_ID Domain identifier + * @property-read string|null $DOMAIN_NAME Domain of the site + * @property-read int|null $LANDING_ID_INDEX ID of the page designated as the main page of the site + * @property-read int|null $LANDING_ID_404 ID of the page designated as the site's 404 error page + * @property-read int|null $TPL_ID Identifier of the view template + * @property-read string|null $LANG Language identifier for the site + * @property-read int $CREATED_BY_ID Identifier of the user who created it + * @property-read int $MODIFIED_BY_ID Identifier of the user who modified it + * @property-read string $DATE_CREATE Creation date + * @property-read string $DATE_MODIFY Modification date + * @property-read string|null $PUBLIC_URL Public URL of the site + * @property-read string|null $PREVIEW_PICTURE Preview image of the site + */ +class SiteItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Site/Result/SiteMarkedDeletedResult.php b/src/Services/Landing/Site/Result/SiteMarkedDeletedResult.php new file mode 100644 index 00000000..38dbaac5 --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteMarkedDeletedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SiteMarkedDeletedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/SiteMarkedUnDeletedResult.php b/src/Services/Landing/Site/Result/SiteMarkedUnDeletedResult.php new file mode 100644 index 00000000..338fe93d --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteMarkedUnDeletedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SiteMarkedUnDeletedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/SitePublishedResult.php b/src/Services/Landing/Site/Result/SitePublishedResult.php new file mode 100644 index 00000000..ee974d3b --- /dev/null +++ b/src/Services/Landing/Site/Result/SitePublishedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SitePublishedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/SiteUnpublishedResult.php b/src/Services/Landing/Site/Result/SiteUnpublishedResult.php new file mode 100644 index 00000000..d3b99684 --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteUnpublishedResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SiteUnpublishedResult extends AbstractResult +{ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/SiteUrlResult.php b/src/Services/Landing/Site/Result/SiteUrlResult.php new file mode 100644 index 00000000..b5ee9f03 --- /dev/null +++ b/src/Services/Landing/Site/Result/SiteUrlResult.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SiteUrlResult extends AbstractResult +{ + public function getUrl(): string + { + return (string)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Site/Result/SitesResult.php b/src/Services/Landing/Site/Result/SitesResult.php new file mode 100644 index 00000000..238e3168 --- /dev/null +++ b/src/Services/Landing/Site/Result/SitesResult.php @@ -0,0 +1,32 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Result; + +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SitesResult extends AbstractResult +{ + /** + * @return SiteItemResult[] + */ + public function getSites(): array + { + $result = []; + foreach ($this->getCoreResponse()->getResponseData()->getResult() as $site) { + $result[] = new SiteItemResult($site); + } + + return $result; + } +} diff --git a/src/Services/Landing/Site/Service/Site.php b/src/Services/Landing/Site/Service/Site.php new file mode 100644 index 00000000..bd3f2f33 --- /dev/null +++ b/src/Services/Landing/Site/Service/Site.php @@ -0,0 +1,504 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Site\Service; + +use Bitrix24\SDK\Attributes\ApiEndpointMetadata; +use Bitrix24\SDK\Attributes\ApiServiceMetadata; +use Bitrix24\SDK\Core\Contracts\CoreInterface; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Core\Result\AddedItemResult; +use Bitrix24\SDK\Core\Result\UpdatedItemResult; +use Bitrix24\SDK\Core\Result\DeletedItemResult; +use Bitrix24\SDK\Services\AbstractService; +use Bitrix24\SDK\Services\Landing\Site\Result\SitesResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteUrlResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SitePublishedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteUnpublishedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteMarkedDeletedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteMarkedUnDeletedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\FoldersResult; +use Bitrix24\SDK\Services\Landing\Site\Result\FolderUpdatedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\FolderPublishedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\FolderUnpublishedResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteAdditionalFieldsResult; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteExportResult; +use Psr\Log\LoggerInterface; + +#[ApiServiceMetadata(new Scope(['landing']))] +class Site extends AbstractService +{ + public function __construct(CoreInterface $core, LoggerInterface $logger) + { + parent::__construct($core, $logger); + } + + /** + * Adds a site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add.html + * + * @param array $fields Field values for creating a site + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.add', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add.html', + 'Method creates a new site.' + )] + public function add(array $fields): AddedItemResult + { + return new AddedItemResult( + $this->core->call('landing.site.add', ['fields' => $fields]) + ); + } + + /** + * Retrieves a list of sites. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-list.html + * + * @param array $select Fields to select + * @param array $filter Filter conditions + * @param array $order Sort order + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.getList', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-list.html', + 'Method retrieves a list of sites.' + )] + public function getList(array $select = [], array $filter = [], array $order = []): SitesResult + { + $params = []; + if ($select !== []) { + $params['select'] = $select; + } + + if ($filter !== []) { + $params['filter'] = $filter; + } + + if ($order !== []) { + $params['order'] = $order; + } + + return new SitesResult( + $this->core->call('landing.site.getList', ['params' => $params]) + ); + } + + /** + * Updates site parameters. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update.html + * + * @param int $id Site identifier + * @param array $fields Editable fields of the entity + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.update', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update.html', + 'Method makes changes to the site.' + )] + public function update(int $id, array $fields): UpdatedItemResult + { + return new UpdatedItemResult( + $this->core->call('landing.site.update', [ + 'id' => $id, + 'fields' => $fields + ]) + ); + } + + /** + * Deletes a site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-delete.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.delete', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-delete.html', + 'Method deletes a site.' + )] + public function delete(int $id): DeletedItemResult + { + return new DeletedItemResult( + $this->core->call('landing.site.delete', ['id' => $id]) + ); + } + + /** + * Returns the full URL of the site(s). + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-public-url.html + * + * @param int|array $id Site identifier or array of identifiers + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.getPublicUrl', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-public-url.html', + 'Method returns the full URL of the site(s).' + )] + public function getPublicUrl($id): SiteUrlResult + { + return new SiteUrlResult( + $this->core->call('landing.site.getPublicUrl', ['id' => $id]) + ); + } + + /** + * Returns the preview image URL of the site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-preview.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.getPreview', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-preview.html', + 'Method returns the preview image URL of the site.' + )] + public function getPreview(int $id): SiteUrlResult + { + return new SiteUrlResult( + $this->core->call('landing.site.getPreview', ['id' => $id]) + ); + } + + /** + * Publishes the site and all its pages. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.publication', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication.html', + 'Method publishes the site and all its pages.' + )] + public function publication(int $id): SitePublishedResult + { + return new SitePublishedResult( + $this->core->call('landing.site.publication', ['id' => $id]) + ); + } + + /** + * Unpublishes the site and all its pages. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.unpublic', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic.html', + 'Method unpublishes the site and all its pages.' + )] + public function unpublic(int $id): SiteUnpublishedResult + { + return new SiteUnpublishedResult( + $this->core->call('landing.site.unpublic', ['id' => $id]) + ); + } + + /** + * Marks the site as deleted. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-delete.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.markDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-delete.html', + 'Method marks the site as deleted.' + )] + public function markDelete(int $id): SiteMarkedDeletedResult + { + return new SiteMarkedDeletedResult( + $this->core->call('landing.site.markDelete', ['id' => $id]) + ); + } + + /** + * Restores the site from the trash. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-undelete.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.markUnDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-undelete.html', + 'Method restores the site from the trash.' + )] + public function markUnDelete(int $id): SiteMarkedUnDeletedResult + { + return new SiteMarkedUnDeletedResult( + $this->core->call('landing.site.markUnDelete', ['id' => $id]) + ); + } + + /** + * Returns additional fields of the site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-getadditionalfields.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.getAdditionalFields', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-getadditionalfields.html', + 'Method returns additional fields of the site.' + )] + public function getAdditionalFields(int $id): SiteAdditionalFieldsResult + { + return new SiteAdditionalFieldsResult( + $this->core->call('landing.site.getAdditionalFields', ['id' => $id]) + ); + } + + /** + * Exports the site to ZIP archive. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-fullexport.html + * + * @param int $id Site identifier + * @param array $params Optional export parameters + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.fullExport', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-fullexport.html', + 'Method exports the site to ZIP archive.' + )] + public function fullExport(int $id, array $params = []): SiteExportResult + { + $requestParams = ['id' => $id]; + if ($params !== []) { + $requestParams['params'] = $params; + } + + return new SiteExportResult( + $this->core->call('landing.site.fullExport', $requestParams) + ); + } + + /** + * Retrieves the site folders. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-folders.html + * + * @param int $siteId Site identifier + * @param array $filter Optional filter + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.getFolders', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-folders.html', + 'Method retrieves the site folders.' + )] + public function getFolders(int $siteId, array $filter = []): FoldersResult + { + return new FoldersResult( + $this->core->call('landing.site.getFolders', [ + 'siteId' => $siteId, + 'filter' => $filter + ]) + ); + } + + /** + * Adds a folder to the site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add-folder.html + * + * @param int $siteId Site identifier + * @param array $fields Folder fields + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.addFolder', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add-folder.html', + 'Method adds a folder to the site.' + )] + public function addFolder(int $siteId, array $fields): AddedItemResult + { + return new AddedItemResult( + $this->core->call('landing.site.addFolder', [ + 'siteId' => $siteId, + 'fields' => $fields + ]) + ); + } + + /** + * Updates folder parameters. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update-folder.html + * + * @param int $siteId Site identifier + * @param int $id Folder identifier + * @param array $fields Folder fields + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.updateFolder', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update-folder.html', + 'Method updates folder parameters.' + )] + public function updateFolder(int $siteId, int $id, array $fields): FolderUpdatedResult + { + return new FolderUpdatedResult( + $this->core->call('landing.site.updateFolder', [ + 'siteId' => $siteId, + 'folderId' => $id, + 'fields' => $fields + ]) + ); + } + + /** + * Publishes the site's folder. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication-folder.html + * + * @param int $id Folder identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.publicationFolder', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication-folder.html', + "Method publishes the site's folder." + )] + public function publicationFolder(int $id): FolderPublishedResult + { + return new FolderPublishedResult( + $this->core->call('landing.site.publicationFolder', ['folderId' => $id]) + ); + } + + /** + * Unpublishes the site's folder. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic-folder.html + * + * @param int $id Folder identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.unPublicFolder', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic-folder.html', + "Method unpublishes the site's folder." + )] + public function unPublicFolder(int $id): FolderUnpublishedResult + { + return new FolderUnpublishedResult( + $this->core->call('landing.site.unPublicFolder', ['folderId' => $id]) + ); + } + + /** + * Marks the folder as deleted. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-delete.html + * + * @param int $id Folder identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.markFolderDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-delete.html', + 'Method marks the folder as deleted.' + )] + public function markFolderDelete(int $id): DeletedItemResult + { + return new DeletedItemResult( + $this->core->call('landing.site.markFolderDelete', ['id' => $id]) + ); + } + + /** + * Restores the folder from the trash. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-undelete.html + * + * @param int $id Folder identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.site.markFolderUnDelete', + 'https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-undelete.html', + 'Method restores the folder from the trash.' + )] + public function markFolderUnDelete(int $id): DeletedItemResult + { + return new DeletedItemResult( + $this->core->call('landing.site.markFolderUnDelete', ['id' => $id]) + ); + } +} diff --git a/src/Services/Landing/SysPage/Result/SysPageItemResult.php b/src/Services/Landing/SysPage/Result/SysPageItemResult.php new file mode 100644 index 00000000..122d74e2 --- /dev/null +++ b/src/Services/Landing/SysPage/Result/SysPageItemResult.php @@ -0,0 +1,32 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * SysPage item result. Represents a system page with its type and configuration. + * Based on the documentation, each system page item contains: + * + * @property-read non-negative-int $id System page ID + * @property-read string $type Type of system page (mainpage, catalog, personal, cart, order, payment, compare) + * @property-read non-negative-int $siteId Site ID where this system page is configured + * @property-read non-negative-int $pageId Landing page ID that serves as this system page type + * @property-read string $active Whether the system page is active (Y/N) + * @property-read string $url URL of the system page + * @property-read string $title Title of the system page + */ +class SysPageItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/SysPage/Result/SysPageListResult.php b/src/Services/Landing/SysPage/Result/SysPageListResult.php new file mode 100644 index 00000000..ffae7428 --- /dev/null +++ b/src/Services/Landing/SysPage/Result/SysPageListResult.php @@ -0,0 +1,34 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SysPageListResult extends AbstractResult +{ + /** + * @return SysPageItemResult[] + * @throws BaseException + */ + public function getSysPages(): array + { + $res = []; + foreach ($this->getCoreResponse()->getResponseData()->getResult() as $sysPage) { + $res[] = new SysPageItemResult($sysPage); + } + + return $res; + } +} diff --git a/src/Services/Landing/SysPage/Result/SysPageResult.php b/src/Services/Landing/SysPage/Result/SysPageResult.php new file mode 100644 index 00000000..d34e4730 --- /dev/null +++ b/src/Services/Landing/SysPage/Result/SysPageResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SysPageResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/SysPage/Result/SysPageUrlResult.php b/src/Services/Landing/SysPage/Result/SysPageUrlResult.php new file mode 100644 index 00000000..aef8d58c --- /dev/null +++ b/src/Services/Landing/SysPage/Result/SysPageUrlResult.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class SysPageUrlResult extends AbstractResult +{ + /** + * @throws BaseException + */ + public function getUrl(): string + { + return (string)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/SysPage/Service/SysPage.php b/src/Services/Landing/SysPage/Service/SysPage.php new file mode 100644 index 00000000..01f2257b --- /dev/null +++ b/src/Services/Landing/SysPage/Service/SysPage.php @@ -0,0 +1,181 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage\Service; + +use Bitrix24\SDK\Attributes\ApiEndpointMetadata; +use Bitrix24\SDK\Attributes\ApiServiceMetadata; +use Bitrix24\SDK\Core\Contracts\CoreInterface; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\AbstractService; +use Bitrix24\SDK\Services\Landing\SysPage\Result\SysPageResult; +use Bitrix24\SDK\Services\Landing\SysPage\Result\SysPageListResult; +use Bitrix24\SDK\Services\Landing\SysPage\Result\SysPageUrlResult; +use Bitrix24\SDK\Services\Landing\SysPage\SysPageType; +use Psr\Log\LoggerInterface; + +#[ApiServiceMetadata(new Scope(['landing']))] +class SysPage extends AbstractService +{ + public function __construct(CoreInterface $core, LoggerInterface $logger) + { + parent::__construct($core, $logger); + } + + /** + * Sets a special page for the site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-set.html + * + * @param int $siteId Site ID + * @param SysPageType|string $type Type of special page + * @param int|null $pageId Page ID that will be considered of this type within the site. If not provided, the page type will be removed. + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.syspage.set', + 'https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-set.html', + 'Sets a special page for the site.' + )] + public function set(int $siteId, SysPageType|string $type, ?int $pageId = null): SysPageResult + { + $typeValue = $type instanceof SysPageType ? $type->value : $type; + + $params = [ + 'id' => $siteId, + 'type' => $typeValue, + ]; + + if ($pageId !== null) { + $params['lid'] = $pageId; + } + + return new SysPageResult( + $this->core->call('landing.syspage.set', $params) + ); + } + + /** + * Retrieves the list of special pages. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get.html + * + * @param int $siteId Site ID + * @param bool|null $active If true, only active site pages will be returned (default is all) + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.syspage.get', + 'https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get.html', + 'Returns a list of site pages that are set as special.' + )] + public function get(int $siteId, ?bool $active = null): SysPageListResult + { + $params = [ + 'id' => $siteId, + ]; + + if ($active !== null) { + $params['active'] = $active; + } + + return new SysPageListResult( + $this->core->call('landing.syspage.get', $params) + ); + } + + /** + * Retrieves the address of the special page on the site. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get-special-page.html + * + * @param int $siteId Site ID + * @param SysPageType|string $type Type of special page + * @param array|null $additional Optional array of additional parameters to be added to the URL + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.syspage.getSpecialPage', + 'https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get-special-page.html', + 'Returns the address of a special page on the site.' + )] + public function getSpecialPage(int $siteId, SysPageType|string $type, ?array $additional = null): SysPageUrlResult + { + $typeValue = $type instanceof SysPageType ? $type->value : $type; + + $params = [ + 'siteId' => $siteId, + 'type' => $typeValue, + ]; + + if ($additional !== null) { + $params['additional'] = $additional; + } + + return new SysPageUrlResult( + $this->core->call('landing.syspage.getSpecialPage', $params) + ); + } + + /** + * Deletes all mentions of the page as a special one. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html + * + * @param int $pageId Page ID + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.syspage.deleteForLanding', + 'https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html', + 'Deletes all mentions of the page as a special one.' + )] + public function deleteForLanding(int $pageId): SysPageResult + { + return new SysPageResult( + $this->core->call('landing.syspage.deleteForLanding', ['id' => $pageId]) + ); + } + + /** + * Deletes all special pages. + * + * @link https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html + * + * @param int $siteId Site ID + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.syspage.deleteForSite', + 'https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html', + 'Deletes all special pages of the site.' + )] + public function deleteForSite(int $siteId): SysPageResult + { + return new SysPageResult( + $this->core->call('landing.syspage.deleteForSite', ['id' => $siteId]) + ); + } +} diff --git a/src/Services/Landing/SysPage/SysPageType.php b/src/Services/Landing/SysPage/SysPageType.php new file mode 100644 index 00000000..52e9b8d4 --- /dev/null +++ b/src/Services/Landing/SysPage/SysPageType.php @@ -0,0 +1,25 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\SysPage; + +enum SysPageType: string +{ + case mainpage = 'mainpage'; + case catalog = 'catalog'; + case personal = 'personal'; + case cart = 'cart'; + case order = 'order'; + case payment = 'payment'; + case compare = 'compare'; +} diff --git a/src/Services/Landing/Template/Result/TemplateItemResult.php b/src/Services/Landing/Template/Result/TemplateItemResult.php new file mode 100644 index 00000000..dc8ca4ba --- /dev/null +++ b/src/Services/Landing/Template/Result/TemplateItemResult.php @@ -0,0 +1,33 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Template\Result; + +use Bitrix24\SDK\Core\Result\AbstractItem; + +/** + * @property-read non-negative-int $ID Template identifier + * @property-read string $ACTIVE Template activity: Y / N + * @property-read non-negative-int $AREA_COUNT Number of areas besides content + * @property-read non-negative-int $SORT Sorting + * @property-read string $TITLE Title + * @property-read string $XML_ID External code + * @property-read string $CONTENT Template markup + * @property-read non-negative-int $CREATED_BY_ID Identifier of the user who created the template + * @property-read non-negative-int $MODIFIED_BY_ID Identifier of the user who modified the template + * @property-read string $DATE_CREATE Creation date + * @property-read string $DATE_MODIFY Modification date + */ +class TemplateItemResult extends AbstractItem +{ +} diff --git a/src/Services/Landing/Template/Result/TemplateRefSetResult.php b/src/Services/Landing/Template/Result/TemplateRefSetResult.php new file mode 100644 index 00000000..64924f5c --- /dev/null +++ b/src/Services/Landing/Template/Result/TemplateRefSetResult.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Template\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class TemplateRefSetResult extends AbstractResult +{ + /** + * Returns true on success or error on failure + * + * @throws BaseException + */ + public function isSuccess(): bool + { + return (bool)$this->getCoreResponse()->getResponseData()->getResult()[0]; + } +} diff --git a/src/Services/Landing/Template/Result/TemplateRefsResult.php b/src/Services/Landing/Template/Result/TemplateRefsResult.php new file mode 100644 index 00000000..6947a7f9 --- /dev/null +++ b/src/Services/Landing/Template/Result/TemplateRefsResult.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Template\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class TemplateRefsResult extends AbstractResult +{ + /** + * Returns array where keys are included area identifiers and values are page identifiers + * + * @throws BaseException + */ + public function getRefs(): array + { + return $this->getCoreResponse()->getResponseData()->getResult(); + } +} diff --git a/src/Services/Landing/Template/Result/TemplatesResult.php b/src/Services/Landing/Template/Result/TemplatesResult.php new file mode 100644 index 00000000..7808344f --- /dev/null +++ b/src/Services/Landing/Template/Result/TemplatesResult.php @@ -0,0 +1,34 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Template\Result; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Result\AbstractResult; + +class TemplatesResult extends AbstractResult +{ + /** + * @return TemplateItemResult[] + * @throws BaseException + */ + public function getTemplates(): array + { + $res = []; + foreach ($this->getCoreResponse()->getResponseData()->getResult() as $template) { + $res[] = new TemplateItemResult($template); + } + + return $res; + } +} diff --git a/src/Services/Landing/Template/Service/Template.php b/src/Services/Landing/Template/Service/Template.php new file mode 100644 index 00000000..a3c31927 --- /dev/null +++ b/src/Services/Landing/Template/Service/Template.php @@ -0,0 +1,177 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Services\Landing\Template\Service; + +use Bitrix24\SDK\Attributes\ApiEndpointMetadata; +use Bitrix24\SDK\Attributes\ApiServiceMetadata; +use Bitrix24\SDK\Core\Contracts\CoreInterface; +use Bitrix24\SDK\Core\Credentials\Scope; +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\AbstractService; +use Bitrix24\SDK\Services\Landing\Template\Result\TemplatesResult; +use Bitrix24\SDK\Services\Landing\Template\Result\TemplateRefsResult; +use Bitrix24\SDK\Services\Landing\Template\Result\TemplateRefSetResult; +use Psr\Log\LoggerInterface; + +#[ApiServiceMetadata(new Scope(['landing']))] +class Template extends AbstractService +{ + public function __construct(CoreInterface $core, LoggerInterface $logger) + { + parent::__construct($core, $logger); + } + + /** + * Retrieves a list of templates + * + * @link https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-list.html + * + * @param array $select Optional array of fields to select + * @param array $filter Optional array of filter conditions + * @param array $order Optional array of order conditions + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.template.getlist', + 'https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-list.html', + 'Method retrieves a list of templates.' + )] + public function getList(array $select = [], array $filter = [], array $order = []): TemplatesResult + { + $params = []; + if ($select !== []) { + $params['select'] = $select; + } + + if ($filter !== []) { + $params['filter'] = $filter; + } + + if ($order !== []) { + $params['order'] = $order; + } + + $requestParams = []; + if ($params !== []) { + $requestParams['params'] = $params; + } + + return new TemplatesResult( + $this->core->call('landing.template.getlist', $requestParams) + ); + } + + /** + * Retrieves a list of included areas for the page + * + * @link https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-landing-ref.html + * + * @param int $id Page identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.template.getLandingRef', + 'https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-landing-ref.html', + 'Method retrieves a list of included areas for the page. The keys of the returned array are the identifiers of the included areas, and the values are the identifiers of the pages.' + )] + public function getLandingRef(int $id): TemplateRefsResult + { + return new TemplateRefsResult( + $this->core->call('landing.template.getLandingRef', ['id' => $id]) + ); + } + + /** + * Retrieves a list of included areas for the site + * + * @link https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-site-ref.html + * + * @param int $id Site identifier + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.template.getSiteRef', + 'https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-site-ref.html', + 'Method retrieves a list of included areas for the site. The keys of the returned array are the identifiers of the included areas, and the values are the page identifiers.' + )] + public function getSiteRef(int $id): TemplateRefsResult + { + return new TemplateRefsResult( + $this->core->call('landing.template.getSiteRef', ['id' => $id]) + ); + } + + /** + * Sets the included areas for the page + * + * @link https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-landing-ref.html + * + * @param int $id Identifier of the page + * @param array $data Array of data to set (if the array is empty or not provided, the included areas will be reset). The keys of the array are the identifiers of the areas, and the values are the identifiers of the pages that need to be set as the area + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.template.setLandingRef', + 'https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-landing-ref.html', + 'Method sets the included areas for the page within a specific template (the page must already be linked to the template via the TPL_ID field). It will return true on success or an error.' + )] + public function setLandingRef(int $id, array $data = []): TemplateRefSetResult + { + $params = ['id' => $id]; + if ($data !== []) { + $params['data'] = $data; + } + + return new TemplateRefSetResult( + $this->core->call('landing.template.setLandingRef', $params) + ); + } + + /** + * Sets the included areas for the site + * + * @link https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-site-ref.html + * + * @param int $id Site identifier + * @param array $data Array of data to set (if the array is empty or not provided, the included areas will be reset). The keys of the array are the area identifiers, and the values are the identifiers of the pages that need to be set as the area + * + * @throws BaseException + * @throws TransportException + */ + #[ApiEndpointMetadata( + 'landing.template.setSiteRef', + 'https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-site-ref.html', + 'Method sets the included areas for the site within a specific template (the site or page must already be linked to the template via the TPL_ID field). It will return true on success or an error.' + )] + public function setSiteRef(int $id, array $data = []): TemplateRefSetResult + { + $params = ['id' => $id]; + if ($data !== []) { + $params['data'] = $data; + } + + return new TemplateRefSetResult( + $this->core->call('landing.template.setSiteRef', $params) + ); + } +} diff --git a/src/Services/ServiceBuilder.php b/src/Services/ServiceBuilder.php index ec786a99..744e9b3a 100644 --- a/src/Services/ServiceBuilder.php +++ b/src/Services/ServiceBuilder.php @@ -33,6 +33,7 @@ use Bitrix24\SDK\Services\Placement\PlacementServiceBuilder; use Bitrix24\SDK\Services\Workflows\WorkflowsServiceBuilder; use Bitrix24\SDK\Services\Sale\SaleServiceBuilder; +use Bitrix24\SDK\Services\Landing\LandingServiceBuilder; use Bitrix24\SDK\Services\Calendar\CalendarServiceBuilder; use Bitrix24\SDK\Services\Paysystem\PaysystemServiceBuilder; use Psr\Log\LoggerInterface; @@ -62,6 +63,20 @@ public function getSaleScope(): SaleServiceBuilder return $this->serviceCache[__METHOD__]; } + public function getLandingScope(): LandingServiceBuilder + { + if (!isset($this->serviceCache[__METHOD__])) { + $this->serviceCache[__METHOD__] = new LandingServiceBuilder( + $this->core, + $this->batch, + $this->bulkItemsReader, + $this->log + ); + } + + return $this->serviceCache[__METHOD__]; + } + public function getCalendarScope(): CalendarServiceBuilder { if (!isset($this->serviceCache[__METHOD__])) { diff --git a/tests/Integration/Services/Landing/Block/Service/BlockTest.php b/tests/Integration/Services/Landing/Block/Service/BlockTest.php new file mode 100644 index 00000000..52ee4557 --- /dev/null +++ b/tests/Integration/Services/Landing/Block/Service/BlockTest.php @@ -0,0 +1,792 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Tests\Integration\Services\Landing\Block\Service; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockContentItemResult; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockItemResult; +use Bitrix24\SDK\Services\Landing\Block\Result\BlockManifestItemResult; +use Bitrix24\SDK\Services\Landing\Block\Service\Block; +use Bitrix24\SDK\Services\Landing\Page\Service\Page; +use Bitrix24\SDK\Services\Landing\Site\Service\Site; +use Bitrix24\SDK\Tests\CustomAssertions\CustomBitrix24Assertions; +use Bitrix24\SDK\Tests\Integration\Fabric; +use PHPUnit\Framework\Attributes\CoversMethod; +use PHPUnit\Framework\TestCase; + +/** + * Class BlockTest + * + * @package Bitrix24\SDK\Tests\Integration\Services\Landing\Block\Service + */ +#[CoversMethod(Block::class, 'list')] +#[CoversMethod(Block::class, 'getById')] +#[CoversMethod(Block::class, 'getContent')] +#[CoversMethod(Block::class, 'getManifest')] +#[CoversMethod(Block::class, 'getRepository')] +#[CoversMethod(Block::class, 'getManifestFile')] +#[CoversMethod(Block::class, 'getContentFromRepository')] +#[CoversMethod(Block::class, 'updateNodes')] +#[CoversMethod(Block::class, 'updateAttrs')] +#[CoversMethod(Block::class, 'updateStyles')] +#[CoversMethod(Block::class, 'updateContent')] +#[CoversMethod(Block::class, 'updateCards')] +#[CoversMethod(Block::class, 'cloneCard')] +#[CoversMethod(Block::class, 'addCard')] +#[CoversMethod(Block::class, 'removeCard')] +#[CoversMethod(Block::class, 'uploadFile')] +#[CoversMethod(Block::class, 'changeAnchor')] +#[CoversMethod(Block::class, 'changeNodeName')] +#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Services\Landing\Block\Service\Block::class)] +class BlockTest extends TestCase +{ + use CustomBitrix24Assertions; + + protected Block $blockService; + + protected Page $pageService; + + protected Site $siteService; + + protected array $createdPageIds = []; + + protected array $createdSiteIds = []; + + protected function setUp(): void + { + $serviceBuilder = Fabric::getServiceBuilder(); + $this->blockService = $serviceBuilder->getLandingScope()->block(); + $this->pageService = $serviceBuilder->getLandingScope()->page(); + $this->siteService = $serviceBuilder->getLandingScope()->site(); + } + + protected function tearDown(): void + { + // Clean up created pages + foreach ($this->createdPageIds as $createdPageId) { + try { + $this->pageService->delete($createdPageId); + } catch (\Exception) { + // Ignore if page doesn't exist + } + } + + // Clean up created sites + foreach ($this->createdSiteIds as $createdSiteId) { + try { + $this->siteService->delete($createdSiteId); + } catch (\Exception) { + // Ignore if site doesn't exist + } + } + } + + /** + * Helper method to create a test site + */ + protected function createTestSite(): int + { + $siteFields = [ + 'TITLE' => 'Test Site for Block ' . time(), + 'CODE' => 'testsiteblock' . time(), + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + return $siteId; + } + + /** + * Helper method to create a test page with blocks + */ + protected function createTestPageWithBlocks(): int + { + $siteId = $this->createTestSite(); + + // Get available page templates + $core = Fabric::getCore(); + $templatesResponse = $core->call('landing.demos.getPageList', ['type' => 'page']); + $templates = $templatesResponse->getResponseData()->getResult(); + + // Use the first available template to get a page with blocks + $templateCode = key($templates); + + $addedItemResult = $this->pageService->addByTemplate( + $siteId, + $templateCode, + [ + 'TITLE' => 'Test Page with Blocks ' . time(), + 'DESCRIPTION' => 'Test page for block operations' + ] + ); + + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + return $pageId; + } + + /** + * Helper method to add a text block to page if no suitable blocks exist + */ + protected function ensurePageHasTextBlock(int $pageId): array + { + // First try to find existing block with nodes + $blockWithNodes = $this->findBlockWithNodes($pageId); + if ($blockWithNodes !== null) { + return $blockWithNodes; + } + + // If no suitable block found, use any first block and fallback to standard selectors + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + if ($blocks !== []) { + return [ + 'blockId' => $blocks[0]->id, + 'nodeSelectors' => ['.landing-block-node-text'], + 'manifest' => null + ]; + } + + // This should never happen with template pages, but just in case + throw new \RuntimeException('No blocks found on page and unable to add new blocks'); + } + + /** + * Helper method to add a card block to page if no suitable blocks exist + */ + protected function ensurePageHasCardBlock(int $pageId): array + { + // First try to find existing block with cards + $blockWithCards = $this->findBlockWithCards($pageId); + if ($blockWithCards !== null) { + return $blockWithCards; + } + + // If no suitable block found, use any first block and fallback to standard selectors + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + if ($blocks !== []) { + return [ + 'blockId' => $blocks[0]->id, + 'cardSelector' => '.landing-block-card', + 'manifest' => null + ]; + } + + // This should never happen with template pages, but just in case + throw new \RuntimeException('No blocks found on page and unable to add new blocks'); + } + + /** + * Helper method to find a block with cards from its manifest + */ + protected function findBlockWithCards(int $pageId): ?array + { + // Get blocks list for the page + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + foreach ($blocks as $block) { + try { + // Get manifest for this block + $manifestResult = $this->blockService->getManifest($pageId, $block->id, ['edit_mode' => 1]); + $manifest = $manifestResult->getManifest(); + + // Check if block has cards in manifest + if (!empty($manifest->cards) && is_array($manifest->cards)) { + // Return first card selector found + $cardSelector = key($manifest->cards); + if ($cardSelector !== 0 && ($cardSelector !== '' && $cardSelector !== '0')) { + return [ + 'blockId' => $block->id, + 'cardSelector' => $cardSelector, + 'manifest' => $manifest + ]; + } + } + } catch (\Exception) { + // Skip blocks that can't provide manifest or don't have cards + continue; + } + } + + return null; + } + + /** + * Helper method to find a block with specific node selectors + */ + protected function findBlockWithNodes(int $pageId, array $requiredNodeTypes = []): ?array + { + // Get blocks list for the page + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + foreach ($blocks as $block) { + try { + // Get manifest for this block + $manifestResult = $this->blockService->getManifest($pageId, $block->id, ['edit_mode' => 1]); + $manifest = $manifestResult->getManifest(); + + // Check if block has nodes in manifest + if (!empty($manifest->nodes) && is_array($manifest->nodes)) { + $nodeSelectors = array_keys($manifest->nodes); + + // If specific node types required, check for them + if ($requiredNodeTypes !== []) { + $hasRequiredNodes = false; + foreach ($nodeSelectors as $nodeSelector) { + foreach ($requiredNodeTypes as $requiredNodeType) { + if (str_contains($nodeSelector, (string) $requiredNodeType)) { + $hasRequiredNodes = true; + break 2; + } + } + } + + if (!$hasRequiredNodes) { + continue; + } + } + + return [ + 'blockId' => $block->id, + 'nodeSelectors' => $nodeSelectors, + 'manifest' => $manifest + ]; + } + } catch (\Exception) { + // Skip blocks that can't provide manifest + continue; + } + } + + return null; + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testList(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Test getting blocks list for the page + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertIsArray($blocks); + + if ($blocks !== []) { + $firstBlock = $blocks[0]; + self::assertInstanceOf(BlockItemResult::class, $firstBlock); + self::assertGreaterThan(0, $firstBlock->id); + self::assertEquals($pageId, $firstBlock->lid); + } + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetById(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test getting block by ID + $blockResult = $this->blockService->getById($blockId, ['edit_mode' => 1]); + $blockItemResult = $blockResult->getBlock(); + + self::assertInstanceOf(BlockItemResult::class, $blockItemResult); + self::assertEquals($blockId, $blockItemResult->id); + self::assertEquals($pageId, $blockItemResult->lid); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetContent(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test getting block content + $blockContentResult = $this->blockService->getContent($pageId, $blockId, 1, ['wrapper_show' => 1]); + $blockContentItemResult = $blockContentResult->getContent(); + + // Check that a typed object is returned + self::assertInstanceOf(BlockContentItemResult::class, $blockContentItemResult); + + // Check required fields + self::assertIsInt($blockContentItemResult->id); + self::assertIsString($blockContentItemResult->sections); + self::assertIsBool($blockContentItemResult->active); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetManifest(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test getting block manifest + $blockManifestResult = $this->blockService->getManifest($pageId, $blockId, ['edit_mode' => 1]); + $blockManifestItemResult = $blockManifestResult->getManifest(); + + // Check that a typed object is returned + self::assertInstanceOf(BlockManifestItemResult::class, $blockManifestItemResult); + + // Check required fields + self::assertIsArray($blockManifestItemResult->block); + self::assertIsArray($blockManifestItemResult->cards); + self::assertIsArray($blockManifestItemResult->nodes); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetRepository(): void + { + // Test getting blocks from repository + $repositoryResult = $this->blockService->getRepository('about'); + $repositoryItemResult = $repositoryResult->getRepository(); + + self::assertInstanceOf(\Bitrix24\SDK\Services\Landing\Block\Result\RepositoryItemResult::class, $repositoryItemResult); + self::assertNotEmpty($repositoryItemResult->name, 'Repository name must not be empty'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetManifestFile(): void + { + // Get repository blocks + $repositoryResult = $this->blockService->getRepository('about'); + $repositoryItemResult = $repositoryResult->getRepository(); + + self::assertInstanceOf(\Bitrix24\SDK\Services\Landing\Block\Result\RepositoryItemResult::class, $repositoryItemResult); + + // Get block code from first item in the repository + self::assertNotEmpty($repositoryItemResult->items, 'Repository must have items'); + $blockCode = key($repositoryItemResult->items); + if ($blockCode === null) { + $blockCode = 'bitrix:landing.blocks.html_text'; + } + + // Test getting manifest from repository + $blockManifestResult = $this->blockService->getManifestFile($blockCode); + $blockManifestItemResult = $blockManifestResult->getManifest(); + + self::assertInstanceOf(\Bitrix24\SDK\Services\Landing\Block\Result\BlockManifestItemResult::class, $blockManifestItemResult); + self::assertNotEmpty($blockManifestItemResult->block, 'Manifest block must not be empty'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetContentFromRepository(): void + { + // Get repository blocks first + $repositoryResult = $this->blockService->getRepository('about'); + $repositoryItemResult = $repositoryResult->getRepository(); + + self::assertInstanceOf(\Bitrix24\SDK\Services\Landing\Block\Result\RepositoryItemResult::class, $repositoryItemResult); + + // Get block code from first item in the repository + self::assertNotEmpty($repositoryItemResult->items, 'Repository must have items'); + $blockCode = key($repositoryItemResult->items); + if ($blockCode === null) { + $blockCode = 'bitrix:landing.blocks.html_text'; + } + + // Test getting content from repository + $repositoryContentResult = $this->blockService->getContentFromRepository($blockCode); + $content = $repositoryContentResult->getContent(); + + self::assertIsString($content); + self::assertNotEmpty($content, 'Content must not be empty'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateNodes(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Ensure page has a block with text nodes (find existing or create new) + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + + $blockId = $blockWithNodes['blockId']; + $nodeSelectors = $blockWithNodes['nodeSelectors']; + + // Use first available node selector + $firstNodeSelector = $nodeSelectors[0]; + + // Test updating block nodes with real selector + $updateData = [ + $firstNodeSelector => 'Updated text content ' . time() + ]; + + $updateResult = $this->blockService->updateNodes($pageId, $blockId, $updateData); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateStyles(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Ensure page has a block with text nodes (find existing or create new) + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + + $blockId = $blockWithNodes['blockId']; + $nodeSelectors = $blockWithNodes['nodeSelectors']; + + // Use first available node selector + $firstNodeSelector = $nodeSelectors[0]; + + // Test updating block styles with real selector + $styleData = [ + $firstNodeSelector => [ + 'classList' => ['landing-block-node-text', 'g-color-primary'], + 'affect' => ['color'] + ] + ]; + + $updateResult = $this->blockService->updateStyles($pageId, $blockId, $styleData); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUploadFile(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test uploading a file (using a simple base64 encoded 1x1 pixel image) + $imageData = [ + 'test.png', + 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChAI9jgvKNQAAAABJRU5ErkJggg==' + ]; + + $uploadFileResult = $this->blockService->uploadFile($blockId, $imageData); + + // Check new typed methods + self::assertIsInt($uploadFileResult->getId()); + self::assertIsString($uploadFileResult->getUrl()); + self::assertNotEmpty($uploadFileResult->getUrl()); + + // Check deprecated methods for backward compatibility + self::assertEquals($uploadFileResult->getId(), $uploadFileResult->getFileId()); + self::assertEquals($uploadFileResult->getUrl(), $uploadFileResult->getFilePath()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testChangeAnchor(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test changing anchor + $newAnchor = 'test-anchor-' . time(); + $updateResult = $this->blockService->changeAnchor($pageId, $blockId, $newAnchor); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateAttrs(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Ensure page has a block with text nodes (find existing or create new) + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + + $blockId = $blockWithNodes['blockId']; + $nodeSelectors = $blockWithNodes['nodeSelectors']; + + // Use first available node selector + $firstNodeSelector = $nodeSelectors[0]; + + // Test updating block attributes with real selector + $attrsData = [ + $firstNodeSelector => [ + 'href' => 'https://example.com', + 'target' => '_blank' + ] + ]; + + $updateResult = $this->blockService->updateAttrs($pageId, $blockId, $attrsData); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateContent(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Get blocks list first to get a block ID + $blocksResult = $this->blockService->list($pageId, ['edit_mode' => 1]); + $blocks = $blocksResult->getBlocks(); + + self::assertNotEmpty($blocks, 'Page must have blocks for this test'); + + $blockId = $blocks[0]->id; + + // Test updating block content with arbitrary content + $newContent = '
Updated content ' . time() . '
'; + + $updateResult = $this->blockService->updateContent($pageId, $blockId, $newContent); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateCards(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Try to find a block with cards, fallback to text block + $blockWithCards = $this->findBlockWithCards($pageId); + + if ($blockWithCards !== null) { + $blockId = $blockWithCards['blockId']; + $cardSelector = $blockWithCards['cardSelector']; + } else { + // Fallback: use text block and try card operations + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + $blockId = $blockWithNodes['blockId']; + $cardSelector = '.landing-block-card'; + } + + // Get a node selector + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + $nodeSelector = $blockWithNodes['nodeSelectors'][0]; + + // Test bulk updating block cards with selectors + $cardsData = [ + $cardSelector . '@0' => [ + $nodeSelector => 'Updated card text ' . time() + ] + ]; + + // This may fail if block doesn't support cards, but that's ok for testing + $updateResult = $this->blockService->updateCards($pageId, $blockId, $cardsData); + $isSuccess = $updateResult->isSuccess(); + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testCloneCard(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Try to find a block with cards, fallback to any block + $blockWithCards = $this->findBlockWithCards($pageId); + + if ($blockWithCards !== null) { + $blockId = $blockWithCards['blockId']; + $cardSelector = $blockWithCards['cardSelector']; + } else { + // Fallback: use any block and try card operations + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + $blockId = $blockWithNodes['blockId']; + $cardSelector = '.landing-block-card'; + } + + // Test cloning a block card - this may fail if block doesn't support cards + $updateResult = $this->blockService->cloneCard($pageId, $blockId, $cardSelector); + $isSuccess = $updateResult->isSuccess(); + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAddCard(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Try to find a block with cards, fallback to any block + $blockWithCards = $this->findBlockWithCards($pageId); + + if ($blockWithCards !== null) { + $blockId = $blockWithCards['blockId']; + $cardSelector = $blockWithCards['cardSelector']; + } else { + // Fallback: use any block and try card operations + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + $blockId = $blockWithNodes['blockId']; + $cardSelector = '.landing-block-card'; + } + + // Test adding a card with modified content + $content = '
New card content ' . time() . '
'; + + // This may fail if block doesn't support cards, but that's ok for testing + $updateResult = $this->blockService->addCard($pageId, $blockId, $cardSelector, $content); + $isSuccess = $updateResult->isSuccess(); + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testRemoveCard(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Try to find a block with cards, fallback to any block + $blockWithCards = $this->findBlockWithCards($pageId); + + if ($blockWithCards !== null) { + $blockId = $blockWithCards['blockId']; + $cardSelector = $blockWithCards['cardSelector']; + + // First clone a card to have something to remove + $this->blockService->cloneCard($pageId, $blockId, $cardSelector); + + // Test removing a block card - target the cloned card (should be index 1) + $removeSelector = $cardSelector . '@1'; + $updateResult = $this->blockService->removeCard($pageId, $blockId, $removeSelector); + $isSuccess = $updateResult->isSuccess(); + self::assertTrue($isSuccess); + + return; + } + + // Fallback: use any block and try card operations + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + $blockId = $blockWithNodes['blockId']; + $cardSelector = '.landing-block-card'; + + // Test removing a card - this may fail if block doesn't support cards + $removeSelector = $cardSelector . '@0'; + $updateResult = $this->blockService->removeCard($pageId, $blockId, $removeSelector); + $isSuccess = $updateResult->isSuccess(); + self::assertTrue($isSuccess); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testChangeNodeName(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Ensure page has a block with text nodes (find existing or create new) + $blockWithNodes = $this->ensurePageHasTextBlock($pageId); + + $blockId = $blockWithNodes['blockId']; + $nodeSelectors = $blockWithNodes['nodeSelectors']; + + // Use first available node selector + $firstNodeSelector = $nodeSelectors[0]; + + // Test changing tag name using data array format with real selector + $data = [ + $firstNodeSelector => 'h2' + ]; + + $updateResult = $this->blockService->changeNodeName($pageId, $blockId, $data); + $isSuccess = $updateResult->isSuccess(); + + self::assertTrue($isSuccess); + } +} diff --git a/tests/Integration/Services/Landing/Page/Service/PageTest.php b/tests/Integration/Services/Landing/Page/Service/PageTest.php new file mode 100644 index 00000000..bb52556c --- /dev/null +++ b/tests/Integration/Services/Landing/Page/Service/PageTest.php @@ -0,0 +1,889 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Tests\Integration\Services\Landing\Page\Service; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\Landing\Page\Result\PageItemResult; +use Bitrix24\SDK\Services\Landing\Page\Service\Page; +use Bitrix24\SDK\Services\Landing\Site\Service\Site; +use Bitrix24\SDK\Tests\CustomAssertions\CustomBitrix24Assertions; +use Bitrix24\SDK\Tests\Integration\Fabric; +use PHPUnit\Framework\Attributes\CoversMethod; +use PHPUnit\Framework\TestCase; + +/** + * Class PageTest + * + * @package Bitrix24\SDK\Tests\Integration\Services\Landing\Page\Service + */ +#[CoversMethod(Page::class, 'add')] +#[CoversMethod(Page::class, 'addByTemplate')] +#[CoversMethod(Page::class, 'copy')] +#[CoversMethod(Page::class, 'delete')] +#[CoversMethod(Page::class, 'update')] +#[CoversMethod(Page::class, 'getList')] +#[CoversMethod(Page::class, 'getAdditionalFields')] +#[CoversMethod(Page::class, 'getPreview')] +#[CoversMethod(Page::class, 'getPublicUrl')] +#[CoversMethod(Page::class, 'resolveIdByPublicUrl')] +#[CoversMethod(Page::class, 'publish')] +#[CoversMethod(Page::class, 'unpublish')] +#[CoversMethod(Page::class, 'markDeleted')] +#[CoversMethod(Page::class, 'markUnDeleted')] +#[CoversMethod(Page::class, 'move')] +#[CoversMethod(Page::class, 'removeEntities')] +#[CoversMethod(Page::class, 'addBlock')] +#[CoversMethod(Page::class, 'copyBlock')] +#[CoversMethod(Page::class, 'deleteBlock')] +#[CoversMethod(Page::class, 'moveBlockDown')] +#[CoversMethod(Page::class, 'moveBlockUp')] +#[CoversMethod(Page::class, 'moveBlock')] +#[CoversMethod(Page::class, 'hideBlock')] +#[CoversMethod(Page::class, 'showBlock')] +#[CoversMethod(Page::class, 'markBlockDeleted')] +#[CoversMethod(Page::class, 'markBlockUnDeleted')] +#[CoversMethod(Page::class, 'addBlockToFavorites')] +#[CoversMethod(Page::class, 'removeBlockFromFavorites')] +#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Services\Landing\Page\Service\Page::class)] +class PageTest extends TestCase +{ + use CustomBitrix24Assertions; + + protected Page $pageService; + + protected Site $siteService; + + protected array $createdPageIds = []; + + protected array $createdSiteIds = []; + + protected function setUp(): void + { + $serviceBuilder = Fabric::getServiceBuilder(); + $this->pageService = $serviceBuilder->getLandingScope()->page(); + $this->siteService = $serviceBuilder->getLandingScope()->site(); + } + + protected function tearDown(): void + { + // Clean up created pages + foreach ($this->createdPageIds as $createdPageId) { + try { + $this->pageService->delete($createdPageId); + } catch (\Exception) { + // Ignore if page doesn't exist + } + } + + // Clean up created sites + foreach ($this->createdSiteIds as $createdSiteId) { + try { + $this->siteService->delete($createdSiteId); + } catch (\Exception) { + // Ignore if site doesn't exist + } + } + } + + /** + * Helper method to create a test site + */ + protected function createTestSite(): int + { + $siteFields = [ + 'TITLE' => 'Test Site for Page ' . time(), + 'CODE' => 'testsitepage' . time(), + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + return $siteId; + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAdd(): void + { + $siteId = $this->createTestSite(); + + $pageFields = [ + 'TITLE' => 'Test Page ' . time(), + 'CODE' => 'testpage' . time(), + 'SITE_ID' => $siteId, + 'ADDITIONAL_FIELDS' => [ + 'THEME_CODE' => 'wedding' + ] + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + self::assertGreaterThan(0, $pageId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAddByTemplate(): void + { + $siteId = $this->createTestSite(); + + // Get available page templates from portal + $core = Fabric::getCore(); + $templatesResponse = $core->call('landing.demos.getPageList', ['type' => 'page']); + $templates = $templatesResponse->getResponseData()->getResult(); + + // Use the first available template + $templateCode = key($templates); + + $addedItemResult = $this->pageService->addByTemplate( + $siteId, + $templateCode, + [ + 'TITLE' => 'Test Page by Template ' . time(), + 'DESCRIPTION' => 'Test page description' + ] + ); + + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + self::assertGreaterThan(0, $pageId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetList(): void + { + $siteId = $this->createTestSite(); + + // First create a test page + $timestamp = time(); + $pageFields = [ + 'TITLE' => 'Test Page for List ' . $timestamp, + 'CODE' => 'testpagelist' . $timestamp, + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Test getList with no parameters + $pagesResult = $this->pageService->getList(); + $pages = $pagesResult->getPages(); + + self::assertIsArray($pages); + self::assertNotEmpty($pages); + + // Check that our created page is in the list + $foundPage = null; + foreach ($pages as $page) { + self::assertInstanceOf(PageItemResult::class, $page); + if (intval($page->ID) === $pageId) { + $foundPage = $page; + break; + } + } + + self::assertNotNull($foundPage, 'Created page should be found in the list'); + self::assertEquals($pageFields['TITLE'], $foundPage->TITLE); + self::assertStringContainsString($pageFields['CODE'], $foundPage->CODE); + self::assertEquals($pageFields['SITE_ID'], $foundPage->SITE_ID); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetListWithFilters(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $timestamp = time(); + $pageFields = [ + 'TITLE' => 'Test Page Filter ' . $timestamp, + 'CODE' => 'testpagefilter' . $timestamp, + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Test getList with filters + $pagesResult = $this->pageService->getList( + ['ID', 'TITLE', 'CODE', 'SITE_ID'], + ['SITE_ID' => $siteId], + ['ID' => 'DESC'] + ); + + $pages = $pagesResult->getPages(); + + self::assertIsArray($pages); + + // All pages should belong to our site + foreach ($pages as $page) { + self::assertEquals($siteId, $page->SITE_ID); + } + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdate(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page for Update ' . time(), + 'CODE' => 'testpageupdate' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Update the page + $newTitle = 'Updated Page Title ' . time(); + $updatedItemResult = $this->pageService->update($pageId, [ + 'TITLE' => $newTitle + ]); + + self::assertTrue($updatedItemResult->isSuccess()); + + // Verify the update + $pagesResult = $this->pageService->getList(['ID', 'TITLE'], ['ID' => $pageId]); + $pages = $pagesResult->getPages(); + + self::assertCount(1, $pages); + self::assertEquals($newTitle, $pages[0]->TITLE); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testCopy(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page for Copy ' . time(), + 'CODE' => 'testpagecopy' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $originalPageId = $addedItemResult->getId(); + $this->createdPageIds[] = $originalPageId; + + // Copy the page + $copyResult = $this->pageService->copy($originalPageId); + $copiedPageId = $copyResult->getId(); + $this->createdPageIds[] = $copiedPageId; + + self::assertGreaterThan(0, $copiedPageId); + self::assertNotEquals($originalPageId, $copiedPageId); + + // Verify both pages exist + $pagesResult = $this->pageService->getList(['ID', 'TITLE'], ['SITE_ID' => $siteId]); + $pages = $pagesResult->getPages(); + + $pageIds = array_map(fn($page): int => intval($page->ID), $pages); + self::assertContains($originalPageId, $pageIds); + self::assertContains($copiedPageId, $pageIds); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetAdditionalFields(): void + { + $siteId = $this->createTestSite(); + + // Create a test page with additional fields + $pageFields = [ + 'TITLE' => 'Test Page Additional Fields ' . time(), + 'CODE' => 'testpageadditional' . time(), + 'SITE_ID' => $siteId, + 'ADDITIONAL_FIELDS' => [ + 'THEME_CODE' => 'wedding', + 'METAMAIN_TITLE' => 'Test Meta Title' + ] + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Get additional fields + $pageAdditionalFieldsResult = $this->pageService->getAdditionalFields($pageId); + $additionalFields = $pageAdditionalFieldsResult->getAdditionalFields(); + + self::assertIsArray($additionalFields); + // Note: The exact structure depends on API response format + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetPreview(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Preview ' . time(), + 'CODE' => 'testpagepreview' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Get preview + $pagePreviewResult = $this->pageService->getPreview($pageId); + $previewPath = $pagePreviewResult->getPreviewPath(); + + self::assertIsString($previewPath); + // Preview path might be empty or contain URL + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetPublicUrl(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Public URL ' . time(), + 'CODE' => 'testpagepublicurl' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Get public URL + $pagePublicUrlResult = $this->pageService->getPublicUrl($pageId); + $publicUrl = $pagePublicUrlResult->getPublicUrl(); + + self::assertIsString($publicUrl); + // Public URL might be empty until published + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testPublishAndUnpublish(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Publish ' . time(), + 'CODE' => 'testpagepublish' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Publish the page + $updatedItemResult = $this->pageService->publish($pageId); + self::assertTrue($updatedItemResult->isSuccess()); + + // Unpublish the page + $unpublishResult = $this->pageService->unpublish($pageId); + self::assertTrue($unpublishResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMarkDeletedAndUnDeleted(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Mark Delete ' . time(), + 'CODE' => 'testpagemarkdelete' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Mark as deleted + $markPageDeletedResult = $this->pageService->markDeleted($pageId); + self::assertTrue($markPageDeletedResult->isSuccess()); + + // Mark as undeleted + $markPageUnDeletedResult = $this->pageService->markUnDeleted($pageId); + self::assertTrue($markPageUnDeletedResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMove(): void + { + $sourceSiteId = $this->createTestSite(); + $targetSiteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Move ' . time(), + 'CODE' => 'testpagemove' . time(), + 'SITE_ID' => $sourceSiteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Move the page to another site + $updatedItemResult = $this->pageService->move($pageId, $targetSiteId); + self::assertTrue($updatedItemResult->isSuccess()); + + // Verify the page is now in the target site + $pagesResult = $this->pageService->getList(['ID', 'SITE_ID'], ['ID' => $pageId]); + $pages = $pagesResult->getPages(); + + self::assertCount(1, $pages); + self::assertEquals($targetSiteId, $pages[0]->SITE_ID); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testRemoveEntities(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Remove Entities ' . time(), + 'CODE' => 'testpageremove' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Remove entities (empty data for test) + $updatedItemResult = $this->pageService->removeEntities($pageId, [ + 'blocks' => [], + 'images' => [] + ]); + + self::assertTrue($updatedItemResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testResolveIdByPublicUrl(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $timestamp = time(); + $pageCode = 'testpageresolve' . $timestamp; + $pageFields = [ + 'TITLE' => 'Test Page Resolve ' . $timestamp, + 'CODE' => $pageCode, + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + // Try to resolve ID by URL + $pageIdByUrlResult = $this->pageService->resolveIdByPublicUrl('/' . $pageCode . '/', $siteId); + $resolvedPageId = $pageIdByUrlResult->getPageId(); + self::assertEquals($pageId, $resolvedPageId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testDelete(): void + { + $siteId = $this->createTestSite(); + + // Create a test page + $pageFields = [ + 'TITLE' => 'Test Page Delete ' . time(), + 'CODE' => 'testpagedelete' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + + // Delete the page + $deletedItemResult = $this->pageService->delete($pageId); + self::assertTrue($deletedItemResult->isSuccess()); + + // Remove from cleanup list as it's already deleted + $this->createdPageIds = array_filter($this->createdPageIds, fn($id): bool => $id !== $pageId); + + // Verify page is deleted by trying to get it + $pagesResult = $this->pageService->getList(['ID'], ['ID' => $pageId]); + $pages = $pagesResult->getPages(); + self::assertEmpty($pages, 'Page should be deleted and not found in list'); + } + + /** + * Helper method to create a test page with blocks + */ + protected function createTestPageWithBlocks(): int + { + $siteId = $this->createTestSite(); + + $pageFields = [ + 'TITLE' => 'Test Page for Blocks ' . time(), + 'CODE' => 'testpageblocks' . time(), + 'SITE_ID' => $siteId + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + + $this->createdPageIds[] = $pageId; + + return $pageId; + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAddBlock(): void + { + $pageId = $this->createTestPageWithBlocks(); + + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields); + $blockId = $addedItemResult->getId(); + + self::assertGreaterThan(0, $blockId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testCopyBlock(): void + { + $pageId1 = $this->createTestPageWithBlocks(); + $pageId2 = $this->createTestPageWithBlocks(); + + // First add a block to the first page + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId1, $blockFields); + $originalBlockId = $addedItemResult->getId(); + + // Copy the block to the second page + $blockCopiedResult = $this->pageService->copyBlock($pageId2, $originalBlockId); + $copiedBlockId = $blockCopiedResult->getId(); + + self::assertGreaterThan(0, $copiedBlockId); + self::assertNotEquals($originalBlockId, $copiedBlockId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testHideAndShowBlock(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Add a block + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields); + $blockId = $addedItemResult->getId(); + + // Hide the block + $updatedItemResult = $this->pageService->hideBlock($pageId, $blockId); + self::assertTrue($updatedItemResult->isSuccess()); + + // Show the block + $showResult = $this->pageService->showBlock($pageId, $blockId); + self::assertTrue($showResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMoveBlockUpAndDown(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Add two blocks + $blockFields1 = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields1); + $block1Id = $addedItemResult->getId(); + + $blockFields2 = [ + //'CODE' => '02.three_cols_text_big', + 'CODE' => '02.three_cols_big_1', + 'ACTIVE' => 'Y', + 'AFTER_ID' => $block1Id, + ]; + + $block2Result = $this->pageService->addBlock($pageId, $blockFields2); + $block2Result->getId(); + + // Move first block down + $blockMovedResult = $this->pageService->moveBlockDown($pageId, $block1Id); + self::assertTrue($blockMovedResult->isSuccess()); + + + // Move second block up + $moveUpResult = $this->pageService->moveBlockUp($pageId, $block1Id); + self::assertTrue($moveUpResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMoveBlockBetweenPages(): void + { + $pageId1 = $this->createTestPageWithBlocks(); + $pageId2 = $this->createTestPageWithBlocks(); + + // Add a block to the first page + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId1, $blockFields); + $blockId = $addedItemResult->getId(); + + // Move the block to the second page + $blockMovedResult = $this->pageService->moveBlock($pageId2, $blockId); + self::assertTrue($blockMovedResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMarkBlockDeletedAndUnDeleted(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Add a block + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields); + $blockId = $addedItemResult->getId(); + + // Mark block as deleted + $updatedItemResult = $this->pageService->markBlockDeleted($pageId, $blockId); + self::assertTrue($updatedItemResult->isSuccess()); + + // Mark block as undeleted + $markUnDeletedResult = $this->pageService->markBlockUnDeleted($pageId, $blockId); + self::assertTrue($markUnDeletedResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAddAndRemoveBlockFromFavorites(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Add a block + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields); + $blockId = $addedItemResult->getId(); + + // Add block to favorites + $meta = [ + 'name' => 'Test Favorite Block', + 'section' => ['text'], + 'preview' => 'https://example.com/preview.jpg' + ]; + + $favoriteResult = $this->pageService->addBlockToFavorites($pageId, $blockId, $meta); + $favoriteBlockId = $favoriteResult->getId(); + + // Verify it was added (should return a number) + self::assertGreaterThan(0, $favoriteBlockId); + + // Remove block from favorites + $updatedItemResult = $this->pageService->removeBlockFromFavorites($favoriteBlockId); + self::assertTrue($updatedItemResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testDeleteBlock(): void + { + $pageId = $this->createTestPageWithBlocks(); + + // Add a block + $blockFields = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + $addedItemResult = $this->pageService->addBlock($pageId, $blockFields); + $blockId = $addedItemResult->getId(); + + // Delete the block + $deletedItemResult = $this->pageService->deleteBlock($pageId, $blockId); + self::assertTrue($deletedItemResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testCopyBlockWithParameters(): void + { + $pageId1 = $this->createTestPageWithBlocks(); + $pageId2 = $this->createTestPageWithBlocks(); + + // Add two blocks to the first page + $blockFields1 = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + + $addedItemResult = $this->pageService->addBlock($pageId1, $blockFields1); + $block1Id = $addedItemResult->getId(); + + $blockFields2 = [ + 'CODE' => '02.three_cols_big_1', + 'ACTIVE' => 'Y', + 'AFTER_ID' => $block1Id, + ]; + $block2Result = $this->pageService->addBlock($pageId1, $blockFields2); + $block2Id = $block2Result->getId(); + + // Copy block with AFTER_ID parameter + $params = ['AFTER_ID' => $block1Id]; + $blockCopiedResult = $this->pageService->copyBlock($pageId2, $block2Id, $params); + $copiedBlockId = $blockCopiedResult->getId(); + + self::assertGreaterThan(0, $copiedBlockId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMoveBlockWithParameters(): void + { + $pageId1 = $this->createTestPageWithBlocks(); + $pageId2 = $this->createTestPageWithBlocks(); + + // Add two blocks to the first page + $blockFields1 = [ + 'CODE' => '01.big_with_text_blocks', + 'ACTIVE' => 'Y' + ]; + + + $addedItemResult = $this->pageService->addBlock($pageId1, $blockFields1); + $block1Id = $addedItemResult->getId(); + + $blockFields2 = [ + 'CODE' => '02.three_cols_big_1', + 'ACTIVE' => 'Y', + 'AFTER_ID' => $block1Id, + ]; + $block2Result = $this->pageService->addBlock($pageId1, $blockFields2); + $block2Id = $block2Result->getId(); + + // Add a block to the second page to use as reference + $block3Result = $this->pageService->addBlock($pageId2, $blockFields1); + $block3Id = $block3Result->getId(); + + // Move block with AFTER_ID parameter + $params = ['AFTER_ID' => $block3Id]; + $blockMovedResult = $this->pageService->moveBlock($pageId2, $block2Id, $params); + self::assertTrue($blockMovedResult->isSuccess()); + } +} \ No newline at end of file diff --git a/tests/Integration/Services/Landing/Site/Service/SiteTest.php b/tests/Integration/Services/Landing/Site/Service/SiteTest.php new file mode 100644 index 00000000..83a30a2f --- /dev/null +++ b/tests/Integration/Services/Landing/Site/Service/SiteTest.php @@ -0,0 +1,655 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Tests\Integration\Services\Landing\Site\Service; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\Landing\Site\Result\SiteItemResult; +use Bitrix24\SDK\Services\Landing\Site\Service\Site; +use Bitrix24\SDK\Tests\CustomAssertions\CustomBitrix24Assertions; +use Bitrix24\SDK\Tests\Integration\Fabric; +use PHPUnit\Framework\Attributes\CoversMethod; +use PHPUnit\Framework\TestCase; + +/** + * Class SiteTest + * + * @package Bitrix24\SDK\Tests\Integration\Services\Landing\Site\Service + */ +#[CoversMethod(Site::class, 'add')] +#[CoversMethod(Site::class, 'getList')] +#[CoversMethod(Site::class, 'update')] +#[CoversMethod(Site::class, 'delete')] +#[CoversMethod(Site::class, 'getPublicUrl')] +#[CoversMethod(Site::class, 'getPreview')] +#[CoversMethod(Site::class, 'publication')] +#[CoversMethod(Site::class, 'unpublic')] +#[CoversMethod(Site::class, 'markDelete')] +#[CoversMethod(Site::class, 'markUnDelete')] +#[CoversMethod(Site::class, 'getFolders')] +#[CoversMethod(Site::class, 'addFolder')] +#[CoversMethod(Site::class, 'updateFolder')] +#[CoversMethod(Site::class, 'publicationFolder')] +#[CoversMethod(Site::class, 'unPublicFolder')] +#[CoversMethod(Site::class, 'markFolderDelete')] +#[CoversMethod(Site::class, 'markFolderUnDelete')] +#[CoversMethod(Site::class, 'getAdditionalFields')] +#[CoversMethod(Site::class, 'fullExport')] +#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Services\Landing\Site\Service\Site::class)] +class SiteTest extends TestCase +{ + use CustomBitrix24Assertions; + + protected Site $siteService; + + protected array $createdSiteIds = []; + + protected array $createdFolderIds = []; + + protected function setUp(): void + { + $serviceBuilder = Fabric::getServiceBuilder(); + $this->siteService = $serviceBuilder->getLandingScope()->site(); + } + + protected function tearDown(): void + { + // Clean up created folders + foreach ($this->createdFolderIds as $createdFolderId) { + try { + $this->siteService->markFolderDelete($createdFolderId); + } catch (\Exception) { + // Ignore if folder doesn't exist + } + } + + // Clean up created sites + foreach ($this->createdSiteIds as $createdSiteId) { + try { + $this->siteService->delete($createdSiteId); + } catch (\Exception) { + // Ignore if site doesn't exist + } + } + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAdd(): void + { + $siteFields = [ + 'TITLE' => 'Test Site ' . time(), + 'CODE' => 'testsite' . time(), + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + self::assertGreaterThan(0, $siteId); + self::assertIsInt($siteId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetList(): void + { + // First create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for List ' . $timestamp, + 'CODE' => 'testsitelist' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test getList with no parameters + $sitesResult = $this->siteService->getList(); + $sites = $sitesResult->getSites(); + + self::assertIsArray($sites); + self::assertNotEmpty($sites); + + // Check that our created site is in the list + $foundSite = null; + foreach ($sites as $site) { + self::assertInstanceOf(SiteItemResult::class, $site); + if (intval($site->ID) === $siteId) { + $foundSite = $site; + break; + } + } + + self::assertNotNull($foundSite, 'Created site should be found in the list'); + self::assertEquals($siteFields['TITLE'], $foundSite->TITLE); + self::assertStringContainsString($siteFields['CODE'], $foundSite->CODE); + self::assertEquals($siteFields['TYPE'], $foundSite->TYPE); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetListWithFilters(): void + { + // First create a test site with unique title + $timestamp = time(); + $uniqueTitle = 'Unique Test Site ' . $timestamp; + $siteFields = [ + 'TITLE' => $uniqueTitle, + 'CODE' => 'uniquetestsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test getList with filters + $sitesResult = $this->siteService->getList( + ['ID', 'TITLE', 'CODE'], // select + ['TITLE' => $uniqueTitle], // filter + ['ID' => 'DESC'] // order + ); + $sites = $sitesResult->getSites(); + + self::assertIsArray($sites); + self::assertCount(1, $sites, 'Should find exactly one site with this unique title'); + + $foundSite = $sites[0]; + self::assertInstanceOf(SiteItemResult::class, $foundSite); + self::assertEquals($siteId, intval($foundSite->ID)); + self::assertEquals($uniqueTitle, $foundSite->TITLE); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdate(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Update ' . $timestamp, + 'CODE' => 'testsiteupdate' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Update the site + $newTitle = 'Updated Test Site ' . $timestamp; + $updatedItemResult = $this->siteService->update($siteId, [ + 'TITLE' => $newTitle + ]); + + self::assertTrue($updatedItemResult->isSuccess(), 'Site update should be successful'); + + // Verify the update by getting the site list + $sitesResult = $this->siteService->getList( + ['ID', 'TITLE'], + ['ID' => $siteId] + ); + $sites = $sitesResult->getSites(); + + self::assertNotEmpty($sites); + $updatedSite = $sites[0]; + self::assertEquals($newTitle, $updatedSite->TITLE); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testDelete(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Delete ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + + // Delete the site + $deletedItemResult = $this->siteService->delete($siteId); + self::assertTrue($deletedItemResult->isSuccess(), 'Site deletion should be successful'); + + // Remove from cleanup list since it's already deleted + $this->createdSiteIds = array_filter($this->createdSiteIds, fn($id): bool => $id !== $siteId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetPublicUrl(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for URL ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Get public URL + $siteUrlResult = $this->siteService->getPublicUrl($siteId); + $url = $siteUrlResult->getUrl(); + + self::assertIsString($url); + // URL might be empty if site is not published, but method should work + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetPreview(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Preview ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Get preview URL + $siteUrlResult = $this->siteService->getPreview($siteId); + $previewUrl = $siteUrlResult->getUrl(); + + self::assertIsString($previewUrl); + // Preview URL might be empty, but method should work + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testPublicationAndUnpublic(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Publication ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test publication + $sitePublishedResult = $this->siteService->publication($siteId); + self::assertTrue($sitePublishedResult->isSuccess(), 'Site publication should be successful'); + + // Test unpublish + $siteUnpublishedResult = $this->siteService->unpublic($siteId); + self::assertTrue($siteUnpublishedResult->isSuccess(), 'Site unpublish should be successful'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testMarkDeleteAndMarkUnDelete(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Mark Delete ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test mark delete + $siteMarkedDeletedResult = $this->siteService->markDelete($siteId); + self::assertTrue($siteMarkedDeletedResult->isSuccess(), 'Site mark delete should be successful'); + + // Test mark undelete + $siteMarkedUnDeletedResult = $this->siteService->markUnDelete($siteId); + self::assertTrue($siteMarkedUnDeletedResult->isSuccess(), 'Site mark undelete should be successful'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetFolders(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Folders ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Get folders (might be empty initially) + $foldersResult = $this->siteService->getFolders($siteId); + $folders = $foldersResult->getFolders(); + + self::assertIsArray($folders); + // Folders array might be empty for a new site, that's OK + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testAddFolder(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Add Folder ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Add a folder + $folderFields = [ + 'TITLE' => 'Test Folder ' . $timestamp, + 'CODE' => 'testfolder' . $timestamp, + 'ACTIVE' => 'Y' + ]; + + $folderAddedResult = $this->siteService->addFolder($siteId, $folderFields); + $folderId = $folderAddedResult->getId(); + $this->createdFolderIds[] = $folderId; + + self::assertGreaterThan(0, $folderId); + self::assertIsInt($folderId); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testUpdateFolder(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Update Folder ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Add a folder + $folderFields = [ + 'TITLE' => 'Test Folder for Update ' . $timestamp, + 'CODE' => 'testfolder' . $timestamp, + 'ACTIVE' => 'Y' + ]; + + $folderAddedResult = $this->siteService->addFolder($siteId, $folderFields); + $folderId = $folderAddedResult->getId(); + $this->createdFolderIds[] = $folderId; + + // Update the folder + $folderUpdatedResult = $this->siteService->updateFolder($siteId, $folderId, [ + 'TITLE' => 'Updated Test Folder ' . $timestamp + ]); + + self::assertTrue($folderUpdatedResult->isSuccess(), 'Folder update should be successful'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testFolderPublicationMethods(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Folder Publication ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Add a folder + $folderFields = [ + 'TITLE' => 'Test Folder for Publication ' . $timestamp, + 'CODE' => 'testfolder' . $timestamp, + 'ACTIVE' => 'Y' + ]; + + $folderAddedResult = $this->siteService->addFolder($siteId, $folderFields); + $folderId = $folderAddedResult->getId(); + $this->createdFolderIds[] = $folderId; + + // Test folder publication + $folderPublishedResult = $this->siteService->publicationFolder($folderId); + self::assertTrue($folderPublishedResult->isSuccess(), 'Folder publication should be successful'); + + // Test folder unpublish + $folderUnpublishedResult = $this->siteService->unPublicFolder($folderId); + self::assertTrue($folderUnpublishedResult->isSuccess(), 'Folder unpublish should be successful'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testFolderMarkDeleteAndUnDelete(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Folder Delete ' . $timestamp, + 'CODE' => 'testsite' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Add a folder + $folderFields = [ + 'TITLE' => 'Test Folder for Delete ' . $timestamp, + 'CODE' => 'testfolder' . $timestamp, + 'ACTIVE' => 'Y' + ]; + + $folderAddedResult = $this->siteService->addFolder($siteId, $folderFields); + $folderId = $folderAddedResult->getId(); + $this->createdFolderIds[] = $folderId; + + // Test folder mark delete + $deletedItemResult = $this->siteService->markFolderDelete($folderId); + self::assertTrue($deletedItemResult->isSuccess(), 'Folder mark delete should be successful'); + + // Test folder mark undelete + $markUnDeleteResult = $this->siteService->markFolderUnDelete($folderId); + self::assertTrue($markUnDeleteResult->isSuccess(), 'Folder mark undelete should be successful'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetAdditionalFields(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Additional Fields ' . $timestamp, + 'CODE' => 'testsiteadditionalfields' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Get additional fields + $siteAdditionalFieldsResult = $this->siteService->getAdditionalFields($siteId); + + // Verify result structure + self::assertInstanceOf( + \Bitrix24\SDK\Services\Landing\Site\Result\SiteAdditionalFieldsResult::class, + $siteAdditionalFieldsResult, + 'Result should be instance of SiteAdditionalFieldsResult' + ); + + // Verify response data + $additionalFields = $siteAdditionalFieldsResult->getAdditionalFields(); + self::assertIsArray($additionalFields, 'Additional fields should be an array'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testFullExport(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Export ' . $timestamp, + 'CODE' => 'testsiteexport' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test 1: Export site without params + $siteExportResult = $this->siteService->fullExport($siteId); + + // Verify result structure + self::assertInstanceOf( + \Bitrix24\SDK\Services\Landing\Site\Result\SiteExportResult::class, + $siteExportResult, + 'Result should be instance of SiteExportResult' + ); + + // Verify export data + $exportData = $siteExportResult->getExportData(); + self::assertIsArray($exportData, 'Export data should be an array'); + + // Test 2: Export site with comprehensive params + $exportParams = [ + 'edit_mode' => 'Y', + 'code' => 'exportedsite' . $timestamp, + 'name' => 'Exported Test Site ' . $timestamp, + 'description' => 'Test site exported via API with comprehensive parameters', + 'hooks_disable' => ['B24BUTTON_CODE'], // Disable specific hooks + ]; + + $exportResultWithParams = $this->siteService->fullExport($siteId, $exportParams); + + // Verify result with params + self::assertInstanceOf( + \Bitrix24\SDK\Services\Landing\Site\Result\SiteExportResult::class, + $exportResultWithParams, + 'Result with params should be instance of SiteExportResult' + ); + + $exportDataWithParams = $exportResultWithParams->getExportData(); + self::assertIsArray($exportDataWithParams, 'Export data with params should be an array'); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testFullExportWithComplexParams(): void + { + // Create a test site + $timestamp = time(); + $siteFields = [ + 'TITLE' => 'Test Site for Complex Export ' . $timestamp, + 'CODE' => 'testsitecomplexexport' . $timestamp, + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + // Test with complex export parameters + $complexParams = [ + 'edit_mode' => 'N', + 'scope' => 'knowledge', + 'hooks_disable' => ['B24BUTTON_CODE', 'YANDEX_METRICA'], + 'code' => 'complexexportedsite' . $timestamp, + 'name' => 'Complex Exported Test Site', + 'description' => 'This is a complex test site with multiple export parameters', + 'preview' => 'https://example.com/preview.jpg', + 'preview2x' => 'https://example.com/preview@2x.jpg', + 'preview3x' => 'https://example.com/preview@3x.jpg' + ]; + + $siteExportResult = $this->siteService->fullExport($siteId, $complexParams); + + // Verify complex export + self::assertInstanceOf( + \Bitrix24\SDK\Services\Landing\Site\Result\SiteExportResult::class, + $siteExportResult, + 'Complex export result should be instance of SiteExportResult' + ); + + $exportData = $siteExportResult->getExportData(); + self::assertIsArray($exportData, 'Complex export data should be an array'); + } +} diff --git a/tests/Integration/Services/Landing/SysPage/Service/SysPageTest.php b/tests/Integration/Services/Landing/SysPage/Service/SysPageTest.php new file mode 100644 index 00000000..922c56da --- /dev/null +++ b/tests/Integration/Services/Landing/SysPage/Service/SysPageTest.php @@ -0,0 +1,332 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Tests\Integration\Services\Landing\SysPage\Service; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\Landing\SysPage\Service\SysPage; +use Bitrix24\SDK\Services\Landing\SysPage\SysPageType; +use Bitrix24\SDK\Services\Landing\Site\Service\Site; +use Bitrix24\SDK\Services\Landing\Page\Service\Page; +use Bitrix24\SDK\Tests\CustomAssertions\CustomBitrix24Assertions; +use Bitrix24\SDK\Tests\Integration\Fabric; +use PHPUnit\Framework\Attributes\CoversMethod; +use PHPUnit\Framework\TestCase; + +/** + * Class SysPageTest + * + * @package Bitrix24\SDK\Tests\Integration\Services\Landing\SysPage\Service + */ +#[CoversMethod(SysPage::class, 'set')] +#[CoversMethod(SysPage::class, 'get')] +#[CoversMethod(SysPage::class, 'getSpecialPage')] +#[CoversMethod(SysPage::class, 'deleteForLanding')] +#[CoversMethod(SysPage::class, 'deleteForSite')] +#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Services\Landing\SysPage\Service\SysPage::class)] +class SysPageTest extends TestCase +{ + use CustomBitrix24Assertions; + + protected SysPage $sysPageService; + + protected Site $siteService; + + protected Page $pageService; + + protected array $createdPageIds = []; + + protected array $createdSiteIds = []; + + protected function setUp(): void + { + $serviceBuilder = Fabric::getServiceBuilder(); + $this->sysPageService = $serviceBuilder->getLandingScope()->sysPage(); + $this->siteService = $serviceBuilder->getLandingScope()->site(); + $this->pageService = $serviceBuilder->getLandingScope()->page(); + } + + protected function tearDown(): void + { + // Clean up system page settings before deleting pages and sites + foreach ($this->createdSiteIds as $siteId) { + try { + $this->sysPageService->deleteForSite($siteId); + } catch (\Exception) { + // Ignore if site or system pages don't exist + } + } + + // Clean up created pages + foreach ($this->createdPageIds as $createdPageId) { + try { + $this->pageService->delete($createdPageId); + } catch (\Exception) { + // Ignore if page doesn't exist + } + } + + // Clean up created sites + foreach ($this->createdSiteIds as $createdSiteId) { + try { + $this->siteService->delete($createdSiteId); + } catch (\Exception) { + // Ignore if site doesn't exist + } + } + } + + /** + * Helper method to create a test site + */ + protected function createTestSite(): int + { + $siteFields = [ + 'TITLE' => 'Test Site for SysPage ' . time(), + 'CODE' => 'testsitesyspage' . time(), + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + return $siteId; + } + + /** + * Helper method to create a test page + */ + protected function createTestPage(int $siteId): int + { + $pageFields = [ + 'TITLE' => 'Test Page for SysPage ' . time(), + 'CODE' => 'testpagesyspage' . time(), + 'SITE_ID' => $siteId, + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + return $pageId; + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetWithEnum(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + $sysPageResult = $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + self::assertTrue($sysPageResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetWithString(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + $sysPageResult = $this->sysPageService->set($siteId, 'cart', $pageId); + + self::assertTrue($sysPageResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetWithoutPageId(): void + { + $siteId = $this->createTestSite(); + + // First set a system page + $pageId = $this->createTestPage($siteId); + $this->sysPageService->set($siteId, SysPageType::catalog, $pageId); + + // Then remove it by calling set without pageId + $sysPageResult = $this->sysPageService->set($siteId, SysPageType::catalog); + + self::assertTrue($sysPageResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGet(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + $sysPageListResult = $this->sysPageService->get($siteId); + $sysPages = $sysPageListResult->getSysPages(); + + self::assertIsArray($sysPages); + // At least one system page should be set + self::assertGreaterThanOrEqual(1, count($sysPages)); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetWithActiveFilter(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + $sysPageListResult = $this->sysPageService->get($siteId, true); + $sysPages = $sysPageListResult->getSysPages(); + + self::assertIsArray($sysPages); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetSpecialPageWithEnum(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + $sysPageUrlResult = $this->sysPageService->getSpecialPage($siteId, SysPageType::personal); + $url = $sysPageUrlResult->getUrl(); + + self::assertIsString($url); + self::assertNotEmpty($url); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetSpecialPageWithString(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, 'cart', $pageId); + + $sysPageUrlResult = $this->sysPageService->getSpecialPage($siteId, 'cart'); + $url = $sysPageUrlResult->getUrl(); + + self::assertIsString($url); + self::assertNotEmpty($url); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetSpecialPageWithAdditionalParams(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + $additional = ['SECTION' => 'private']; + $sysPageUrlResult = $this->sysPageService->getSpecialPage($siteId, SysPageType::personal, $additional); + $url = $sysPageUrlResult->getUrl(); + + self::assertIsString($url); + self::assertNotEmpty($url); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testDeleteForLanding(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set a system page first + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + + $sysPageResult = $this->sysPageService->deleteForLanding($pageId); + + self::assertTrue($sysPageResult->isSuccess()); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testDeleteForSite(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Set multiple system pages + $this->sysPageService->set($siteId, SysPageType::personal, $pageId); + $this->sysPageService->set($siteId, SysPageType::cart, $pageId); + + $sysPageResult = $this->sysPageService->deleteForSite($siteId); + + self::assertTrue($sysPageResult->isSuccess()); + } + + /** + * Test that all enum values are valid + * + * @throws BaseException + * @throws TransportException + */ + public function testAllSysPageTypes(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + $types = [ + SysPageType::mainpage, + SysPageType::catalog, + SysPageType::personal, + SysPageType::cart, + SysPageType::order, + SysPageType::payment, + SysPageType::compare, + ]; + + foreach ($types as $type) { + $result = $this->sysPageService->set($siteId, $type, $pageId); + self::assertTrue($result->isSuccess(), 'Failed to set system page type: ' . $type->value); + } + + // Clean up - remove all system pages + $this->sysPageService->deleteForSite($siteId); + } +} diff --git a/tests/Integration/Services/Landing/Template/Service/TemplateTest.php b/tests/Integration/Services/Landing/Template/Service/TemplateTest.php new file mode 100644 index 00000000..1227f9a7 --- /dev/null +++ b/tests/Integration/Services/Landing/Template/Service/TemplateTest.php @@ -0,0 +1,290 @@ + + * + * For the full copyright and license information, please view the MIT-LICENSE.txt + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace Bitrix24\SDK\Tests\Integration\Services\Landing\Template\Service; + +use Bitrix24\SDK\Core\Exceptions\BaseException; +use Bitrix24\SDK\Core\Exceptions\TransportException; +use Bitrix24\SDK\Services\Landing\Template\Service\Template; +use Bitrix24\SDK\Services\Landing\Site\Service\Site; +use Bitrix24\SDK\Services\Landing\Page\Service\Page; +use Bitrix24\SDK\Tests\CustomAssertions\CustomBitrix24Assertions; +use Bitrix24\SDK\Tests\Integration\Fabric; +use PHPUnit\Framework\Attributes\CoversMethod; +use PHPUnit\Framework\TestCase; + +/** + * Class TemplateTest + * + * @package Bitrix24\SDK\Tests\Integration\Services\Landing\Template\Service + */ +#[CoversMethod(Template::class, 'getList')] +#[CoversMethod(Template::class, 'getLandingRef')] +#[CoversMethod(Template::class, 'getSiteRef')] +#[CoversMethod(Template::class, 'setLandingRef')] +#[CoversMethod(Template::class, 'setSiteRef')] +#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Services\Landing\Template\Service\Template::class)] +class TemplateTest extends TestCase +{ + use CustomBitrix24Assertions; + + protected Template $templateService; + + protected Site $siteService; + + protected Page $pageService; + + protected array $createdPageIds = []; + + protected array $createdSiteIds = []; + + protected function setUp(): void + { + $serviceBuilder = Fabric::getServiceBuilder(); + $this->templateService = $serviceBuilder->getLandingScope()->template(); + $this->siteService = $serviceBuilder->getLandingScope()->site(); + $this->pageService = $serviceBuilder->getLandingScope()->page(); + } + + protected function tearDown(): void + { + // Clean up created pages + foreach ($this->createdPageIds as $createdPageId) { + try { + $this->pageService->delete($createdPageId); + } catch (\Exception) { + // Ignore if page doesn't exist + } + } + + // Clean up created sites + foreach ($this->createdSiteIds as $createdSiteId) { + try { + $this->siteService->delete($createdSiteId); + } catch (\Exception) { + // Ignore if site doesn't exist + } + } + } + + /** + * Helper method to create a test site + */ + protected function createTestSite(): int + { + $siteFields = [ + 'TITLE' => 'Test Site for Template ' . time(), + 'CODE' => 'testsitetemplate' . time(), + 'TYPE' => 'PAGE' + ]; + + $addedItemResult = $this->siteService->add($siteFields); + $siteId = $addedItemResult->getId(); + $this->createdSiteIds[] = $siteId; + + return $siteId; + } + + /** + * Helper method to create a test page + */ + protected function createTestPage(int $siteId): int + { + $pageFields = [ + 'TITLE' => 'Test Page for Template ' . time(), + 'CODE' => 'testpagetemplate' . time(), + 'SITE_ID' => $siteId, + ]; + + $addedItemResult = $this->pageService->add($pageFields); + $pageId = $addedItemResult->getId(); + $this->createdPageIds[] = $pageId; + + return $pageId; + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetList(): void + { + $templatesResult = $this->templateService->getList(); + $templates = $templatesResult->getTemplates(); + + self::assertIsArray($templates); + self::assertNotEmpty($templates, 'There should be at least some predefined templates'); + + // Test first template structure + $firstTemplate = $templates[0]; + self::assertGreaterThan(0, $firstTemplate->ID); + self::assertIsString($firstTemplate->TITLE); + self::assertIsString($firstTemplate->XML_ID); + self::assertIsString($firstTemplate->ACTIVE); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetListWithParameters(): void + { + $select = ['ID', 'TITLE', 'XML_ID']; + $filter = ['>ID' => 0]; + $order = ['ID' => 'DESC']; + + $templatesResult = $this->templateService->getList($select, $filter, $order); + $templates = $templatesResult->getTemplates(); + + self::assertIsArray($templates); + self::assertNotEmpty($templates); + + // Verify that templates are ordered by ID in descending order + if (count($templates) > 1) { + self::assertGreaterThanOrEqual($templates[1]->ID, $templates[0]->ID); + } + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetLandingRef(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + $templateRefsResult = $this->templateService->getLandingRef($pageId); + $refs = $templateRefsResult->getRefs(); + + self::assertIsArray($refs); + // The refs array might be empty if no template areas are configured for this page + // This is expected behavior for a newly created page + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testGetSiteRef(): void + { + $siteId = $this->createTestSite(); + + $templateRefsResult = $this->templateService->getSiteRef($siteId); + $refs = $templateRefsResult->getRefs(); + + self::assertIsArray($refs); + // The refs array might be empty if no template areas are configured for this site + // This is expected behavior for a newly created site + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetLandingRef(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Test setting empty data (should reset included areas) + $templateRefSetResult = $this->templateService->setLandingRef($pageId, []); + self::assertTrue($templateRefSetResult->isSuccess()); + + // Verify that refs are now empty + $templateRefsResult = $this->templateService->getLandingRef($pageId); + $refs = $templateRefsResult->getRefs(); + self::assertIsArray($refs); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetSiteRef(): void + { + $siteId = $this->createTestSite(); + + // Test setting empty data (should reset included areas) + $templateRefSetResult = $this->templateService->setSiteRef($siteId, []); + self::assertTrue($templateRefSetResult->isSuccess()); + + // Verify that refs are now empty + $templateRefsResult = $this->templateService->getSiteRef($siteId); + $refs = $templateRefsResult->getRefs(); + self::assertIsArray($refs); + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetLandingRefWithData(): void + { + $siteId = $this->createTestSite(); + $pageId = $this->createTestPage($siteId); + + // Create additional pages to use as template areas + $headerPageId = $this->createTestPage($siteId); + $footerPageId = $this->createTestPage($siteId); + + // Test setting template areas data + $data = [ + 1 => $headerPageId, // Area 1 -> header page + 2 => $footerPageId // Area 2 -> footer page + ]; + + $templateRefSetResult = $this->templateService->setLandingRef($pageId, $data); + self::assertTrue($templateRefSetResult->isSuccess()); + + // Verify that refs are set correctly + $templateRefsResult = $this->templateService->getLandingRef($pageId); + $refs = $templateRefsResult->getRefs(); + self::assertIsArray($refs); + + // Note: The actual refs might not match exactly what we set + // because the page might not be linked to a template that supports these areas + // This is expected behavior according to the API documentation + } + + /** + * @throws BaseException + * @throws TransportException + */ + public function testSetSiteRefWithData(): void + { + $siteId = $this->createTestSite(); + + // Create pages to use as template areas + $headerPageId = $this->createTestPage($siteId); + $footerPageId = $this->createTestPage($siteId); + + // Test setting template areas data + $data = [ + 1 => $headerPageId, // Area 1 -> header page + 2 => $footerPageId // Area 2 -> footer page + ]; + + $templateRefSetResult = $this->templateService->setSiteRef($siteId, $data); + self::assertTrue($templateRefSetResult->isSuccess()); + + // Verify that refs are set correctly + $templateRefsResult = $this->templateService->getSiteRef($siteId); + $refs = $templateRefsResult->getRefs(); + self::assertIsArray($refs); + + // Note: The actual refs might not match exactly what we set + // because the site might not be linked to a template that supports these areas + // This is expected behavior according to the API documentation + } +} \ No newline at end of file