Manager::setReadOnly() - Code Metrics - Inspection of "implemented retrievement of id after commit()" - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#589)

unknown

created 2016-03-16 08:57 UTC

Manager::setReadOnly() A

↳ Parent: Manager

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Service;

use Elasticsearch\Client;
use Elasticsearch\Common\Exceptions\Forbidden403Exception;
use Elasticsearch\Common\Exceptions\Missing404Exception;
use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
use ONGR\ElasticsearchBundle\Result\AbstractResultsIterator;
use ONGR\ElasticsearchBundle\Result\Converter;
use ONGR\ElasticsearchBundle\Result\DocumentIterator;
use ONGR\ElasticsearchBundle\Result\RawIterator;
use ONGR\ElasticsearchBundle\Result\Result;
use ONGR\ElasticsearchDSL\Search;

/**
 * Manager class.
 */
class Manager
{
    /**
     * @var string Manager name
     */
    private $name;

    /**
     * @var array Manager configuration
     */
    private $config = [];

    /**
     * @var Client
     */
    private $client;

    /**
     * @var Converter
     */
    private $converter;

    /**
     * @var bool
     */
    private $readOnly;

    /**
     * @var array Container for bulk queries
     */
    private $bulkQueries = [];

    /**
     * @var array Holder for consistency, refresh and replication parameters
     */
    private $bulkParams = [];

    /**
     * @var array
     */
    private $indexSettings;

    /**
     * @var MetadataCollector
     */
    private $metadataCollector;

    /**
     * After commit to make data available the refresh or flush operation is needed
     * so one of those methods has to be defined, the default is refresh.
     *
     * @var string
     */
    private $commitMode = 'refresh';

    /**
     * Reference to the persisted objects that need to be given an ID that returns from
     * elasticsearch
     *
     * @var array
     */
    private $persistedObjects = [];

    /**
     * The size that defines after how much document inserts call commit function.
     *
     * @var int
     */
    private $bulkCommitSize = 100;

    /**
     * Container to count how many documents was passed to the bulk query.
     *
     * @var int
     */
    private $bulkCount = 0;

    /**
     * @var Repository[] Repository local cache
     */
    private $repositories;

    /**
     * @param string            $name              Manager name
     * @param array             $config            Manager configuration
     * @param Client            $client
     * @param array             $indexSettings
     * @param MetadataCollector $metadataCollector
     * @param Converter         $converter
     */
    public function __construct(
        $name,
        array $config,
        $client,
        array $indexSettings,
        $metadataCollector,
        $converter
    ) {
        $this->name = $name;
        $this->config = $config;
        $this->client = $client;
        $this->indexSettings = $indexSettings;
        $this->metadataCollector = $metadataCollector;
        $this->converter = $converter;

        $this->setReadOnly($config['readonly']);
    }

    /**
     * Returns Elasticsearch connection.
     *
     * @return Client
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return array
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Returns repository by document class.
     *
     * @param string $className FQCN or string in Bundle:Document format
     *
     * @return Repository
     */
    public function getRepository($className)
    {
        if (!is_string($className)) {
            throw new \InvalidArgumentException('Document class must be a string.');
        }

        $namespace = $this->getMetadataCollector()->getClassName($className);

        if (isset($this->repositories[$namespace])) {
            return $this->repositories[$namespace];
        }

        $repository = $this->createRepository($namespace);
        $this->repositories[$namespace] = $repository;

        return $repository;
    }

    /**
     * @return MetadataCollector
     */
    public function getMetadataCollector()
    {
        return $this->metadataCollector;
    }

    /**
     * @return Converter
     */
    public function getConverter()
    {
        return $this->converter;
    }

    /**
     * @return string
     */
    public function getCommitMode()
    {
        return $this->commitMode;
    }

    /**
     * @param string $commitMode
     */
    public function setCommitMode($commitMode)
    {
        if ($commitMode === 'refresh' || $commitMode === 'flush' || $commitMode === 'none') {
            $this->commitMode = $commitMode;
        } else {
            throw new \LogicException('The commit method must be either refresh, flush or none.');
        }
    }

    /**
     * @return int
     */
    public function getBulkCommitSize()
    {
        return $this->bulkCommitSize;
    }

    /**
     * @param int $bulkCommitSize
     */
    public function setBulkCommitSize($bulkCommitSize)
    {
        $this->bulkCommitSize = $bulkCommitSize;
    }

    /**
     * Creates a repository.
     *
     * @param string $className
     *
     * @return Repository
     */
    private function createRepository($className)
    {
        return new Repository($this, $className);
    }

