1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 
<?php
namespace Omeka\Mvc\Controller\Plugin;

use Omeka\Api\Exception\ValidationException;
use Omeka\Api\Manager;
use Omeka\Api\Response;
use Omeka\Stdlib\ErrorStore;
use Zend\Form\Form;
use Zend\Mvc\Controller\Plugin\AbstractPlugin;

/**
 * Controller plugin for providing passthrough methods to the API manager.
 */
class Api extends AbstractPlugin
{
    /**
     * @var Manager
     */
    protected $api;

    /**
     * @var Form
     */
    protected $form;

    /**
     * @var bool
     */
    protected $throwValidationException = false;

    /**
     * Construct the plugin.
     *
     * @param Manager $api
     */
    public function __construct(Manager $api)
    {
        $this->api = $api;
    }

    /**
     * Set this API request's corresponding form, if any.
     *
     * @param null|Form $form
     * @param bool $throwValidationException
     */
    public function __invoke(Form $form = null, $throwValidationException = false)
    {
        $this->form = $form;
        $this->throwValidationException = $throwValidationException;
        return $this;
    }

    /**
     * Execute a search API request.
     *
     * @param string $resource
     * @param array $data
     * @return Response
     */
    public function search($resource, $data = [], array $options = [])
    {
        return $this->api->search($resource, $data, $options);
    }

    /**
     * Execute a search API request and get the first result.
     *
     * Sets the first result to the response content or null if there is no
     * result. Note that this functionality is not native to the API.
     *
     * @param string $resource
     * @param array $data
     * @param array $options
     * @return Response
     */
    public function searchOne($resource, $data = [], array $options = [])
    {
        $data['limit'] = 1;
        $response = $this->search($resource, $data, $options);
        $content = $response->getContent();
        $content = is_array($content) && count($content) ? $content[0] : null;
        $response->setContent($content);
        return $response;
    }

    /**
     * Execute a create API request.
     *
     * @param string $resource
     * @param array $data
     * @param array $fileData
     * @param array $options
     * @return Response|false Returns false on validation error
     */
    public function create($resource, $data = [], $fileData = [], array $options = [])
    {
        try {
            return $this->api->create($resource, $data, $fileData, $options);
        } catch (ValidationException $e) {
            $this->handleValidationException($e);
            return false;
        }
    }

    /**
     * Execute a batch create API request.
     *
     * @param string $resource
     * @param array $data
     * @param array $fileData
     * @param array $options
     * @return Response|false Returns false on validation error
     */
    public function batchCreate($resource, $data = [], $fileData = [], array $options = [])
    {
        try {
            return $this->api->batchCreate($resource, $data, $fileData, $options);
        } catch (ValidationException $e) {
            $this->handleValidationException($e);
            return false;
        }
    }

    /**
     * Execute a read API request.
     *
     * @param string $resource
     * @param mixed $id
     * @param array $data
     * @param array $options
     * @return Response
     */
    public function read($resource, $id, $data = [], array $options = [])
    {
        return $this->api->read($resource, $id, $data, $options);
    }

    /**
     * Execute an update API request.
     *
     * @param string $resource
     * @param mixed $id
     * @param array $data
     * @param array $fileData
     * @param array $options
     * @return Response|false Returns false on validation error
     */
    public function update($resource, $id, $data = [], $fileData = [], array $options = [])
    {
        try {
            return $this->api->update($resource, $id, $data, $fileData, $options);
        } catch (ValidationException $e) {
            $this->handleValidationException($e);
            return false;
        }
    }

    /**
     * Execute a batch update API request.
     *
     * @param string $resource
     * @param array $ids
     * @param array $data
     * @param array $options
     * @return Response|false Returns false on validation error
     */
    public function batchUpdate($resource, array $ids, $data = [], array $options = [])
    {
        try {
            return $this->api->batchUpdate($resource, $ids, $data, $options);
        } catch (ValidationException $e) {
            $this->handleValidationException($e);
            return false;
        }
    }

    /**
     * Execute a delete API request.
     *
     * @param string $resource
     * @param mixed $id
     * @param array $data
     * @param array $options
     * @return Response
     */
    public function delete($resource, $id, $data = [], array $options = [])
    {
        return $this->api->delete($resource, $id, $data, $options);
    }

    /**
     * Execute a batch delete API request.
     *
     * @param string $resource
     * @param array $ids
     * @param array $data
     * @param array $options
     * @return Response|false Returns false on validation error
     */
    public function batchDelete($resource, array $ids, array $data = [], array $options = [])
    {
        try {
            return $this->api->batchDelete($resource, $ids, $data, $options);
        } catch (ValidationException $e) {
            $this->handleValidationException($e);
            return false;
        }
    }

    /**
     * Handle an API validation exception.
     *
     * @throws ValidationException
     * @param ErrorStore $errorStore
     */
    public function handleValidationException(ValidationException $e)
    {
        $errorStore = $e->getErrorStore();
        if ($this->form) {
            $formMessages = [];
            foreach ($errorStore->getErrors() as $key => $messages) {
                foreach ($messages as $message) {
                    // Do not set nested errors to the form.
                    if (!is_array($message)) {
                        $formMessages[$key][] = $this->getController()->translate($message);
                    }
                }
            }
            $this->form->setMessages($formMessages);
            $this->getController()->messenger()->addErrors($errorStore->getErrors());
        }
        if ($this->throwValidationException) {
            throw $e;
        }
    }
}