PHPExcel_Worksheet_ColumnIterator Class Reference

Inheritance diagram for PHPExcel_Worksheet_ColumnIterator:

Collaboration diagram for PHPExcel_Worksheet_ColumnIterator:

Public Member Functions
	__construct (PHPExcel_Worksheet $subject=null, $startColumn='A', $endColumn=null)
	Create a new column iterator. More...
	__destruct ()
	Destructor. More...
	resetStart ($startColumn='A')
	(Re)Set the start column and the current column pointer More...
	resetEnd ($endColumn=null)
	(Re)Set the end column More...
	seek ($column='A')
	Set the column pointer to the selected column. More...
	rewind ()
	Rewind the iterator to the starting column. More...
	current ()
	Return the current column in this worksheet. More...
	key ()
	Return the current iterator key. More...
	next ()
	Set the iterator to its next value. More...
	prev ()
	Set the iterator to its previous value. More...
	valid ()
	Indicate if more columns exist in the worksheet range of columns that we're iterating. More...

Private Attributes
	$_subject
	$_position = 0
	$_startColumn = 0
	$_endColumn = 0

Detailed Description

Definition at line 38 of file ColumnIterator.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Worksheet_ColumnIterator::__construct	(	PHPExcel_Worksheet	$subject = null,
			$startColumn = 'A',
			$endColumn = null
	)

Create a new column iterator.

Parameters

PHPExcel_Worksheet	$subject	The worksheet to iterate over
string	$startColumn	The column address at which to start iterating
string	$endColumn	Optionally, the column address at which to stop iterating

Definition at line 77 of file ColumnIterator.php.

References resetEnd(), and resetStart().

                                                                                                               {
                // Set subject
                $this->_subject = $subject;
                $this->resetEnd($endColumn);
                $this->resetStart($startColumn);
        }

Here is the call graph for this function:

__destruct()

PHPExcel_Worksheet_ColumnIterator::__destruct

(

)

Destructor.

Definition at line 87 of file ColumnIterator.php.

                                     {
                unset($this->_subject);
        }

Member Function Documentation

current()

PHPExcel_Worksheet_ColumnIterator::current

(

)

Return the current column in this worksheet.

Returns

PHPExcel_Worksheet_Column

Definition at line 147 of file ColumnIterator.php.

References PHPExcel_Cell\stringFromColumnIndex().

                                  {
                return new PHPExcel_Worksheet_Column($this->_subject, PHPExcel_Cell::stringFromColumnIndex($this->_position));
        }

Here is the call graph for this function:

key()

PHPExcel_Worksheet_ColumnIterator::key

(

)

Return the current iterator key.

Returns

string

Definition at line 156 of file ColumnIterator.php.

References PHPExcel_Cell\stringFromColumnIndex().

                              {
                return PHPExcel_Cell::stringFromColumnIndex($this->_position);
        }

Here is the call graph for this function:

next()

PHPExcel_Worksheet_ColumnIterator::next

(

)

Set the iterator to its next value.

Definition at line 163 of file ColumnIterator.php.

References $_position.

                               {
                ++$this->_position;
        }

prev()

PHPExcel_Worksheet_ColumnIterator::prev

(

)

Set the iterator to its previous value.

Exceptions

PHPExcel_Exception

Definition at line 172 of file ColumnIterator.php.

References $_position, and PHPExcel_Cell\stringFromColumnIndex().

                               {
        if ($this->_position <= $this->_startColumn) {
            throw new PHPExcel_Exception(
                "Column is already at the beginning of range (" . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . " - " . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . ")"
            );
        }

        --$this->_position;
        }

Here is the call graph for this function:

resetEnd()

PHPExcel_Worksheet_ColumnIterator::resetEnd

(

$endColumn = null

)

(Re)Set the end column

Parameters

string

$endColumn

The column address at which to stop iterating

Returns

PHPExcel_Worksheet_ColumnIterator

Definition at line 111 of file ColumnIterator.php.

References PHPExcel_Cell\columnIndexFromString().

Referenced by __construct().

                                                    {
                $endColumn = ($endColumn) ? $endColumn : $this->_subject->getHighestColumn();
                $this->_endColumn = PHPExcel_Cell::columnIndexFromString($endColumn) - 1;

        return $this;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

resetStart()

PHPExcel_Worksheet_ColumnIterator::resetStart

(

$startColumn = 'A'

)

(Re)Set the start column and the current column pointer

Parameters

integer

$startColumn

The column address at which to start iterating

Returns

PHPExcel_Worksheet_ColumnIterator

Definition at line 97 of file ColumnIterator.php.

References PHPExcel_Cell\columnIndexFromString(), and seek().

Referenced by __construct().

                                                       {
        $startColumnIndex = PHPExcel_Cell::columnIndexFromString($startColumn) - 1;
                $this->_startColumn = $startColumnIndex;
                $this->seek($startColumn);

        return $this;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

rewind()

PHPExcel_Worksheet_ColumnIterator::rewind

(

)

Rewind the iterator to the starting column.

Definition at line 138 of file ColumnIterator.php.

References $_startColumn.

                                 {
                $this->_position = $this->_startColumn;
        }

seek()

PHPExcel_Worksheet_ColumnIterator::seek

(

$column = 'A'

)

Set the column pointer to the selected column.

Parameters

string

$column

The column address to set the current pointer at

Returns

PHPExcel_Worksheet_ColumnIterator

Exceptions

PHPExcel_Exception

Definition at line 125 of file ColumnIterator.php.

References $column, and PHPExcel_Cell\columnIndexFromString().

Referenced by resetStart().

                                            {
        $column = PHPExcel_Cell::columnIndexFromString($column) - 1;
        if (($column < $this->_startColumn) || ($column > $this->_endColumn)) {
            throw new PHPExcel_Exception("Column $column is out of range ({$this->_startColumn} - {$this->_endColumn})");
        }
                $this->_position = $column;

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

valid()

PHPExcel_Worksheet_ColumnIterator::valid

(

)

Indicate if more columns exist in the worksheet range of columns that we're iterating.

Returns

boolean

Definition at line 189 of file ColumnIterator.php.

References $_endColumn.

                                {
                return $this->_position <= $this->_endColumn;
        }

Field Documentation

$_endColumn

PHPExcel_Worksheet_ColumnIterator::$_endColumn = 0

private

Definition at line 67 of file ColumnIterator.php.

Referenced by valid().

$_position

PHPExcel_Worksheet_ColumnIterator::$_position = 0

private

Definition at line 52 of file ColumnIterator.php.

Referenced by next(), and prev().

$_startColumn

PHPExcel_Worksheet_ColumnIterator::$_startColumn = 0

private

Definition at line 59 of file ColumnIterator.php.

Referenced by rewind().

$_subject

PHPExcel_Worksheet_ColumnIterator::$_subject

private

Definition at line 45 of file ColumnIterator.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/ColumnIterator.php