    /**
     * Executes search query in the index.
     *
     * @param array $types             List of types to search in.
     * @param array $query             Query to execute.
     * @param array $queryStringParams Query parameters.
     *
     * @return array
     */
    public function search(array $types, array $query, array $queryStringParams = [])
    {
        $params = [];
        $params['index'] = $this->getIndexName();
        $params['type'] = implode(',', $types);
        $params['body'] = $query;

        if (!empty($queryStringParams)) {
            $params = array_merge($queryStringParams, $params);
        }

        return $this->client->search($params);
    }

    /**
     * Adds document to next flush.
     *
     * @param object $document
     */
    public function persist($document)
    {
        $documentArray = $this->converter->convertToArray($document);
        $type = $this->getMetadataCollector()->getDocumentType(get_class($document));

        $this->bulk('index', $type, $documentArray);

        if ($id_field_info = $this->getIdFieldInfo($document)) {
            if ($id_field_info['property_type'] == 'public') {
                $id_field = $id_field_info['id_property'];
                if(!isset($document->$id_field)) {
                    $this->persistedObjects[] = $document;
                }
            } elseif (isset($id_field_info['getter'])) {
                $getter = $id_field_info['getter'];
                if($document->$getter() == null) {
                    $this->persistedObjects[] = $document;
                }
            }
        }
    }

    /**
     * Adds document for removal.
     *
     * @param object $document
     */
    public function remove($document)
    {
        $data = $this->converter->convertToArray($document, [], ['_id']);

        if (!isset($data['_id'])) {
            throw new \LogicException(
                'In order to use remove() method document class must have property with @Id annotation.'
            );
        }

        $type = $this->getMetadataCollector()->getDocumentType(get_class($document));

        $this->bulk('delete', $type, ['_id' => $data['_id']]);
    }

    /**
     * Flushes elasticsearch index.
     *
     * @param array $params
     *
     * @return array
     */
    public function flush(array $params = [])
    {
        return $this->client->indices()->flush($params);
    }

    /**
     * Refreshes elasticsearch index.
     *
     * @param array $params
     *
     * @return array
     */
    public function refresh(array $params = [])
    {
        return $this->client->indices()->refresh($params);
    }

    /**
     * Gets Id field of the document
     *
     * @param object $document
     *
     * @return mixed
     */
    public function getIdFieldInfo($document) {
        $class = get_class($document);
        $mapping = $this->metadataCollector->getMapping($class);
        $response = [];

        if (isset($mapping['aliases']['_id'])) {
            $mapping = $mapping['aliases']['_id'];
            $response['id_property'] = $mapping['propertyName'];
            $response['property_type'] = 'private';

            if ($mapping['propertyType'] == 'public') {
                $response['property_type'] = 'public';
            } elseif (isset($mapping['methods']['setter']) && isset($mapping['methods']['getter'])) {
                $response['setter'] = $mapping['methods']['setter'];
                $response['getter'] = $mapping['methods']['getter'];
            }
        } else {
            return false;
        }
        return $response;
    }

    /**
     * Adds ids to documents
     *
     * @param array $bulkQueries
     *
     * @param array $bulkResponse
     */
    public function addIds(array $bulkQueries, $bulkResponse = [])
    {
        if (empty($bulkResponse)) {
            $this->persistedObjects = [];
            return;
        }
        $indexing = [];
        foreach ($bulkQueries['body'] as $number => $query) {
            if (isset($query['index']) && !isset($query['index']['_id'])) {
                $indexing[] = $number / 2;
            }
        }
        if (isset($bulkQueries['body'][0]['index'])) {
            if (isset($this->persistedObjects)) {
                $i = 0;
                foreach ($this->persistedObjects as $document) {
                    if ($id_field_info = $this->getIdFieldInfo($document)) {
                        if ($id_field_info['property_type'] == 'public') {
                            $id_field = $id_field_info['id_property'];
                            $document->$id_field = $bulkResponse['items'][$indexing[$i]]['create']['_id'];
                        } elseif ($id_field_info['setter']) {
                            $method = $id_field_info['setter'];
                            $document->$method($bulkResponse['items'][$indexing[$i]]['create']['_id']);
                        }
                    }
                    $i++;
                }
            }
            $this->persistedObjects = [];
        }
    }

    /**
     * Inserts the current query container to the index, used for bulk queries execution.
     *
     * @param array $params Parameters that will be passed to the flush or refresh queries.
     *
     * @return null|array
     */
    public function commit(array $params = [])
    {
        $this->isReadOnly('Commit');

        if (!empty($this->bulkQueries)) {
            $bulkQueries = array_merge($this->bulkQueries, $this->bulkParams);
            $this->bulkQueries = [];

            $bulkResponse = $this->client->bulk($bulkQueries);

            switch ($this->getCommitMode()) {
                case 'flush':
                    $this->flush($params);
                    break;
                case 'refresh':
                    $this->refresh($params);
                    break;
            }

            $this->addIds($bulkQueries, $bulkResponse);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            return $bulkResponse;
        }
        return null;
    }

