# tablepress/3.4/libraries/vendor/PhpSpreadsheet/Worksheet/ColumnIterator.php

TablePress – Tables in WordPress made easy, version 3.4. 166 lines.

- Page: https://pluginprobe.com/plugins/tablepress/3.4/code/libraries/vendor/PhpSpreadsheet/Worksheet/ColumnIterator.php
- Raw: https://pluginprobe.com/plugins/tablepress/3.4/raw/libraries/vendor/PhpSpreadsheet/Worksheet/ColumnIterator.php
- Modified: 2025-01-08T09:25:54+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/tablepress/3.4/code/libraries/vendor/PhpSpreadsheet/Worksheet/ColumnIterator.php#L10-L20`.

```php
<?php

namespace TablePress\PhpOffice\PhpSpreadsheet\Worksheet;

use Iterator as NativeIterator;
use TablePress\PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use TablePress\PhpOffice\PhpSpreadsheet\Exception;
use TablePress\PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;

/**
 * @implements NativeIterator<string, Column>
 */
class ColumnIterator implements NativeIterator
{
	/**
	 * Worksheet to iterate.
	 */
	private Worksheet $worksheet;

	/**
	 * Current iterator position.
	 */
	private int $currentColumnIndex = 1;

	/**
	 * Start position.
	 */
	private int $startColumnIndex = 1;

	/**
	 * End position.
	 */
	private int $endColumnIndex = 1;

	/**
	 * Create a new column iterator.
	 *
	 * @param Worksheet $worksheet The worksheet to iterate over
	 * @param string $startColumn The column address at which to start iterating
	 * @param ?string $endColumn Optionally, the column address at which to stop iterating
	 */
	public function __construct(Worksheet $worksheet, string $startColumn = 'A', ?string $endColumn = null)
	{
		// Set subject
		$this->worksheet = $worksheet;
		$this->resetEnd($endColumn);
		$this->resetStart($startColumn);
	}

	/**
	 * Destructor.
	 */
	public function __destruct()
	{
		unset($this->worksheet);
	}

	/**
	 * (Re)Set the start column and the current column pointer.
	 *
	 * @param string $startColumn The column address at which to start iterating
	 *
	 * @return $this
	 */
	public function resetStart(string $startColumn = 'A')
	{
		$startColumnIndex = Coordinate::columnIndexFromString($startColumn);
		if ($startColumnIndex > Coordinate::columnIndexFromString($this->worksheet->getHighestColumn())) {
			throw new Exception(
				"Start column ({$startColumn}) is beyond highest column ({$this->worksheet->getHighestColumn()})"
			);
		}

		$this->startColumnIndex = $startColumnIndex;
		if ($this->endColumnIndex < $this->startColumnIndex) {
			$this->endColumnIndex = $this->startColumnIndex;
		}
		$this->seek($startColumn);

		return $this;
	}

	/**
	 * (Re)Set the end column.
	 *
	 * @param ?string $endColumn The column address at which to stop iterating
	 *
	 * @return $this
	 */
	public function resetEnd(?string $endColumn = null)
	{
		$endColumn = $endColumn ?: $this->worksheet->getHighestColumn();
		$this->endColumnIndex = Coordinate::columnIndexFromString($endColumn);

		return $this;
	}

	/**
	 * Set the column pointer to the selected column.
	 *
	 * @param string $column The column address to set the current pointer at
	 *
	 * @return $this
	 */
	public function seek(string $column = 'A')
	{
		$column = Coordinate::columnIndexFromString($column);
		if (($column < $this->startColumnIndex) || ($column > $this->endColumnIndex)) {
			throw new PhpSpreadsheetException(
				"Column $column is out of range ({$this->startColumnIndex} - {$this->endColumnIndex})"
			);
		}
		$this->currentColumnIndex = $column;

		return $this;
	}

	/**
	 * Rewind the iterator to the starting column.
	 */
	public function rewind(): void
	{
		$this->currentColumnIndex = $this->startColumnIndex;
	}

	/**
	 * Return the current column in this worksheet.
	 */
	public function current(): Column
	{
		return new Column($this->worksheet, Coordinate::stringFromColumnIndex($this->currentColumnIndex));
	}

	/**
	 * Return the current iterator key.
	 */
	public function key(): string
	{
		return Coordinate::stringFromColumnIndex($this->currentColumnIndex);
	}

	/**
	 * Set the iterator to its next value.
	 */
	public function next(): void
	{
		++$this->currentColumnIndex;
	}

	/**
	 * Set the iterator to its previous value.
	 */
	public function prev(): void
	{
		--$this->currentColumnIndex;
	}

	/**
	 * Indicate if more columns exist in the worksheet range of columns that we're iterating.
	 */
	public function valid(): bool
	{
		return $this->currentColumnIndex <= $this->endColumnIndex && $this->currentColumnIndex >= $this->startColumnIndex;
	}
}

```