version 1.5

2024-01-11 14:04:25 +01:00
parent 0ee8291846
commit 4492763b78
756 changed files with 209957 additions and 2 deletions
@@ -0,0 +1,265 @@
+<?php
+
+namespace InfluxDB2;
+
+use DateTimeInterface;
+use InfluxDB2\Model\WritePrecision;
+
+class Point
+{
+    public const DEFAULT_WRITE_PRECISION = WritePrecision::NS;
+
+    /** @var string */
+    private $name;
+    /** @var array */
+    private $tags;
+    /** @var array */
+    private $fields;
+    /** @var int */
+    private $time;
+    /** @var WritePrecision */
+    private $precision;
+
+    /** Create DataPoint instance for specified measurement name.
+     *
+     * @param [String] name the measurement name for the point.
+     * @param [Array] tags the tag set for the point
+     * @param [Array] fields the fields for the point
+     * @param [Integer] time the timestamp for the point
+     * @param [WritePrecision] precision the precision for the unix timestamps within the body line-protocol
+     */
+    public function __construct(
+        $name,
+        $tags = null,
+        $fields =  null,
+        $time = null,
+        $precision = Point::DEFAULT_WRITE_PRECISION
+    ) {
+        $this->name = $name;
+        $this->tags = $tags;
+        $this->fields = $fields;
+        $this->time = $time;
+        $this->precision = $precision;
+    }
+
+    /**
+     * @return WritePrecision
+     */
+    public function getPrecision(): ?string
+    {
+        return $this->precision;
+    }
+
+    public static function measurement($name): Point
+    {
+        return new Point($name);
+    }
+
+    /** Create DataPoint instance from specified data.
+     *
+     * @param [Array] data
+     * @return Point
+     */
+    public static function fromArray($data): ?Point
+    {
+        if (!array_key_exists('name', $data)) {
+            return null;
+        }
+
+        $tags = array_key_exists('tags', $data) ? $data['tags'] : null;
+        $fields = array_key_exists('fields', $data) ? $data['fields'] : null;
+        $time = array_key_exists('time', $data) ? $data['time'] : null;
+        $precision = array_key_exists('precision', $data) ? $data['precision'] : null;
+
+        return new Point($data['name'], $tags, $fields, $time, $precision);
+    }
+
+    /** Adds or replaces a tag value for a point.
+     *
+     * @param [Object] key the tag name
+     * @param [Object] value the tag value
+     * @return Point
+     */
+    public function addTag($key, $value): Point
+    {
+        $this->tags[$key] = $value;
+
+        return $this;
+    }
+
+    /** Adds or replaces a field value for a point.
+     *
+     * @param [Object] key the tag name
+     * @param [Object] value the tag value
+     * @return Point
+     */
+    public function addField($key, $value): Point
+    {
+        $this->fields[$key] = $value;
+
+        return $this;
+    }
+
+    /** Updates the timestamp for the point.
+     *
+     * @param [Object] time the timestamp
+     * @param [WritePrecision] precision the timestamp precision
+     * @return Point
+     */
+    public function time($time, $precision = null): Point
+    {
+        $this->time = $time;
+        $this->precision = $precision;
+
+        return $this;
+    }
+
+    /** If there is no field then return null.
+     *
+     * @return string representation of the point
+     */
+    public function toLineProtocol()
+    {
+        $measurement = $this->escapeKey($this->name, false);
+
+        $lineProtocol = $measurement;
+
+        $tags = $this->appendTags();
+
+        if (!$this->isNullOrEmptyString($tags)) {
+            $lineProtocol .= $tags;
+        } else {
+            $lineProtocol .= ' ';
+        }
+
+        $fields = $this->appendFields();
+
+        if ($this->isNullOrEmptyString($fields)) {
+            return null;
+        }
+
+        $lineProtocol .= $fields;
+
+        $time = $this->appendTime();
+
+        if (!$this->isNullOrEmptyString($time)) {
+            $lineProtocol .= $time;
+        }
+
+        return $lineProtocol;
+    }
+
+    private function appendTags()
+    {
+        $tags = '';
+
+        if ($this->tags == null) {
+            return null;
+        }
+
+        ksort($this->tags);
+
+        foreach (array_keys($this->tags) as $key) {
+            $value = $this->tags[$key];
+
+            if ($this->isNullOrEmptyString($key) || $this->isNullOrEmptyString($value)) {
+                continue;
+            }
+
+            $tags .= ',' . $this->escapeKey($key) . '=' . $this->escapeKey($value);
+        }
+
+        $tags .= ' ';
+        return $tags;
+    }
+
+    private function appendFields()
+    {
+        $fields = '';
+
+        if ($this->fields == null) {
+            return null;
+        }
+
+        ksort($this->fields);
+
+        foreach (array_keys($this->fields) as $key) {
+            $value = $this->fields[$key];
+
+            if (!isset($value)) {
+                continue;
+            }
+
+            $fields .= $this->escapeKey($key) . '=';
+
+            if (is_integer($value) || is_long($value)) {
+                $fields .= $value . 'i';
+            } elseif (is_string($value)) {
+                $fields .= '"' . $this->escapeValue($value) . '"';
+            } elseif (is_bool($value)) {
+                $fields .= $value ? 'true' : 'false';
+            } else {
+                $fields .= $value;
+            }
+
+            $fields .= ',';
+        }
+
+        return rtrim($fields, ',');
+    }
+
+    private function appendTime()
+    {
+        if (!isset($this->time)) {
+            return null;
+        }
+
+        $time = $this->time;
+
+        if (is_double($time) || is_float($time)) {
+            $time = round($time);
+        } elseif ($time instanceof DateTimeInterface) {
+            $seconds = $time->getTimestamp();
+
+            switch ($this->precision) {
+                case WritePrecision::MS:
+                    $time = strval(round($seconds) . '000');
+                    break;
+                case WritePrecision::S:
+                    $time = strval($seconds);
+                    break;
+                case WritePrecision::US:
+                    $time = strval(round($seconds) . '000000');
+                    break;
+                default:
+                    $time = strval(round($seconds) . '000000000');
+                    break;
+            }
+        }
+
+        return ' ' . $time;
+    }
+
+    private function escapeKey($key, $escapeEqual = true)
+    {
+        $escapeKeys = array(' ' => '\\ ', ',' => '\\,', "\\" => '\\\\',
+            "\n" => '\\n', "\r" => '\\r', "\t" => '\\t');
+
+        if ($escapeEqual) {
+            $escapeKeys['='] = '\\=';
+        }
+
+        return strtr($key, $escapeKeys);
+    }
+
+    private function escapeValue($value)
+    {
+        $escapeValues = array('"' => '\\"', "\\" => '\\\\');
+        return strtr($value, $escapeValues);
+    }
+
+    private function isNullOrEmptyString($str)
+    {
+        return (!is_string($str) || trim($str) === '');
+    }
+}