init

Author: thomas-kl1

Api/Data/DocumentInterface.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api\Data;
+
+use DateTime;
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * @api
+ */
+interface DocumentInterface extends ExtensibleDataInterface
+{
+    public function getId(): ?int;
+
+    public function getTypeId(): int;
+
+    public function getCode(): string;
+
+    public function getName(): string;
+
+    public function getDescription(): string;
+
+    public function getLocale(): ?string;
+
+    public function getFileName(): string;
+
+    public function getFilePath(): string;
+
+    public function getImageFileName(): string;
+
+    public function getCreatedAt(): DateTime;
+
+    public function getUpdatedAt(): DateTime;
+
+    /**
+     * @return \Opengento\Document\Api\Data\DocumentExtensionInterface
+     */
+    public function getExtensionAttributes(): DocumentExtensionInterface;
+
+    /**
+     * @param \Opengento\Document\Api\Data\DocumentExtensionInterface $extensionAttributes
+     * @return \Opengento\Document\Api\Data\DocumentInterface
+     */
+    public function setExtensionAttributes(DocumentExtensionInterface $extensionAttributes): DocumentInterface;
+}

Api/Data/DocumentSearchResultsInterface.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api\Data;
+
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * @api
+ */
+interface DocumentSearchResultsInterface extends SearchResultsInterface
+{
+    /**
+     * @inheritdoc
+     * @return \Opengento\Document\Api\Data\DocumentInterface[]
+     */
+    public function getItems(): array;
+
+    /**
+     * @inheritdoc
+     * @param \Opengento\Document\Api\Data\DocumentInterface[] $items
+     * @return $this
+     */
+    public function setItems(array $items): self;
+}

Api/Data/DocumentTypeInterface.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api\Data;
+
+use DateTime;
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * @api
+ */
+interface DocumentTypeInterface extends ExtensibleDataInterface
+{
+    public function getId(): ?int;
+
+    public function getCode(): string;
+
+    public function getScheduledImport(): bool;
+
+    public function getName(): string;
+
+    public function getFileSourcePath(): string;
+
+    public function getFileDestPath(): string;
+
+    public function getSubPathLength(): int;
+
+    public function getFilePattern(): string;
+
+    public function getFileAllowedExtensions(): array;
+
+    public function getDefaultImageFileName(): string;
+
+    public function getCreatedAt(): DateTime;
+
+    public function getUpdatedAt(): DateTime;
+
+    /**
+     * @return \Opengento\Document\Api\Data\DocumentTypeExtensionInterface
+     */
+    public function getExtensionAttributes(): DocumentTypeExtensionInterface;
+
+    /**
+     * @param \Opengento\Document\Api\Data\DocumentTypeExtensionInterface $extensionAttributes
+     * @return \Opengento\Document\Api\Data\DocumentTypeInterface
+     */
+    public function setExtensionAttributes(DocumentTypeExtensionInterface $extensionAttributes): DocumentTypeInterface;
+}

Api/Data/DocumentTypeSearchResultsInterface.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api\Data;
+
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * @api
+ */
+interface DocumentTypeSearchResultsInterface extends SearchResultsInterface
+{
+    /**
+     * @inheritdoc
+     * @return \Opengento\Document\Api\Data\DocumentTypeInterface[]
+     */
+    public function getItems(): array;
+
+    /**
+     * @inheritdoc
+     * @param \Opengento\Document\Api\Data\DocumentTypeInterface[] $items
+     * @return $this
+     */
+    public function setItems(array $items): self;
+}

Api/DocumentRepositoryInterface.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api;
+
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\CouldNotDeleteException;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Opengento\Document\Api\Data\DocumentInterface;
+use Opengento\Document\Api\Data\DocumentSearchResultsInterface;
+
+/**
+ * @api
+ */
+interface DocumentRepositoryInterface
+{
+    /**
+     * @param int $documentId
+     * @return DocumentInterface
+     * @throws NoSuchEntityException
+     */
+    public function getById(int $documentId): DocumentInterface;
+
+    /**
+     * @param string $documentCode
+     * @return DocumentInterface
+     * @throws NoSuchEntityException
+     */
+    public function getByCode(string $documentCode): DocumentInterface;
+
+    /**
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return DocumentSearchResultsInterface
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+
+    /**
+     * @param DocumentInterface $document
+     * @return DocumentInterface
+     * @throws CouldNotSaveException
+     */
+    public function save(DocumentInterface $document): DocumentInterface;
+
+    /**
+     * @param DocumentInterface $document
+     * @throws CouldNotDeleteException
+     */
+    public function delete(DocumentInterface $document): void;
+}

Api/DocumentTypeRepositoryInterface.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\Document\Api;
+
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\CouldNotDeleteException;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Opengento\Document\Api\Data\DocumentTypeInterface;
+use Opengento\Document\Api\Data\DocumentTypeSearchResultsInterface;
+
+/**
+ * @api
+ */
+interface DocumentTypeRepositoryInterface
+{
+    /**
+     * @param int $documentTypeId
+     * @return DocumentTypeInterface
+     * @throws NoSuchEntityException
+     */
+    public function getById(int $documentTypeId): DocumentTypeInterface;
+
+    /**
+     * @param string $documentTypeCode
+     * @return DocumentTypeInterface
+     * @throws NoSuchEntityException
+     */
+    public function getByCode(string $documentTypeCode): DocumentTypeInterface;
+
+    /**
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return DocumentTypeSearchResultsInterface
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+
+    /**
+     * @param DocumentTypeInterface $documentType
+     * @return DocumentTypeInterface
+     * @throws CouldNotSaveException
+     */
+    public function save(DocumentTypeInterface $documentType): DocumentTypeInterface;
+
+    /**
+     * @param DocumentTypeInterface $documentType
+     * @throws CouldNotDeleteException
+     */
+    public function delete(DocumentTypeInterface $documentType): void;
+}