diff options
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/Index/Settings.php')
| -rw-r--r-- | vendor/ruflin/elastica/lib/Elastica/Index/Settings.php | 188 |
1 files changed, 118 insertions, 70 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/Index/Settings.php b/vendor/ruflin/elastica/lib/Elastica/Index/Settings.php index 2f2b90c6..f97e360a 100644 --- a/vendor/ruflin/elastica/lib/Elastica/Index/Settings.php +++ b/vendor/ruflin/elastica/lib/Elastica/Index/Settings.php @@ -1,41 +1,41 @@ <?php - namespace Elastica\Index; +use Elastica\Exception\NotFoundException; +use Elastica\Exception\ResponseException; use Elastica\Index as BaseIndex; use Elastica\Request; /** - * Elastica index settings object + * Elastica index settings object. * - * All settings listed in the update settings API (http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings.html) - * can be changed on a running indices. To make changes like the merge policy (http://www.elasticsearch.org/guide/reference/index-modules/merge.html) + * All settings listed in the update settings API (http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html) + * can be changed on a running indices. To make changes like the merge policy (http://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html) * the index has to be closed first and reopened after the call * - * @category Xodoa - * @package Elastica * @author Nicolas Ruflin <spam@ruflin.com> - * @link http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings.html - * @link http://www.elasticsearch.org/guide/reference/index-modules/merge.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html */ class Settings { /** - * Response + * Response. * * @var \Elastica\Response Response object */ protected $_response = null; /** - * Stats info + * Stats info. * * @var array Stats info */ protected $_data = array(); /** - * Index + * Index. * * @var \Elastica\Index Index object */ @@ -44,7 +44,7 @@ class Settings const DEFAULT_REFRESH_INTERVAL = '1s'; /** - * Construct + * Construct. * * @param \Elastica\Index $index Index object */ @@ -54,53 +54,64 @@ class Settings } /** - * Returns the current settings of the index + * Returns the current settings of the index. * * If param is set, only specified setting is return. * 'index.' is added in front of $setting. * - * @param string $setting OPTIONAL Setting name to return + * @param string $setting OPTIONAL Setting name to return + * * @return array|string|null Settings data - * @link http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html */ public function get($setting = '') { $requestData = $this->request()->getData(); $data = reset($requestData); + + if (empty($data['settings']) || empty($data['settings']['index'])) { + // should not append, the request should throw a ResponseException + throw new NotFoundException('Index '.$this->getIndex()->getName().' not found'); + } $settings = $data['settings']['index']; - if (!empty($setting)) { - if (isset($settings[$setting])) { - return $settings[$setting]; - } else { - if (strpos($setting, '.') !== false) { - // translate old dot-notation settings to nested arrays - $keys = explode('.', $setting); - foreach ($keys as $key) { - if (isset($settings[$key])) { - $settings = $settings[$key]; - } else { - return null; - } + if (!$setting) { + // return all array + return $settings; + } + + if (isset($settings[$setting])) { + return $settings[$setting]; + } else { + if (strpos($setting, '.') !== false) { + // translate old dot-notation settings to nested arrays + $keys = explode('.', $setting); + foreach ($keys as $key) { + if (isset($settings[$key])) { + $settings = $settings[$key]; + } else { + return; } - return $settings; } - return null; + + return $settings; } - } - return $settings; + return; + } } /** - * Sets the number of replicas + * Sets the number of replicas. + * + * @param int $replicas Number of replicas * - * @param int $replicas Number of replicas * @return \Elastica\Response Response object */ public function setNumberOfReplicas($replicas) { - $replicas = (int)$replicas; + $replicas = (int) $replicas; $data = array('number_of_replicas' => $replicas); @@ -108,14 +119,25 @@ class Settings } /** - * Sets the index to read only + * Sets the index to read only. + * + * @param bool $readOnly (default = true) * - * @param bool $readOnly (default = true) * @return \Elastica\Response */ public function setReadOnly($readOnly = true) { - return $this->set(array('blocks.read_only' => $readOnly)); + return $this->set(array('blocks.write' => $readOnly)); + } + + /** + * getReadOnly. + * + * @return bool + */ + public function getReadOnly() + { + return $this->get('blocks.write') === 'true'; // ES returns a string for this setting } /** @@ -123,11 +145,12 @@ class Settings */ public function getBlocksRead() { - return (bool)$this->get('blocks.read'); + return (bool) $this->get('blocks.read'); } /** - * @param bool $state OPTIONAL (default = true) + * @param bool $state OPTIONAL (default = true) + * * @return \Elastica\Response */ public function setBlocksRead($state = true) @@ -142,18 +165,19 @@ class Settings */ public function getBlocksWrite() { - return (bool)$this->get('blocks.write'); + return (bool) $this->get('blocks.write'); } /** - * @param bool $state OPTIONAL (default = true) + * @param bool $state OPTIONAL (default = true) + * * @return \Elastica\Response */ public function setBlocksWrite($state = true) { $state = $state ? 1 : 0; - return $this->set(array('blocks.write' => (int)$state)); + return $this->set(array('blocks.write' => $state)); } /** @@ -161,27 +185,41 @@ class Settings */ public function getBlocksMetadata() { - return (bool)$this->get('blocks.metadata'); + // TODO will have to be replace by block.metadata.write once https://github.com/elasticsearch/elasticsearch/pull/9203 has been fixed + // the try/catch will have to be remove too + try { + return (bool) $this->get('blocks.metadata'); + } catch (ResponseException $e) { + if (strpos($e->getMessage(), 'ClusterBlockException') !== false) { + // hacky way to test if the metadata is blocked since bug 9203 is not fixed + return true; + } else { + throw $e; + } + } } /** - * @param bool $state OPTIONAL (default = true) + * @param bool $state OPTIONAL (default = true) + * * @return \Elastica\Response */ public function setBlocksMetadata($state = true) { + // TODO will have to be replace by block.metadata.write once https://github.com/elasticsearch/elasticsearch/pull/9203 has been fixed $state = $state ? 1 : 0; - return $this->set(array('blocks.metadata' => (int)$state)); + return $this->set(array('blocks.metadata' => $state)); } /** - * Sets the index refresh interval + * Sets the index refresh interval. * * Value can be for example 3s for 3 seconds or * 5m for 5 minutes. -1 refreshing is disabled. * - * @param int $interval Number of seconds + * @param int $interval Number of milliseconds + * * @return \Elastica\Response Response object */ public function setRefreshInterval($interval) @@ -190,7 +228,7 @@ class Settings } /** - * Returns the refresh interval + * Returns the refresh interval. * * If no interval is set, the default interval is returned * @@ -208,22 +246,23 @@ class Settings } /** - * Return merge policy + * Return merge policy. * * @return string Merge policy type */ public function getMergePolicyType() { - return $this->get('merge.policy.type'); } /** - * Sets merge policy + * Sets merge policy. + * + * @param string $type Merge policy type * - * @param string $type Merge policy type * @return \Elastica\Response Response object - * @link http://www.elasticsearch.org/guide/reference/index-modules/merge.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html */ public function setMergePolicyType($type) { @@ -235,30 +274,34 @@ class Settings } /** - * Sets the specific merge policies + * Sets the specific merge policies. * * To have this changes made the index has to be closed and reopened * - * @param string $key Merge policy key (for ex. expunge_deletes_allowed) - * @param string $value + * @param string $key Merge policy key (for ex. expunge_deletes_allowed) + * @param string $value + * * @return \Elastica\Response - * @link http://www.elasticsearch.org/guide/reference/index-modules/merge.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html */ public function setMergePolicy($key, $value) { $this->getIndex()->close(); - $response = $this->set(array('merge.policy.' . $key => $value)); + $response = $this->set(array('merge.policy.'.$key => $value)); $this->getIndex()->open(); return $response; } /** - * Returns the specific merge policy value + * Returns the specific merge policy value. + * + * @param string $key Merge policy key (for ex. expunge_deletes_allowed) * - * @param string $key Merge policy key (for ex. expunge_deletes_allowed) * @return string Refresh interval - * @link http://www.elasticsearch.org/guide/reference/index-modules/merge.html + * + * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html */ public function getMergePolicy($key) { @@ -266,13 +309,15 @@ class Settings if (isset($settings['merge']['policy'][$key])) { return $settings['merge']['policy'][$key]; } - return null; + + return; } /** - * Can be used to set/update settings + * Can be used to set/update settings. + * + * @param array $data Arguments * - * @param array $data Arguments * @return \Elastica\Response Response object */ public function set(array $data) @@ -281,7 +326,7 @@ class Settings } /** - * Returns the index object + * Returns the index object. * * @return \Elastica\Index Index object */ @@ -291,7 +336,7 @@ class Settings } /** - * Updates the given settings for the index + * Updates the given settings for the index. * * With elasticsearch 0.16 the following settings are supported * - index.term_index_interval @@ -303,15 +348,18 @@ class Settings * - index.merge.policy * - index.auto_expand_replicas * - * @param array $data OPTIONAL Data array - * @param string $method OPTIONAL Transfer method (default = \Elastica\Request::GET) + * @param array $data OPTIONAL Data array + * @param string $method OPTIONAL Transfer method (default = \Elastica\Request::GET) + * * @return \Elastica\Response Response object */ public function request(array $data = array(), $method = Request::GET) { $path = '_settings'; - $data = array('index' => $data); + if (!empty($data)) { + $data = array('index' => $data); + } return $this->getIndex()->request($path, $method, $data); } |