BEdita\ElasticSearch\Model\Index\IndexTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteOrFail()	0	4	2
A	saveOrFail()	0	7	2
A	getIfExists()	0	6	2
A	set()	0	7	1

<?php
declare(strict_types=1);

namespace BEdita\ElasticSearch\Model\Index;

use Cake\Datasource\EntityInterface;
use Cake\ORM\Exception\PersistenceFailedException;
use Elastica\Document;
use Elastica\Exception\NotFoundException;

trait IndexTrait
{
    /**
     * Retrieve a document from the index.
     *
     * @param string $primaryKey Document ID.
     * @param array $options Array of options.
     * @return \Cake\Datasource\EntityInterface
     */
    abstract public function get(string $primaryKey, array $options = []): EntityInterface;

    /**
     * Persist a document to the index.
     *
     * @param \Cake\Datasource\EntityInterface $entity Document.
     * @param array $options Array of options.
     * @return \Cake\Datasource\EntityInterface|false
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint
     */
    abstract public function save(EntityInterface $entity, array $options);

    /**
     * Delete a document from the index.
     *
     * @param \Cake\Datasource\EntityInterface $entity Document.
     * @param array $options Array of options.
     * @return bool
     */
    abstract public function delete(EntityInterface $entity, array $options): bool;

    /**
     * Retrieve a document from the index if exists, or `null` on failure.
     *
     * @see \Cake\ElasticSearch\Index::get()
     * @param string $primaryKey Document ID.
     * @param array $options Array of options.
     * @return \Cake\Datasource\EntityInterface|null
     */
    public function getIfExists(string $primaryKey, array $options = []): EntityInterface|null
    {
        try {
            return $this->get($primaryKey, $options);
        } catch (NotFoundException) {
            return null;
        }
    }

    /**
     * Persist a document to the index, or throw an exception upon failure.
     *
     * @param \Cake\Datasource\EntityInterface $entity Document.
     * @param array $options
     * @return \Cake\Datasource\EntityInterface
     */
    public function saveOrFail(EntityInterface $entity, array $options = []): EntityInterface
    {
        if ($this->save($entity, $options) === false) {
            throw new PersistenceFailedException($entity, ['save']);
        }

        return $entity;
    }

    /**
     * Delete a document from the index, or throw an exception upon failure.
     *
     * @param \Cake\Datasource\EntityInterface $entity Document.
     * @param array $options Array of options.
     * @return void
     */
    public function deleteOrFail(EntityInterface $entity, array $options): void
    {
        if ($this->delete($entity, $options) === false) {
            throw new PersistenceFailedException($entity, ['delete']);
        }
    }

    /**
     * Update a single field on an existing document.
     *
     * @param string $primaryKey Document ID.
     * @param string $field Name of field to update.
     * @param mixed $value New value.
     * @return bool Success.
     */
    public function set(string $primaryKey, string $field, mixed $value): bool
    {
        $esIndex = $this->getConnection()->getIndex($this->getName());

It seems like getConnection() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $document = new Document($primaryKey, [$field => $value]);
        $response = $esIndex->updateDocument($document);

        return $response->isOk();
    }
}