PhpOffice\PhpSpreadsheet\Worksheet\Column Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\Column:

Public Member Functions
	__construct (?Worksheet $parent=null, $columnIndex='A')
	Create a new column. More...
	__destruct ()
	Destructor. More...
	getColumnIndex ()
	Get column index as string eg: 'A'. More...
	getCellIterator ($startRow=1, $endRow=null)
	Get cell iterator. More...

Private Attributes
	$parent
	$columnIndex

Detailed Description

Definition at line 5 of file Column.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\Column::__construct	(	?Worksheet	$parent = null,
			$columnIndex = 'A'
	)

Create a new column.

Parameters

Worksheet	$parent
string	$columnIndex

Definition at line 27 of file Column.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Column\$columnIndex, and PhpOffice\PhpSpreadsheet\Worksheet\Column\$parent.

    {
        // Set parent and column index
        $this->parent = $parent;
        $this->columnIndex = $columnIndex;
    }

__destruct()

PhpOffice\PhpSpreadsheet\Worksheet\Column::__destruct

(

)

Destructor.

Definition at line 37 of file Column.php.

    {
        // @phpstan-ignore-next-line
        $this->parent = null;
    }

Member Function Documentation

getCellIterator()

PhpOffice\PhpSpreadsheet\Worksheet\Column::getCellIterator	(		$startRow = 1,
			$endRow = null
	)

Get cell iterator.

Parameters

int	$startRow	The row number at which to start iterating
int	$endRow	Optionally, the row number at which to stop iterating

Returns

ColumnCellIterator

Definition at line 59 of file Column.php.

    {
        return new ColumnCellIterator($this->parent, $this->columnIndex, $startRow, $endRow);
    }

getColumnIndex()

PhpOffice\PhpSpreadsheet\Worksheet\Column::getColumnIndex

(

)

Get column index as string eg: 'A'.

Definition at line 46 of file Column.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Column\$columnIndex.

                                    : string
    {
        return $this->columnIndex;
    }

Field Documentation

$columnIndex

PhpOffice\PhpSpreadsheet\Worksheet\Column::$columnIndex

private

Definition at line 19 of file Column.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Column\__construct(), and PhpOffice\PhpSpreadsheet\Worksheet\Column\getColumnIndex().

$parent

PhpOffice\PhpSpreadsheet\Worksheet\Column::$parent

private

Definition at line 12 of file Column.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Column\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/Column.php