Merge branch 'develop' into german_translations

Author: mohitalgolia

Api/Data/QueueArchiveInterface.php

@@ -0,0 +1,220 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+/**
+ * Interface QueueArchiveInterface
+ * @package Algolia\AlgoliaSearch\Api\Data
+ */
+interface QueueArchiveInterface
+{
+    const ARCHIVE_ID = 'archive_id';
+    const PID = 'pid';
+    const CLASS_NAME = 'class';
+    const METHOD_NAME = 'method';
+    const DATA = 'data';
+    const RETRIES = 'retries';
+    const ERROR_LOG = 'error_log';
+    const DATA_SIZE = 'data_size';
+    const IS_FULL_REINDEX = 'is_full_reindex';
+    const CREATED_AT = 'created_at';
+    const PROCESSED_AT = 'processed_at';
+    const SUCCESS = 'success';
+    const DEBUG = 'debug';
+
+    /**
+     * Get archive ID
+     *
+     * @return int|null
+     */
+    public function getArchiveId();
+
+    /**
+     * Set archive ID
+     *
+     * @param int $id
+     * @return $this
+     */
+    public function setArchiveId($id);
+
+    /**
+     * Get PID
+     *
+     * @return int|null
+     */
+    public function getPid();
+
+    /**
+     * Set PID
+     *
+     * @param int $pid
+     * @return $this
+     */
+    public function setPid($pid);
+
+    /**
+     * Get class name
+     *
+     * @return string|null
+     */
+    public function getClassName();
+
+    /**
+     * Set class name
+     *
+     * @param string $className
+     * @return $this
+     */
+    public function setClassName($className);
+
+    /**
+     * Get method name
+     *
+     * @return string|null
+     */
+    public function getMethodName();
+
+    /**
+     * Set method name
+     *
+     * @param string $methodName
+     * @return $this
+     */
+    public function setMethodName($methodName);
+
+    /**
+     * Get data field
+     *
+     * @return string|null
+     */
+    public function getDataField();
+
+    /**
+     * Set data field
+     *
+     * @param string $dataField
+     * @return $this
+     */
+    public function setDataField($dataField);
+
+    /**
+     * Get retries
+     *
+     * @return int
+     */
+    public function getRetries();
+
+    /**
+     * Set retries
+     *
+     * @param int $retries
+     * @return $this
+     */
+    public function setRetries($retries);
+
+    /**
+     * Get error log
+     *
+     * @return string|null
+     */
+    public function getErrorLog();
+
+    /**
+     * Set error log
+     *
+     * @param string $errorLog
+     * @return $this
+     */
+    public function setErrorLog($errorLog);
+
+    /**
+     * Get data size
+     *
+     * @return int|null
+     */
+    public function getDataSize();
+
+    /**
+     * Set data size
+     *
+     * @param int $dataSize
+     * @return $this
+     */
+    public function setDataSize($dataSize);
+
+    /**
+     * Get whether the job is part of a full reindex
+     *
+     * @return bool
+     */
+    public function getIsFullReindex();
+
+    /**
+     * Set whether the job is part of a full reindex
+     *
+     * @param bool $isFullReindex
+     * @return $this
+     */
+    public function setIsFullReindex($isFullReindex);
+
+    /**
+     * Get creation date and time
+     *
+     * @return string
+     */
+    public function getCreatedAt();
+
+    /**
+     * Set creation date and time
+     *
+     * @param string $createdAt
+     * @return $this
+     */
+    public function setCreatedAt($createdAt);
+
+    /**
+     * Get processing date and time
+     *
+     * @return string|null
+     */
+    public function getProcessedAt();
+
+    /**
+     * Set processing date and time
+     *
+     * @param string $processedAt
+     * @return $this
+     */
+    public function setProcessedAt($processedAt);
+
+    /**
+     * Get whether the job was successful
+     *
+     * @return bool
+     */
+    public function getSuccess();
+
+    /**
+     * Set whether the job was successful
+     *
+     * @param bool $success
+     * @return $this
+     */
+    public function setSuccess($success);
+
+    /**
+     * Get debug info
+     *
+     * @return string|null
+     */
+    public function getDebug();
+
+    /**
+     * Set debug info
+     *
+     * @param string $debug
+     * @return $this
+     */
+    public function setDebug($debug);
+}
+

Api/QueueArchiveRepositoryInterface.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api;
+
+use Algolia\AlgoliaSearch\Api\Data\QueueArchiveInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * Interface QueueArchiveRepositoryInterface
+ * @package Algolia\AlgoliaSearch\Api
+ */
+interface QueueArchiveRepositoryInterface
+{
+    /**
+     * Save queue archive
+     *
+     * @param QueueArchiveInterface $queueArchive
+     * @return QueueArchiveInterface
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function save(QueueArchiveInterface $queueArchive);
+
+    /**
+     * Retrieve queue archive by id
+     *
+     * @param int $id
+     * @return QueueArchiveInterface
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function getById($id);
+
+    /**
+     * Retrieve queue archives matching the specified criteria
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria);
+
+    /**
+     * Delete queue archive
+     *
+     * @param QueueArchiveInterface $queueArchive
+     * @return bool true on success
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function delete(QueueArchiveInterface $queueArchive);
+
+    /**
+     * Delete queue archive by ID
+     *
+     * @param int $id
+     * @return bool true on success
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function deleteById($id);
+}

Block/Adminhtml/QueueArchive/View.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Block\Adminhtml\QueueArchive;
+
+use Magento\Backend\Block\Widget\Button;
+use Magento\Framework\Registry;
+use Magento\Framework\View\Element\Template;
+use Magento\Framework\View\Element\Template\Context;
+
+class View extends Template
+{
+    /** @var Registry */
+    protected $coreRegistry;
+
+    /**
+     * @param Context       $context
+     * @param Registry      $coreRegistry
+     * @param array         $data
+     */
+    public function __construct(
+        Context       $context,
+        Registry      $coreRegistry,
+        array $data = []
+    ) {
+        parent::__construct($context, $data);
+
+        $this->coreRegistry = $coreRegistry;
+    }
+
+    /** @inheritdoc */
+    protected function _prepareLayout()
+    {
+        /** @var Button $button */
+        $button = $this->getLayout()->createBlock(Button::class);
+        $button->setData(
+            [
+                'label' => __('Back'),
+                'onclick' => 'setLocation(\'' . $this->getBackUrl() . '\')',
+                'class' => 'back',
+            ]
+        );
+
+        $this->getToolbar()->setChild('back_button', $button);
+
+        return parent::_prepareLayout();
+    }
+
+    /** @return \Algolia\AlgoliaSearch\Model\QueueArchive */
+    public function getCurrentJob()
+    {
+        return $this->coreRegistry->registry('current_job');
+    }
+
+    /**  @return string */
+    public function getBackUrl()
+    {
+        return $this->getUrl('*/*/index');
+    }
+
+    /**
+     * Return toolbar block instance
+     *
+     * @return bool|\Magento\Framework\View\Element\Template
+     */
+    public function getToolbar()
+    {
+        return $this->getLayout()->getBlock('page.actions.toolbar');
+    }
+}