    /**
     * Adds query to bulk queries container.
     *
     * @param string       $operation One of: index, update, delete, create.
     * @param string|array $type      Elasticsearch type name.
     * @param array        $query     DSL to execute.
     *
     * @throws \InvalidArgumentException
     */
    public function bulk($operation, $type, array $query)
    {
        $this->isReadOnly('Bulk');

        if (!in_array($operation, ['index', 'create', 'update', 'delete'])) {
            throw new \InvalidArgumentException('Wrong bulk operation selected');
        }

        $this->bulkQueries['body'][] = [
            $operation => array_filter(
                [
                    '_index' => $this->getIndexName(),
                    '_type' => $type,
                    '_id' => isset($query['_id']) ? $query['_id'] : null,
                    '_ttl' => isset($query['_ttl']) ? $query['_ttl'] : null,
                    '_parent' => isset($query['_parent']) ? $query['_parent'] : null,
                ]
            ),
        ];
        unset($query['_id'], $query['_ttl'], $query['_parent']);

        switch ($operation) {
            case 'index':
            case 'create':
            case 'update':
                $this->bulkQueries['body'][] = $query;
                break;
            case 'delete':
                // Body for delete operation is not needed to apply.
            default:
                // Do nothing.
                break;
        }

        // We are using counter because there is to difficult to resolve this from bulkQueries array.
        $this->bulkCount++;

        if ($this->bulkCommitSize === $this->bulkCount) {
            $this->commit();
            $this->bulkCount = 0;
        }
    }

    /**
     * Optional setter to change bulk query params.
     *
     * @param array $params Possible keys:
     *                      ['consistency'] = (enum) Explicit write consistency setting for the operation.
     *                      ['refresh']     = (boolean) Refresh the index after performing the operation.
     *                      ['replication'] = (enum) Explicitly set the replication type.
     */
    public function setBulkParams(array $params)
    {
        $this->bulkParams = $params;
    }

    /**
     * Creates fresh elasticsearch index.
     *
     * @param bool $noMapping Determines if mapping should be included.
     *
     * @return array
     */
    public function createIndex($noMapping = false)
    {
        $this->isReadOnly('Create index');

        if ($noMapping) {
            unset($this->indexSettings['body']['mappings']);
        }

        return $this->getClient()->indices()->create($this->indexSettings);
    }

    /**
     * Drops elasticsearch index.
     */
    public function dropIndex()
    {
        $this->isReadOnly('Drop index');

        return $this->getClient()->indices()->delete(['index' => $this->getIndexName()]);
    }

    /**
     * Tries to drop and create fresh elasticsearch index.
     *
     * @param bool $noMapping Determines if mapping should be included.
     *
     * @return array
     */
    public function dropAndCreateIndex($noMapping = false)
    {
        try {
            $this->dropIndex();
        } catch (\Exception $e) {
            // Do nothing, our target is to create new index.
        }

        return $this->createIndex($noMapping);
    }

    /**
     * Checks if connection index is already created.
     *
     * @return bool
     */
    public function indexExists()
    {
        return $this->getClient()->indices()->exists(['index' => $this->getIndexName()]);
    }

    /**
     * Returns index name this connection is attached to.
     *
     * @return string
     */
    public function getIndexName()
    {
        return $this->indexSettings['index'];
    }

    /**
     * Sets index name for this connection.
     *
     * @param string $name
     */
    public function setIndexName($name)
    {
        $this->indexSettings['index'] = $name;
    }

    /**
     * Returns Elasticsearch version number.
     *
     * @return string
     */
    public function getVersionNumber()
    {
        return $this->client->info()['version']['number'];
    }

    /**
     * Clears elasticsearch client cache.
     */
    public function clearCache()
    {
        $this->isReadOnly('Clear cache');

        $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
    }

    /**
     * Set connection to read only state.
     *
     * @param bool $readOnly
     */
    public function setReadOnly($readOnly)
    {
        $this->readOnly = $readOnly;
    }

    /**
     * Checks if connection is read only.
     *
     * @param string $message Error message.
     *
     * @throws Forbidden403Exception
     */
    public function isReadOnly($message = '')
    {
        if ($this->readOnly) {
            throw new Forbidden403Exception("Manager is readonly! {$message} operation is not permitted.");
        }
    }

