diff --git a/composer.json b/composer.json index eae2c469e..d6f44f717 100644 --- a/composer.json +++ b/composer.json @@ -1,53 +1,47 @@ { - "name": "influxdb/influxdb-php", - "description": "InfluxDB client library for PHP", - "keywords": [ - "influxdb", - "client", - "time series", - "influxdb client", - "influxdb class", - "influxdb library" - ], - "minimum-stability": "dev", - "authors": [ - { - "name": "Stephen Hoogendijk", - "email": "stephen@tca0.nl" - }, - { - "name": "Daniel Martinez", - "email": "danimartcas@hotmail.com" - } - ], - "require": { - "php": ">=5.3", - "guzzlehttp/guzzle": "3.*", - "symfony/event-dispatcher": "2.*" - - }, - "require-dev": { - "codeclimate/php-test-reporter": "0.*", - "symfony/config": "~2.8", - "symfony/console": "~2.8", - "symfony/filesystem": "~2.8", - "symfony/stopwatch": "~2.8", - "symfony/yaml": "~2.8" - }, - "scripts": { - "post-install-cmd": [ + "name": "influxdb/influxdb-php", + "description": "InfluxDB client library for PHP", + "license": "MIT", + "keywords": [ + "influxdb", + "client", + "time series", + "influxdb client", + "influxdb class", + "influxdb library" ], - "post-update-cmd": [ - ] - }, - "autoload": { - "psr-4": { - "InfluxDB\\": "src/InfluxDB" + "minimum-stability": "dev", + "authors": [ + { + "name": "Stephen Hoogendijk", + "email": "stephen@tca0.nl" + }, + { + "name": "Daniel Martinez", + "email": "danimartcas@hotmail.com" + } + ], + "require": { + "php": ">=5.3", + "guzzlehttp/guzzle": "3.*", + "symfony/event-dispatcher": "2.*" + }, + "require-dev": { + "codeclimate/php-test-reporter": "0.*", + "symfony/config": "~2.8", + "symfony/console": "~2.8", + "symfony/filesystem": "~2.8", + "symfony/stopwatch": "~2.8", + "symfony/yaml": "~2.8" + }, + "autoload": { + "psr-4": { + "InfluxDB\\": "src/InfluxDB" + } + }, + "autoload-dev": { + "psr-4": { + "InfluxDB\\Test\\": "tests" + } } - }, - "autoload-dev": { - "psr-4": { - "InfluxDB\\Test\\": "tests" - } - } } diff --git a/src/InfluxDB/Client.php b/src/InfluxDB/Client.php index 947622984..0f76df243 100644 --- a/src/InfluxDB/Client.php +++ b/src/InfluxDB/Client.php @@ -1,17 +1,14 @@ host = $host; + ) { + $this->host = (string) $host; $this->port = (int) $port; - $this->username = $username; - $this->password = $password; - $this->timeout = $timeout; + $this->username = (string) $username; + $this->password = (string) $password; + $this->timeout = (int) $timeout; $this->verifySSL = (bool) $verifySSL; if ($ssl) { $this->scheme = 'https'; - $this->options += array( - 'verify' => $verifySSL - ); + $this->options += array('verify' => $verifySSL); } // the the base URI $this->baseURI = sprintf('%s://%s:%d', $this->scheme, $this->host, $this->port); $this->httpClient = new \Guzzle\Http\Client($this->getBaseURI()); - } /** * For testing - * @param \Guzzle\Http\Client $client + * + * @param \Guzzle\Http\Client $client * @return $this */ public function setHttpClient(\Guzzle\Http\Client $client) @@ -132,8 +125,7 @@ class Client /** * Use the given database * - * @param string $name - * + * @param string $name * @return Database */ public function selectDB($name) @@ -144,21 +136,19 @@ class Client /** * Query influxDB * - * @param string $database - * @param string $query - * @param array $params - * + * @param string $database + * @param string $query + * @param array $params * @return ResultSet * @throws Exception */ public function query($database, $query, $params = array()) { - if ($database) { $params['db'] = $database; } - $params = '?'.http_build_query(array_merge(array('q' => $query), $params)); + $params = '?' . http_build_query(array_merge(array('q' => $query), $params)); $options = array_merge($this->options, array('exceptions' => false, 'timeout' => $this->getTimeout())); @@ -168,7 +158,6 @@ class Client $raw = (string) $response->send()->getBody(); return new ResultSet($raw); - } catch (\Exception $e) { throw new Exception(sprintf('Query has failed, exception: %s', $e->getMessage())); } @@ -177,28 +166,27 @@ class Client /** * Write points to the database * - * @param string $database - * @param string $data - * @param string $precision The timestamp precision - * + * @param string $database + * @param string $data + * @param string $precision The timestamp precision * @return bool + * @throws Exception * * @internal Internal method, do not use directly - * @throws Exception */ public function write($database, $data, $precision) { try { - - $result = $this->httpClient->post($this->getBaseURI() - . '/write?db=' . $database - . '&precision=' . $precision - , null, $data, + $result = $this->httpClient->post( + $this->getBaseURI() . + '/write?db=' . $database . + '&precision=' . $precision, + null, + $data, array('timeout' => $this->getTimeout()) )->send(); - return $result->getStatusCode() == 204; - + return $result->getStatusCode() === 204; } catch (\Exception $e) { throw new Exception(sprintf('Writing has failed, exception: %s', $e->getMessage())); } @@ -218,7 +206,6 @@ class Client * List all the users * * @return array - * * @throws Exception */ public function listUsers() @@ -230,16 +217,12 @@ class Client /** * Build the client from a dsn - * * Example: https+influxdb://username:pass@localhost:8086/databasename', timeout=5 * - * @param string $dsn - * - * @param int $timeout - * @param bool $verifySSL - * + * @param string $dsn + * @param int $timeout + * @param bool $verifySSL * @return Client|Database - * * @throws ClientException */ public static function fromDSN($dsn, $timeout = 0, $verifySSL = false) @@ -259,8 +242,8 @@ class Client throw new ClientException(sprintf('%s is not a valid scheme', $scheme)); } - $ssl = ($modifier && $modifier == 'https' ? true : false); - $dbName = ($connParams['path'] ? substr($connParams['path'], 1) : null); + $ssl = $modifier === 'https' ? true : false; + $dbName = $connParams['path'] ? substr($connParams['path'], 1) : null; $client = new self( $connParams['host'], @@ -274,6 +257,7 @@ class Client return ($dbName ? $client->selectDB($dbName) : $client); } + /** * @return mixed */ @@ -291,8 +275,7 @@ class Client } /** - * @param array $points - * + * @param array $points * @return array */ protected function pointsToArray(array $points) @@ -305,4 +288,4 @@ class Client return $names; } -} \ No newline at end of file +} diff --git a/src/InfluxDB/Client/Exception.php b/src/InfluxDB/Client/Exception.php index 1b446a2ac..0674e8686 100644 --- a/src/InfluxDB/Client/Exception.php +++ b/src/InfluxDB/Client/Exception.php @@ -9,5 +9,4 @@ namespace InfluxDB\Client; */ class Exception extends \InfluxDB\Exception { - -} \ No newline at end of file +} diff --git a/src/InfluxDB/Database.php b/src/InfluxDB/Database.php index f5d58d78a..922155672 100644 --- a/src/InfluxDB/Database.php +++ b/src/InfluxDB/Database.php @@ -1,13 +1,10 @@ client = $client; - - if (!$name) { + if (empty($name)) { throw new \InvalidArgumentException('No database name provided'); } - $this->name = $name; - + $this->name = (string) $name; + $this->client = $client; } /** - * @return string db name + * @return string */ public function getName() { @@ -73,11 +65,9 @@ class Database /** * Query influxDB * - * @param string $query - * @param array $params - * + * @param string $query + * @param array $params * @return ResultSet - * * @throws Exception */ public function query($query, $params = array()) @@ -88,10 +78,8 @@ class Database /** * Create this database * - * @param RetentionPolicy $retentionPolicy - * + * @param RetentionPolicy $retentionPolicy * @return ResultSet - * * @throws DatabaseException * @throws Exception */ @@ -103,7 +91,6 @@ class Database if ($retentionPolicy) { $this->createRetentionPolicy($retentionPolicy); } - } catch (\Exception $e) { throw new DatabaseException( sprintf('Failed to created database %s, exception: %s', $this->name, $e->getMessage()) @@ -112,8 +99,7 @@ class Database } /** - * @param RetentionPolicy $retentionPolicy - * + * @param RetentionPolicy $retentionPolicy * @return ResultSet */ public function createRetentionPolicy(RetentionPolicy $retentionPolicy) @@ -124,24 +110,19 @@ class Database /** * Writes points into InfluxDB * - * @param Point[] $points Array of points - * @param string $precision The timestamp precision (defaults to nanoseconds) - * + * @param Point[] $points Array of points + * @param string $precision The timestamp precision (defaults to nanoseconds) * @return bool * @throws Exception */ public function writePoints(array $points, $precision = self::PRECISION_NANOSECONDS) { - $payload = array(); - - foreach ($points as $point) { - - if (!$point instanceof Point) { - throw new \InvalidArgumentException('An array of Point[] should be passed'); - } - - $payload[] = (string) $point; - } + $payload = array_map( + function (Point $point) { + return (string) $point; + }, + $points + ); return $this->client->write($this->name, implode(PHP_EOL, $payload), $precision); } @@ -166,7 +147,6 @@ class Database /** * @return array - * * @throws Exception */ public function listRetentionPolicies() @@ -174,7 +154,6 @@ class Database return $this->query(sprintf('SHOW RETENTION POLICIES %s', $this->name))->getPoints(); } - /** * Drop this database */ @@ -202,14 +181,12 @@ class Database } /** - * @param $method - * @param RetentionPolicy $retentionPolicy - * + * @param string $method + * @param RetentionPolicy $retentionPolicy * @return string */ protected function getRetentionPolicyQuery($method, RetentionPolicy $retentionPolicy) { - if (!in_array($method, array('CREATE', 'ALTER'))) { throw new \InvalidArgumentException(sprintf('%s is not a valid method')); } @@ -229,5 +206,4 @@ class Database return $query; } - -} \ No newline at end of file +} diff --git a/src/InfluxDB/Database/Exception.php b/src/InfluxDB/Database/Exception.php index fa17ab7aa..f5142b49e 100644 --- a/src/InfluxDB/Database/Exception.php +++ b/src/InfluxDB/Database/Exception.php @@ -1,12 +1,10 @@ name = $name; + $this->name = (string) $name; $this->duration = $duration; - $this->replication = $replication; - + $this->replication = (int) $replication; $this->default = (bool) $default; } -} \ No newline at end of file +} diff --git a/src/InfluxDB/Exception.php b/src/InfluxDB/Exception.php index fbf6cb5cb..868dd74c4 100644 --- a/src/InfluxDB/Exception.php +++ b/src/InfluxDB/Exception.php @@ -1,12 +1,10 @@ tags = $tags; $this->fields = $additionalFields; - $this->fields += array('value' => (float) $value); + $this->fields['value'] = (float) $value; if ($timestamp && !$this->isValidTimeStamp($timestamp)) { throw new DatabaseException(sprintf('%s is not a valid timestamp', $timestamp)); @@ -72,7 +81,7 @@ class Point $string .= ',' . $this->arrayToString($this->tags); } - $string .= ' ' .$this->arrayToString($this->fields); + $string .= ' ' . $this->arrayToString($this->fields); if ($this->timestamp) { $string .= ' '.$this->timestamp; @@ -81,26 +90,35 @@ class Point return $string; } + /** + * @param array $arr + * @return string + */ private function arrayToString(array $arr) { $strParts = array(); foreach ($arr as $key => $value) { - $strParts[] = "{$key}={$value}"; + $strParts[] = sprintf('%s=%s', $key, $value); } - return implode(",", $strParts); + return implode(',', $strParts); } /** - * @param $timestamp - * + * @param int $timestamp * @return bool */ private function isValidTimeStamp($timestamp) { - return ((int) $timestamp === $timestamp) - && ($timestamp <= PHP_INT_MAX) - && ($timestamp >= ~PHP_INT_MAX); + if ((int) $timestamp === $timestamp) { + return true; + } + + if ($timestamp <= PHP_INT_MAX && $timestamp >= ~PHP_INT_MAX) { + return true; + } + + return false; } -} \ No newline at end of file +} diff --git a/src/InfluxDB/Query/Builder.php b/src/InfluxDB/Query/Builder.php index 1709025f5..1060bc39d 100644 --- a/src/InfluxDB/Query/Builder.php +++ b/src/InfluxDB/Query/Builder.php @@ -1,7 +1,4 @@ - */ namespace InfluxDB\Query; @@ -24,16 +21,43 @@ use InfluxDB\ResultSet; * @todo add merge * * @package InfluxDB\Query + * @author Stephen "TheCodeAssassin" Hoogendijk */ class Builder { + /** + * @var Database + */ + protected $db; - protected $db = null; + /** + * @var string + */ protected $selection = '*'; + + /** + * @var string[] + */ protected $where = array(); - protected $startTime = null; - protected $endTime = null; - protected $metric = null; + + /** + * @var string + */ + protected $startTime; + + /** + * @var string + */ + protected $endTime; + + /** + * @var string + */ + protected $metric; + + /** + * @var string + */ protected $limitClause = ''; /** @@ -45,8 +69,7 @@ class Builder } /** - * @param string $metric The metric to select (required) - * + * @param string $metric The metric to select (required) * @return $this */ public function from($metric) @@ -63,8 +86,7 @@ class Builder * * $series->select('sum(value)', * - * @param string $customSelect - * + * @param string $customSelect * @return $this */ public function select($customSelect) @@ -83,7 +105,6 @@ class Builder */ public function where(array $conditions) { - foreach ($conditions as $condition) { $this->where[] = $condition; } @@ -92,8 +113,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function count($field = 'type') @@ -104,8 +124,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function median($field = 'type') @@ -116,8 +135,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function mean($field = 'type') @@ -128,8 +146,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function sum($field = 'type') @@ -140,8 +157,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function first($field = 'type') @@ -152,8 +168,7 @@ class Builder } /** - * @param string $field - * + * @param string $field * @return $this */ public function last($field = 'type') @@ -166,15 +181,14 @@ class Builder /** * Set's the time range to select data from * - * @param int $from Unix timestamp from - * @param int $to Unix timestamp to - * + * @param int $from + * @param int $to * @return $this */ public function setTimeRange($from, $to) { - $fromDate = date('Y-m-d H:i:s', $from); - $toDate = date('Y-m-d H:i:s', $to); + $fromDate = date('Y-m-d H:i:s', (int) $from); + $toDate = date('Y-m-d H:i:s', (int) $to); $this->where(array("time > '$fromDate'", "time < '$toDate'")); @@ -207,7 +221,6 @@ class Builder return $this; } - /** * @return string */ @@ -233,12 +246,13 @@ class Builder { $query = sprintf("SELECT %s FROM %s", $this->selection, $this->metric); - if (!$this->metric) { + if (! $this->metric) { throw new \InvalidArgumentException('No metric provided to from()'); } - for ($i=0; $i < count($this->where); $i++) { + for ($i = 0; $i < count($this->where); $i++) { $selection = 'WHERE'; + if ($i > 0) { $selection = 'AND'; } @@ -254,4 +268,4 @@ class Builder return $query; } -} \ No newline at end of file +} diff --git a/src/InfluxDB/Query/Exception.php b/src/InfluxDB/Query/Exception.php index 4571efb74..448a41e97 100644 --- a/src/InfluxDB/Query/Exception.php +++ b/src/InfluxDB/Query/Exception.php @@ -1,12 +1,10 @@ raw = $raw; - - $this->parsedResults = json_decode($raw, true); + $this->parsedResults = json_decode((string) $raw, true); if (json_last_error() !== JSON_ERROR_NONE) { - throw new \InvalidArgumentException("Invalid JSON"); + throw new \InvalidArgumentException('Invalid JSON'); } // There was an error in the query thrown by influxdb if (isset($this->parsedResults['error'])) { throw new ClientException($this->parsedResults['error']); + } - // Check if there are errors in the first serie - } elseif (isset($this->parsedResults['results'][0]['error'])) { + // Check if there are errors in the first serie + if (isset($this->parsedResults['results'][0]['error'])) { throw new ClientException($this->parsedResults['results'][0]['error']); } } /** - * @param $metricName - * @param array $tags - * + * @param $metricName + * @param array $tags * @return array $points */ public function getPoints($metricName = '', array $tags = array()) @@ -62,7 +52,6 @@ class ResultSet $series = $this->getSeries(); foreach ($series as $serie) { - if ((empty($metricName) && empty($tags) || $serie['name'] == $metricName || (isset($serie['tags']) && array_intersect($tags, $serie['tags']))) @@ -82,30 +71,26 @@ class ResultSet * each containing the keys for a series * * @throws Exception - * * @return array $series */ public function getSeries() { - $pickSeries = function ($object) { + $series = array_map( + function ($object) { + if (isset($object['error'])) { + throw new ClientException($object['error']); + } - if (isset($object['error'])) { - throw new ClientException($object['error']); - } - - return (isset($object['series']) ? $object['series'] : array()); - }; - - // we use array_shift because of compatibility with php5.3 - // Foreach object, pick series key - $map = array_map($pickSeries, $this->parsedResults['results']); - return array_shift( - $map + return isset($object['series']) ? $object['series'] : array(); + }, + $this->parsedResults['results'] ); + + return array_shift($series); } /** - * @param array $serie + * @param array $serie * @return array */ private function getPointsFromSerie(array $serie) @@ -113,13 +98,9 @@ class ResultSet $points = array(); foreach ($serie['values'] as $point) { - $points[] = array_combine( - $serie['columns'], - $point - ); + $points[] = array_combine($serie['columns'], $point); } return $points; } - -} \ No newline at end of file +}