meilisearch/Classes/IndexQueue/PageIndexerResponse.php
2021-04-17 00:26:33 +02:00

159 lines
4.2 KiB
PHP

<?php
namespace WapplerSystems\Meilisearch\IndexQueue;
/***************************************************************
* 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.
*
* 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!
***************************************************************/
/**
* Index Queue Page Indexer response to provide data for requested actions.
*
* @author Ingo Renner <ingo@typo3.org>
*/
class PageIndexerResponse
{
/**
* Unique request ID.
*
* @var string
*/
protected $requestId = null;
/**
* The actions' results as action => result pairs.
*
* @var array
*/
protected $results = [];
/**
* Turns a JSON encoded result string back into its PHP representation.
*
* @param string $jsonEncodedResponse JSON encoded result string
* @return array|bool An array of action => result pairs or FALSE if the response could not be decoded
*/
public static function getResultsFromJson($jsonEncodedResponse)
{
$responseData = json_decode($jsonEncodedResponse, true);
if (is_array($responseData['actionResults'])) {
foreach ($responseData['actionResults'] as $action => $serializedActionResult) {
$responseData['actionResults'][$action] = unserialize($serializedActionResult);
}
} elseif (is_null($responseData)) {
$responseData = false;
}
return $responseData;
}
/**
* Adds an action's result.
*
* @param string $action The action name.
* @param mixed $result The action's result.
* @throws \RuntimeException if $action is null
*/
public function addActionResult($action, $result)
{
if (is_null($action)) {
throw new \RuntimeException(
'Attempt to provide a result without providing an action',
1294080509
);
}
$this->results[$action] = $result;
}
/**
* Gets the complete set of results or a specific action's results.
*
* @param string $action Optional action name.
* @return array
*/
public function getActionResult($action = null)
{
$result = $this->results;
if (!empty($action)) {
$result = $this->results[$action];
}
return $result;
}
/**
* Compiles the response's content so that it can be sent back to the
* Index Queue page indexer.
*
* @return string The response content
*/
public function getContent()
{
return $this->toJson();
}
/**
* Converts the response's data to JSON.
*
* @return string JSON representation of the results.
*/
protected function toJson()
{
$serializedActionResults = [];
foreach ($this->results as $action => $result) {
$serializedActionResults[$action] = serialize($result);
}
$responseData = [
'requestId' => $this->requestId,
'actionResults' => $serializedActionResults
];
return json_encode($responseData);
}
/**
* Gets the Id of the request this response belongs to.
*
* @return string Request Id.
*/
public function getRequestId()
{
return $this->requestId;
}
/**
* Sets the Id of the request this response belongs to.
*
* @param string $requestId Request Id.
* @return void
*/
public function setRequestId($requestId)
{
$this->requestId = $requestId;
}
}