    /**
     * Returns a single document by ID. Returns NULL if document was not found.
     *
     * @param string $className Document class name or Elasticsearch type name
     * @param string $id        Document ID to find
     *
     * @return object
     */
    public function find($className, $id)
    {
        $type = $this->resolveTypeName($className);

        $params = [
            'index' => $this->getIndexName(),
            'type' => $type,
            'id' => $id,
        ];

        try {
            $result = $this->getClient()->get($params);
        } catch (Missing404Exception $e) {
            return null;
        }

        return $this->getConverter()->convertToDocument($result, $this);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Executes given search.
     *
     * @param array  $types
     * @param Search $search
     * @param string $resultsType
     *
     * @return DocumentIterator|RawIterator|array
     */
    public function execute($types, Search $search, $resultsType = Result::RESULTS_OBJECT)
    {
        foreach ($types as &$type) {
            $type = $this->resolveTypeName($type);
        }

        $results = $this->search($types, $search->toArray(), $search->getQueryParams());

        return $this->parseResult($results, $resultsType, $search->getScroll());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Parses raw result.
     *
     * @param array  $raw
     * @param string $resultsType
     * @param string $scrollDuration
     *
     * @return DocumentIterator|RawIterator|array
     *
     * @throws \Exception
     */
    private function parseResult($raw, $resultsType, $scrollDuration = null)
    {
        $scrollConfig = [];
        if (isset($raw['_scroll_id'])) {
            $scrollConfig['_scroll_id'] = $raw['_scroll_id'];
            $scrollConfig['duration'] = $scrollDuration;
        }

        switch ($resultsType) {
            case Result::RESULTS_OBJECT:
                return new DocumentIterator($raw, $this, $scrollConfig);
            case Result::RESULTS_ARRAY:
                return $this->convertToNormalizedArray($raw);
            case Result::RESULTS_RAW:
                return $raw;
            case Result::RESULTS_RAW_ITERATOR:
                return new RawIterator($raw, $this, $scrollConfig);
            default:
                throw new \Exception('Wrong results type selected');
        }
    }

    /**
     * Normalizes response array.
     *
     * @param array $data
     *
     * @return array
     */
    private function convertToNormalizedArray($data)
    {
        if (array_key_exists('_source', $data)) {
            return $data['_source'];
        }

        $output = [];

        if (isset($data['hits']['hits'][0]['_source'])) {
            foreach ($data['hits']['hits'] as $item) {
                $output[] = $item['_source'];
            }
        } elseif (isset($data['hits']['hits'][0]['fields'])) {
            foreach ($data['hits']['hits'] as $item) {
                $output[] = array_map('reset', $item['fields']);
            }
        }

        return $output;
    }

    /**
     * Fetches next set of results.
     *
     * @param string $scrollId
     * @param string $scrollDuration
     * @param string $resultsType
     *
     * @return AbstractResultsIterator
     *
     * @throws \Exception
     */
    public function scroll(
        $scrollId,
        $scrollDuration = '5m',
        $resultsType = Result::RESULTS_OBJECT
    ) {
        $results = $this->getClient()->scroll(['scroll_id' => $scrollId, 'scroll' => $scrollDuration]);

        return $this->parseResult($results, $resultsType, $scrollDuration);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Clears scroll.
     *
     * @param string $scrollId
     */
    public function clearScroll($scrollId)
    {
        $this->getClient()->clearScroll(['scroll_id' => $scrollId]);
    }

    /**
     * Resolves type name by class name.
     *
     * @param string $className
     *
     * @return string
     */
    private function resolveTypeName($className)
    {
        if (strpos($className, ':') !== false || strpos($className, '\\') !== false) {
            return $this->getMetadataCollector()->getDocumentType($className);
        }

        return $className;
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\ElasticsearchBundle\Service;
13
14			use Elasticsearch\Client;
15			use Elasticsearch\Common\Exceptions\Forbidden403Exception;
16			use Elasticsearch\Common\Exceptions\Missing404Exception;
17			use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
18			use ONGR\ElasticsearchBundle\Result\AbstractResultsIterator;
19			use ONGR\ElasticsearchBundle\Result\Converter;
20			use ONGR\ElasticsearchBundle\Result\DocumentIterator;
21			use ONGR\ElasticsearchBundle\Result\RawIterator;
22			use ONGR\ElasticsearchBundle\Result\Result;
23			use ONGR\ElasticsearchDSL\Search;
24
25			/**
26			* Manager class.
27			*/
28			class Manager
29			{
30			/**
31			* @var string Manager name
32			*/
33			private $name;
34
35			/**
36			* @var array Manager configuration
37			*/
38			private $config = [];
39
40			/**
41			* @var Client
42			*/
43			private $client;
44
45			/**
46			* @var Converter
47			*/
48			private $converter;
49
50			/**
51			* @var bool
52			*/
53			private $readOnly;
54
55			/**
56			* @var array Container for bulk queries
57			*/
58			private $bulkQueries = [];
59
60			/**
61			* @var array Holder for consistency, refresh and replication parameters
62			*/
63			private $bulkParams = [];
64
65			/**
66			* @var array
67			*/
68			private $indexSettings;
69
70			/**
71			* @var MetadataCollector
72			*/
73			private $metadataCollector;
74
75			/**
76			* After commit to make data available the refresh or flush operation is needed
77			* so one of those methods has to be defined, the default is refresh.
78			*
79			* @var string
80			*/
81			private $commitMode = 'refresh';
82
83			/**
84			* Reference to the persisted objects that need to be given an ID that returns from
85			* elasticsearch
86			*
87			* @var array
88			*/
89			private $persistedObjects = [];
90
91			/**
92			* The size that defines after how much document inserts call commit function.
93			*
94			* @var int
95			*/
96			private $bulkCommitSize = 100;
97
98			/**
99			* Container to count how many documents was passed to the bulk query.
100			*
101			* @var int
102			*/
103			private $bulkCount = 0;
104
105			/**
106			* @var Repository[] Repository local cache
107			*/
108			private $repositories;
109
110			/**
111			* @param string $name Manager name
112			* @param array $config Manager configuration
113			* @param Client $client
114			* @param array $indexSettings
115			* @param MetadataCollector $metadataCollector
116			* @param Converter $converter
117			*/
118			public function __construct(
119			$name,
120			array $config,
121			$client,
122			array $indexSettings,
123			$metadataCollector,
124			$converter
125			) {
126			$this->name = $name;
127			$this->config = $config;
128			$this->client = $client;
129			$this->indexSettings = $indexSettings;
130			$this->metadataCollector = $metadataCollector;
131			$this->converter = $converter;
132
133			$this->setReadOnly($config['readonly']);
134			}
135
136			/**
137			* Returns Elasticsearch connection.
138			*
139			* @return Client
140			*/
141			public function getClient()
142			{
143			return $this->client;
144			}
145
146			/**
147			* @return string
148			*/
149			public function getName()
150			{
151			return $this->name;
152			}
153
154			/**
155			* @return array
156			*/
157			public function getConfig()
158			{
159			return $this->config;
160			}
161
162			/**
163			* Returns repository by document class.
164			*
165			* @param string $className FQCN or string in Bundle:Document format
166			*
167			* @return Repository
168			*/
169			public function getRepository($className)
170			{
171			if (!is_string($className)) {
172			throw new \InvalidArgumentException('Document class must be a string.');
173			}
174
175			$namespace = $this->getMetadataCollector()->getClassName($className);
176
177			if (isset($this->repositories[$namespace])) {
178			return $this->repositories[$namespace];
179			}
180
181			$repository = $this->createRepository($namespace);
182			$this->repositories[$namespace] = $repository;
183
184			return $repository;
185			}
186
187			/**
188			* @return MetadataCollector
189			*/
190			public function getMetadataCollector()
191			{
192			return $this->metadataCollector;
193			}
194
195			/**
196			* @return Converter
197			*/
198			public function getConverter()
199			{
200			return $this->converter;
201			}
202
203			/**
204			* @return string
205			*/
206			public function getCommitMode()
207			{
208			return $this->commitMode;
209			}
210
211			/**
212			* @param string $commitMode
213			*/
214			public function setCommitMode($commitMode)
215			{
216			if ($commitMode === 'refresh' \|\| $commitMode === 'flush' \|\| $commitMode === 'none') {
217			$this->commitMode = $commitMode;
218			} else {
219			throw new \LogicException('The commit method must be either refresh, flush or none.');
220			}
221			}
222
223			/**
224			* @return int
225			*/
226			public function getBulkCommitSize()
227			{
228			return $this->bulkCommitSize;
229			}
230
231			/**
232			* @param int $bulkCommitSize
233			*/
234			public function setBulkCommitSize($bulkCommitSize)
235			{
236			$this->bulkCommitSize = $bulkCommitSize;
237			}
238
239			/**
240			* Creates a repository.
241			*
242			* @param string $className
243			*
244			* @return Repository
245			*/
246			private function createRepository($className)
247			{
248			return new Repository($this, $className);
249			}
250
251			/**
252			* Executes search query in the index.
253			*
254			* @param array $types List of types to search in.
255			* @param array $query Query to execute.
256			* @param array $queryStringParams Query parameters.
257			*
258			* @return array
259			*/
260			public function search(array $types, array $query, array $queryStringParams = [])
261			{
262			$params = [];
263			$params['index'] = $this->getIndexName();
264			$params['type'] = implode(',', $types);
265			$params['body'] = $query;
266
267			if (!empty($queryStringParams)) {
268			$params = array_merge($queryStringParams, $params);
269			}
270
271			return $this->client->search($params);
272			}
273
274			/**
275			* Adds document to next flush.
276			*
277			* @param object $document
278			*/
279			public function persist($document)
280			{
281			$documentArray = $this->converter->convertToArray($document);
282			$type = $this->getMetadataCollector()->getDocumentType(get_class($document));
283
284			$this->bulk('index', $type, $documentArray);
285
286			if ($id_field_info = $this->getIdFieldInfo($document)) {
287			if ($id_field_info['property_type'] == 'public') {
288			$id_field = $id_field_info['id_property'];
289			if(!isset($document->$id_field)) {
290			$this->persistedObjects[] = $document;
291			}
292			} elseif (isset($id_field_info['getter'])) {
293			$getter = $id_field_info['getter'];
294			if($document->$getter() == null) {
295			$this->persistedObjects[] = $document;
296			}
297			}
298			}
299			}
300
301			/**
302			* Adds document for removal.
303			*
304			* @param object $document
305			*/
306			public function remove($document)
307			{
308			$data = $this->converter->convertToArray($document, [], ['_id']);
309
310			if (!isset($data['_id'])) {
311			throw new \LogicException(
312			'In order to use remove() method document class must have property with @Id annotation.'
313			);
314			}
315
316			$type = $this->getMetadataCollector()->getDocumentType(get_class($document));
317
318			$this->bulk('delete', $type, ['_id' => $data['_id']]);
319			}
320
321			/**
322			* Flushes elasticsearch index.
323			*
324			* @param array $params
325			*
326			* @return array
327			*/
328			public function flush(array $params = [])
329			{
330			return $this->client->indices()->flush($params);
331			}
332
333			/**
334			* Refreshes elasticsearch index.
335			*
336			* @param array $params
337			*
338			* @return array
339			*/
340			public function refresh(array $params = [])
341			{
342			return $this->client->indices()->refresh($params);
343			}
344
345			/**
346			* Gets Id field of the document
347			*
348			* @param object $document
349			*
350			* @return mixed
351			*/
352			public function getIdFieldInfo($document) {
353			$class = get_class($document);
354			$mapping = $this->metadataCollector->getMapping($class);
355			$response = [];
356
357			if (isset($mapping['aliases']['_id'])) {
358			$mapping = $mapping['aliases']['_id'];
359			$response['id_property'] = $mapping['propertyName'];
360			$response['property_type'] = 'private';
361
362			if ($mapping['propertyType'] == 'public') {
363			$response['property_type'] = 'public';
364			} elseif (isset($mapping['methods']['setter']) && isset($mapping['methods']['getter'])) {
365			$response['setter'] = $mapping['methods']['setter'];
366			$response['getter'] = $mapping['methods']['getter'];
367			}
368			} else {
369			return false;
370			}
371			return $response;
372			}
373
374			/**
375			* Adds ids to documents
376			*
377			* @param array $bulkQueries
378			*
379			* @param array $bulkResponse
380			*/
381			public function addIds(array $bulkQueries, $bulkResponse = [])
382			{
383			if (empty($bulkResponse)) {
384			$this->persistedObjects = [];
385			return;
386			}
387			$indexing = [];
388			foreach ($bulkQueries['body'] as $number => $query) {
389			if (isset($query['index']) && !isset($query['index']['_id'])) {
390			$indexing[] = $number / 2;
391			}
392			}
393			if (isset($bulkQueries['body'][0]['index'])) {
394			if (isset($this->persistedObjects)) {
395			$i = 0;
396			foreach ($this->persistedObjects as $document) {
397			if ($id_field_info = $this->getIdFieldInfo($document)) {
398			if ($id_field_info['property_type'] == 'public') {
399			$id_field = $id_field_info['id_property'];
400			$document->$id_field = $bulkResponse['items'][$indexing[$i]]['create']['_id'];
401			} elseif ($id_field_info['setter']) {
402			$method = $id_field_info['setter'];
403			$document->$method($bulkResponse['items'][$indexing[$i]]['create']['_id']);
404			}
405			}
406			$i++;
407			}
408			}
409			$this->persistedObjects = [];
410			}
411			}
412
413			/**
414			* Inserts the current query container to the index, used for bulk queries execution.
415			*
416			* @param array $params Parameters that will be passed to the flush or refresh queries.
417			*
418			* @return null\|array
419			*/
420			public function commit(array $params = [])
421			{
422			$this->isReadOnly('Commit');
423
424			if (!empty($this->bulkQueries)) {
425			$bulkQueries = array_merge($this->bulkQueries, $this->bulkParams);
426			$this->bulkQueries = [];
427
428			$bulkResponse = $this->client->bulk($bulkQueries);
429
430			switch ($this->getCommitMode()) {
431			case 'flush':
432			$this->flush($params);
433			break;
434			case 'refresh':
435			$this->refresh($params);
436			break;
437			}
438
439			$this->addIds($bulkQueries, $bulkResponse);
			0 ignored issues – show Documentation introduced 2016-03-15 20:41 UTC by Report Bug Copy Issue Report `$bulkResponse` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
440
441			return $bulkResponse;
442			}
443			return null;
444			}
445
446			/**
447			* Adds query to bulk queries container.
448			*
449			* @param string $operation One of: index, update, delete, create.
450			* @param string\|array $type Elasticsearch type name.
451			* @param array $query DSL to execute.
452			*
453			* @throws \InvalidArgumentException
454			*/
455			public function bulk($operation, $type, array $query)
456			{
457			$this->isReadOnly('Bulk');
458
459			if (!in_array($operation, ['index', 'create', 'update', 'delete'])) {
460			throw new \InvalidArgumentException('Wrong bulk operation selected');
461			}
462
463			$this->bulkQueries['body'][] = [
464			$operation => array_filter(
465			[
466			'_index' => $this->getIndexName(),
467			'_type' => $type,
468			'_id' => isset($query['_id']) ? $query['_id'] : null,
469			'_ttl' => isset($query['_ttl']) ? $query['_ttl'] : null,
470			'_parent' => isset($query['_parent']) ? $query['_parent'] : null,
471			]
472			),
473			];
474			unset($query['_id'], $query['_ttl'], $query['_parent']);
475
476			switch ($operation) {
477			case 'index':
478			case 'create':
479			case 'update':
480			$this->bulkQueries['body'][] = $query;
481			break;
482			case 'delete':
483			// Body for delete operation is not needed to apply.
484			default:
485			// Do nothing.
486			break;
487			}
488
489			// We are using counter because there is to difficult to resolve this from bulkQueries array.
490			$this->bulkCount++;
491
492			if ($this->bulkCommitSize === $this->bulkCount) {
493			$this->commit();
494			$this->bulkCount = 0;
495			}
496			}
497
498			/**
499			* Optional setter to change bulk query params.
500			*
501			* @param array $params Possible keys:
502			* ['consistency'] = (enum) Explicit write consistency setting for the operation.
503			* ['refresh'] = (boolean) Refresh the index after performing the operation.
504			* ['replication'] = (enum) Explicitly set the replication type.
505			*/
506			public function setBulkParams(array $params)
507			{
508			$this->bulkParams = $params;
509			}
510
511			/**
512			* Creates fresh elasticsearch index.
513			*
514			* @param bool $noMapping Determines if mapping should be included.
515			*
516			* @return array
517			*/
518			public function createIndex($noMapping = false)
519			{
520			$this->isReadOnly('Create index');
521
522			if ($noMapping) {
523			unset($this->indexSettings['body']['mappings']);
524			}
525
526			return $this->getClient()->indices()->create($this->indexSettings);
527			}
528
529			/**
530			* Drops elasticsearch index.
531			*/
532			public function dropIndex()
533			{
534			$this->isReadOnly('Drop index');
535
536			return $this->getClient()->indices()->delete(['index' => $this->getIndexName()]);
537			}
538
539			/**
540			* Tries to drop and create fresh elasticsearch index.
541			*
542			* @param bool $noMapping Determines if mapping should be included.
543			*
544			* @return array
545			*/
546			public function dropAndCreateIndex($noMapping = false)
547			{
548			try {
549			$this->dropIndex();
550			} catch (\Exception $e) {
551			// Do nothing, our target is to create new index.
552			}
553
554			return $this->createIndex($noMapping);
555			}
556
557			/**
558			* Checks if connection index is already created.
559			*
560			* @return bool
561			*/
562			public function indexExists()
563			{
564			return $this->getClient()->indices()->exists(['index' => $this->getIndexName()]);
565			}
566
567			/**
568			* Returns index name this connection is attached to.
569			*
570			* @return string
571			*/
572			public function getIndexName()
573			{
574			return $this->indexSettings['index'];
575			}
576
577			/**
578			* Sets index name for this connection.
579			*
580			* @param string $name
581			*/
582			public function setIndexName($name)
583			{
584			$this->indexSettings['index'] = $name;
585			}
586
587			/**
588			* Returns Elasticsearch version number.
589			*
590			* @return string
591			*/
592			public function getVersionNumber()
593			{
594			return $this->client->info()['version']['number'];
595			}
596
597			/**
598			* Clears elasticsearch client cache.
599			*/
600			public function clearCache()
601			{
602			$this->isReadOnly('Clear cache');
603
604			$this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
605			}
606
607			/**
608			* Set connection to read only state.
609			*
610			* @param bool $readOnly
611			*/
612			public function setReadOnly($readOnly)
613			{
614			$this->readOnly = $readOnly;
615			}
616
617			/**
618			* Checks if connection is read only.
619			*
620			* @param string $message Error message.
621			*
622			* @throws Forbidden403Exception
623			*/
624			public function isReadOnly($message = '')
625			{
626			if ($this->readOnly) {
627			throw new Forbidden403Exception("Manager is readonly! {$message} operation is not permitted.");
628			}
629			}
630
631			/**
632			* Returns a single document by ID. Returns NULL if document was not found.
633			*
634			* @param string $className Document class name or Elasticsearch type name
635			* @param string $id Document ID to find
636			*
637			* @return object
638			*/
639			public function find($className, $id)
640			{
641			$type = $this->resolveTypeName($className);
642
643			$params = [
644			'index' => $this->getIndexName(),
645			'type' => $type,
646			'id' => $id,
647			];
648
649			try {
650			$result = $this->getClient()->get($params);
651			} catch (Missing404Exception $e) {
652			return null;
653			}
654
655			return $this->getConverter()->convertToDocument($result, $this);
			0 ignored issues – show Documentation introduced 2015-12-29 10:45 UTC by Report Bug Copy Issue Report `$result` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
656			}
657
658			/**
659			* Executes given search.
660			*
661			* @param array $types
662			* @param Search $search
663			* @param string $resultsType
664			*
665			* @return DocumentIterator\|RawIterator\|array
666			*/
667			public function execute($types, Search $search, $resultsType = Result::RESULTS_OBJECT)
668			{
669			foreach ($types as &$type) {
670			$type = $this->resolveTypeName($type);
671			}
672
673			$results = $this->search($types, $search->toArray(), $search->getQueryParams());
674
675			return $this->parseResult($results, $resultsType, $search->getScroll());
			0 ignored issues – show Documentation introduced 2015-12-29 10:45 UTC by Report Bug Copy Issue Report `$results` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
676			}
677
678			/**
679			* Parses raw result.
680			*
681			* @param array $raw
682			* @param string $resultsType
683			* @param string $scrollDuration
684			*
685			* @return DocumentIterator\|RawIterator\|array
686			*
687			* @throws \Exception
688			*/
689			private function parseResult($raw, $resultsType, $scrollDuration = null)
690			{
691			$scrollConfig = [];
692			if (isset($raw['_scroll_id'])) {
693			$scrollConfig['_scroll_id'] = $raw['_scroll_id'];
694			$scrollConfig['duration'] = $scrollDuration;
695			}
696
697			switch ($resultsType) {
698			case Result::RESULTS_OBJECT:
699			return new DocumentIterator($raw, $this, $scrollConfig);
700			case Result::RESULTS_ARRAY:
701			return $this->convertToNormalizedArray($raw);
702			case Result::RESULTS_RAW:
703			return $raw;
704			case Result::RESULTS_RAW_ITERATOR:
705			return new RawIterator($raw, $this, $scrollConfig);
706			default:
707			throw new \Exception('Wrong results type selected');
708			}
709			}
710
711			/**
712			* Normalizes response array.
713			*
714			* @param array $data
715			*
716			* @return array
717			*/
718			private function convertToNormalizedArray($data)
719			{
720			if (array_key_exists('_source', $data)) {
721			return $data['_source'];
722			}
723
724			$output = [];
725
726			if (isset($data['hits']['hits'][0]['_source'])) {
727			foreach ($data['hits']['hits'] as $item) {
728			$output[] = $item['_source'];
729			}
730			} elseif (isset($data['hits']['hits'][0]['fields'])) {
731			foreach ($data['hits']['hits'] as $item) {
732			$output[] = array_map('reset', $item['fields']);
733			}
734			}
735
736			return $output;
737			}
738
739			/**
740			* Fetches next set of results.
741			*
742			* @param string $scrollId
743			* @param string $scrollDuration
744			* @param string $resultsType
745			*
746			* @return AbstractResultsIterator
747			*
748			* @throws \Exception
749			*/
750			public function scroll(
751			$scrollId,
752			$scrollDuration = '5m',
753			$resultsType = Result::RESULTS_OBJECT
754			) {
755			$results = $this->getClient()->scroll(['scroll_id' => $scrollId, 'scroll' => $scrollDuration]);
756
757			return $this->parseResult($results, $resultsType, $scrollDuration);
			0 ignored issues – show Documentation introduced 2015-12-29 10:45 UTC by Report Bug Copy Issue Report `$results` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
758			}
759
760			/**
761			* Clears scroll.
762			*
763			* @param string $scrollId
764			*/
765			public function clearScroll($scrollId)
766			{
767			$this->getClient()->clearScroll(['scroll_id' => $scrollId]);
768			}
769
770			/**
771			* Resolves type name by class name.
772			*
773			* @param string $className
774			*
775			* @return string
776			*/
777			private function resolveTypeName($className)
778			{
779			if (strpos($className, ':') !== false \|\| strpos($className, '\\') !== false) {
780			return $this->getMetadataCollector()->getDocumentType($className);
781			}
782
783			return $className;
784			}
785			}
786

ongr-io / ElasticsearchBundle

Pull Request — master (#589)

Manager::setReadOnly() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like