init

lib/PhpSpreadsheet/Worksheet/RowDimension.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Worksheet;
+
+use PhpOffice\PhpSpreadsheet\Helper\Dimension as CssDimension;
+
+class RowDimension extends Dimension
+{
+    /**
+     * Row index.
+     */
+    private ?int $rowIndex;
+
+    /**
+     * Row height (in pt).
+     *
+     * When this is set to a negative value, the row height should be ignored by IWriter
+     */
+    private float $height = -1;
+
+    /**
+     * ZeroHeight for Row?
+     */
+    private bool $zeroHeight = false;
+
+    /**
+     * Create a new RowDimension.
+     *
+     * @param ?int $index Numeric row index
+     */
+    public function __construct(?int $index = 0)
+    {
+        // Initialise values
+        $this->rowIndex = $index;
+
+        // set dimension as unformatted by default
+        parent::__construct(null);
+    }
+
+    /**
+     * Get Row Index.
+     */
+    public function getRowIndex(): ?int
+    {
+        return $this->rowIndex;
+    }
+
+    /**
+     * Set Row Index.
+     *
+     * @return $this
+     */
+    public function setRowIndex(int $index): static
+    {
+        $this->rowIndex = $index;
+
+        return $this;
+    }
+
+    /**
+     * Get Row Height.
+     * By default, this will be in points; but this method also accepts an optional unit of measure
+     *    argument, and will convert the value from points to the specified UoM.
+     *    A value of -1 tells Excel to display this column in its default height.
+     */
+    public function getRowHeight(?string $unitOfMeasure = null): float
+    {
+        return ($unitOfMeasure === null || $this->height < 0)
+            ? $this->height
+            : (new CssDimension($this->height . CssDimension::UOM_POINTS))->toUnit($unitOfMeasure);
+    }
+
+    /**
+     * Set Row Height.
+     *
+     * @param float $height in points. A value of -1 tells Excel to display this column in its default height.
+     * By default, this will be the passed argument value; but this method also accepts an optional unit of measure
+     *    argument, and will convert the passed argument value to points from the specified UoM
+     *
+     * @return $this
+     */
+    public function setRowHeight(float $height, ?string $unitOfMeasure = null): static
+    {
+        $this->height = ($unitOfMeasure === null || $height < 0)
+            ? $height
+            : (new CssDimension("{$height}{$unitOfMeasure}"))->height();
+
+        return $this;
+    }
+
+    /**
+     * Get ZeroHeight.
+     */
+    public function getZeroHeight(): bool
+    {
+        return $this->zeroHeight;
+    }
+
+    /**
+     * Set ZeroHeight.
+     *
+     * @return $this
+     */
+    public function setZeroHeight(bool $zeroHeight): static
+    {
+        $this->zeroHeight = $zeroHeight;
+
+        return $this;
+    }
+}