first commit

Classes/IndexQueue/FrontendHelper/FrontendHelper.php

@@ -0,0 +1,70 @@
+<?php
+namespace WapplerSystems\Meilisearch\IndexQueue\FrontendHelper;
+
+/***************************************************************
+ *  Copyright notice
+ *
+ *  (c) 2010-2015 Ingo Renner <ingo@typo3.org>
+ *  All rights reserved
+ *
+ *  This script is part of the TYPO3 project. The TYPO3 project is
+ *  free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  The GNU General Public License can be found at
+ *  http://www.gnu.org/copyleft/gpl.html.
+ *  A copy is found in the textfile GPL.txt and important notices to the license
+ *  from the author is found in LICENSE.txt distributed with these scripts.
+ *
+ *
+ *  This script is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  This copyright notice MUST APPEAR in all copies of the script!
+ ***************************************************************/
+
+use WapplerSystems\Meilisearch\IndexQueue\PageIndexerRequest;
+use WapplerSystems\Meilisearch\IndexQueue\PageIndexerResponse;
+
+/**
+ * Index Queue Frontend Helper interface.
+ *
+ * @author Ingo Renner <ingo@typo3.org>
+ */
+interface FrontendHelper
+{
+
+    /**
+     * Activates a frontend helper by registering for hooks and other
+     * resources required by the frontend helper to work.
+     */
+    public function activate();
+
+    /**
+     * Deactivates a frontend helper by unregistering from hooks and releasing
+     * resources.
+     */
+    public function deactivate();
+
+    /**
+     * Starts the execution of a frontend helper.
+     *
+     * @param PageIndexerRequest $request Page indexer request
+     * @param PageIndexerResponse $response Page indexer response
+     */
+    public function processRequest(
+        PageIndexerRequest $request,
+        PageIndexerResponse $response
+    );
+
+    /**
+     * Returns the collected data.
+     *
+     * @return array Collected data.
+     */
+    public function getData();
+}