PHPExcel_Worksheet Class Reference

Inheritance diagram for PHPExcel_Worksheet:

Collaboration diagram for PHPExcel_Worksheet:

Public Member Functions
	__construct (PHPExcel $pParent=null, $pTitle='Worksheet')
	Create a new worksheet. More...
	disconnectCells ()
	Disconnect all cells from this PHPExcel_Worksheet object, typically so that the worksheet object can be unset. More...
	__destruct ()
	Code to execute when this worksheet is unset() More...
	getCellCacheController ()
	Return the cache controller for the cell collection. More...
	getCellCollection ($pSorted=true)
	Get collection of cells. More...
	sortCellCollection ()
	Sort collection of cells. More...
	getRowDimensions ()
	Get collection of row dimensions. More...
	getDefaultRowDimension ()
	Get default row dimension. More...
	getColumnDimensions ()
	Get collection of column dimensions. More...
	getDefaultColumnDimension ()
	Get default column dimension. More...
	getDrawingCollection ()
	Get collection of drawings. More...
	getChartCollection ()
	Get collection of charts. More...
	addChart (PHPExcel_Chart $pChart=null, $iChartIndex=null)
	Add chart. More...
	getChartCount ()
	Return the count of charts on this worksheet. More...
	getChartByIndex ($index=null)
	Get a chart by its index position. More...
	getChartNames ()
	Return an array of the names of charts on this worksheet. More...
	getChartByName ($chartName='')
	Get a chart by name. More...
	refreshColumnDimensions ()
	Refresh column dimensions. More...
	refreshRowDimensions ()
	Refresh row dimensions. More...
	calculateWorksheetDimension ()
	Calculate worksheet dimension. More...
	calculateWorksheetDataDimension ()
	Calculate worksheet data dimension. More...
	calculateColumnWidths ($calculateMergeCells=false)
	Calculate widths for auto-size columns. More...
	getParent ()
	Get parent. More...
	rebindParent (PHPExcel $parent)
	Re-bind parent. More...
	getTitle ()
	Get title. More...
	setTitle ($pValue='Worksheet', $updateFormulaCellReferences=true)
	Set title. More...
	getSheetState ()
	Get sheet state. More...
	setSheetState ($value=PHPExcel_Worksheet::SHEETSTATE_VISIBLE)
	Set sheet state. More...
	getPageSetup ()
	Get page setup. More...
	setPageSetup (PHPExcel_Worksheet_PageSetup $pValue)
	Set page setup. More...
	getPageMargins ()
	Get page margins. More...
	setPageMargins (PHPExcel_Worksheet_PageMargins $pValue)
	Set page margins. More...
	getHeaderFooter ()
	Get page header/footer. More...
	setHeaderFooter (PHPExcel_Worksheet_HeaderFooter $pValue)
	Set page header/footer. More...
	getSheetView ()
	Get sheet view. More...
	setSheetView (PHPExcel_Worksheet_SheetView $pValue)
	Set sheet view. More...
	getProtection ()
	Get Protection. More...
	setProtection (PHPExcel_Worksheet_Protection $pValue)
	Set Protection. More...
	getHighestColumn ($row=null)
	Get highest worksheet column. More...
	getHighestDataColumn ($row=null)
	Get highest worksheet column that contains data. More...
	getHighestRow ($column=null)
	Get highest worksheet row. More...
	getHighestDataRow ($column=null)
	Get highest worksheet row that contains data. More...
	getHighestRowAndColumn ()
	Get highest worksheet column and highest row that have cell records. More...
	setCellValue ($pCoordinate='A1', $pValue=null, $returnCell=false)
	Set a cell value. More...
	setCellValueByColumnAndRow ($pColumn=0, $pRow=1, $pValue=null, $returnCell=false)
	Set a cell value by using numeric cell coordinates. More...
	setCellValueExplicit ($pCoordinate='A1', $pValue=null, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING, $returnCell=false)
	Set a cell value. More...
	setCellValueExplicitByColumnAndRow ($pColumn=0, $pRow=1, $pValue=null, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING, $returnCell=false)
	Set a cell value by using numeric cell coordinates. More...
	getCell ($pCoordinate='A1')
	Get cell at a specific coordinate. More...
	getCellByColumnAndRow ($pColumn=0, $pRow=1)
	Get cell at a specific coordinate by using numeric cell coordinates. More...
	cellExists ($pCoordinate='A1')
	Does the cell at a specific coordinate exist? More...
	cellExistsByColumnAndRow ($pColumn=0, $pRow=1)
	Cell at a specific coordinate by using numeric cell coordinates exists? More...
	getRowDimension ($pRow=1, $create=TRUE)
	Get row dimension at a specific row. More...
	getColumnDimension ($pColumn='A', $create=TRUE)
	Get column dimension at a specific column. More...
	getColumnDimensionByColumn ($pColumn=0)
	Get column dimension at a specific column by using numeric cell coordinates. More...
	getStyles ()
	Get styles. More...
	getDefaultStyle ()
	Get default style of workbook. More...
	setDefaultStyle (PHPExcel_Style $pValue)
	Set default style - should only be used by PHPExcel_IReader implementations! More...
	getStyle ($pCellCoordinate='A1')
	Get style for cell. More...
	getConditionalStyles ($pCoordinate='A1')
	Get conditional styles for a cell. More...
	conditionalStylesExists ($pCoordinate='A1')
	Do conditional styles exist for this cell? More...
	removeConditionalStyles ($pCoordinate='A1')
	Removes conditional styles for a cell. More...
	getConditionalStylesCollection ()
	Get collection of conditional styles. More...
	setConditionalStyles ($pCoordinate='A1', $pValue)
	Set conditional styles. More...
	getStyleByColumnAndRow ($pColumn=0, $pRow=1, $pColumn2=null, $pRow2=null)
	Get style for cell by using numeric cell coordinates. More...
	setSharedStyle (PHPExcel_Style $pSharedCellStyle=null, $pRange='')
	Set shared cell style to a range of cells. More...
	duplicateStyle (PHPExcel_Style $pCellStyle=null, $pRange='')
	Duplicate cell style to a range of cells. More...
	duplicateConditionalStyle (array $pCellStyle=null, $pRange='')
	Duplicate conditional style to a range of cells. More...
	duplicateStyleArray ($pStyles=null, $pRange='', $pAdvanced=true)
	Duplicate cell style array to a range of cells. More...
	setBreak ($pCell='A1', $pBreak=PHPExcel_Worksheet::BREAK_NONE)
	Set break on a cell. More...
	setBreakByColumnAndRow ($pColumn=0, $pRow=1, $pBreak=PHPExcel_Worksheet::BREAK_NONE)
	Set break on a cell by using numeric cell coordinates. More...
	getBreaks ()
	Get breaks. More...
	mergeCells ($pRange='A1:A1')
	Set merge on a cell range. More...
	mergeCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
	Set merge on a cell range by using numeric cell coordinates. More...
	unmergeCells ($pRange='A1:A1')
	Remove merge on a cell range. More...
	unmergeCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
	Remove merge on a cell range by using numeric cell coordinates. More...
	getMergeCells ()
	Get merge cells array. More...
	setMergeCells ($pValue=array())
	Set merge cells array for the entire sheet. More...
	protectCells ($pRange='A1', $pPassword='', $pAlreadyHashed=false)
	Set protection on a cell range. More...
	protectCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1, $pPassword='', $pAlreadyHashed=false)
	Set protection on a cell range by using numeric cell coordinates. More...
	unprotectCells ($pRange='A1')
	Remove protection on a cell range. More...
	unprotectCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1, $pPassword='', $pAlreadyHashed=false)
	Remove protection on a cell range by using numeric cell coordinates. More...
	getProtectedCells ()
	Get protected cells. More...
	getAutoFilter ()
	Get Autofilter. More...
	setAutoFilter ($pValue)
	Set AutoFilter. More...
	setAutoFilterByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
	Set Autofilter Range by using numeric cell coordinates. More...
	removeAutoFilter ()
	Remove autofilter. More...
	getFreezePane ()
	Get Freeze Pane. More...
	freezePane ($pCell='')
	Freeze Pane. More...
	freezePaneByColumnAndRow ($pColumn=0, $pRow=1)
	Freeze Pane by using numeric cell coordinates. More...
	unfreezePane ()
	Unfreeze Pane. More...
	insertNewRowBefore ($pBefore=1, $pNumRows=1)
	Insert a new row, updating all possible related data. More...
	insertNewColumnBefore ($pBefore='A', $pNumCols=1)
	Insert a new column, updating all possible related data. More...
	insertNewColumnBeforeByIndex ($pBefore=0, $pNumCols=1)
	Insert a new column, updating all possible related data. More...
	removeRow ($pRow=1, $pNumRows=1)
	Delete a row, updating all possible related data. More...
	removeColumn ($pColumn='A', $pNumCols=1)
	Remove a column, updating all possible related data. More...
	removeColumnByIndex ($pColumn=0, $pNumCols=1)
	Remove a column, updating all possible related data. More...
	getShowGridlines ()
	Show gridlines? More...
	setShowGridlines ($pValue=false)
	Set show gridlines. More...
	getPrintGridlines ()
	Print gridlines? More...
	setPrintGridlines ($pValue=false)
	Set print gridlines. More...
	getShowRowColHeaders ()
	Show row and column headers? More...
	setShowRowColHeaders ($pValue=false)
	Set show row and column headers. More...
	getShowSummaryBelow ()
	Show summary below? (Row/Column outlining) More...
	setShowSummaryBelow ($pValue=true)
	Set show summary below. More...
	getShowSummaryRight ()
	Show summary right? (Row/Column outlining) More...
	setShowSummaryRight ($pValue=true)
	Set show summary right. More...
	getComments ()
	Get comments. More...
	setComments ($pValue=array())
	Set comments array for the entire sheet. More...
	getComment ($pCellCoordinate='A1')
	Get comment for cell. More...
	getCommentByColumnAndRow ($pColumn=0, $pRow=1)
	Get comment for cell by using numeric cell coordinates. More...
	getSelectedCell ()
	Get selected cell. More...
	getActiveCell ()
	Get active cell. More...
	getSelectedCells ()
	Get selected cells. More...
	setSelectedCell ($pCoordinate='A1')
	Selected cell. More...
	setSelectedCells ($pCoordinate='A1')
	Select a range of cells. More...
	setSelectedCellByColumnAndRow ($pColumn=0, $pRow=1)
	Selected cell by using numeric cell coordinates. More...
	getRightToLeft ()
	Get right-to-left. More...
	setRightToLeft ($value=false)
	Set right-to-left. More...
	fromArray ($source=null, $nullValue=null, $startCell='A1', $strictNullComparison=false)
	Fill worksheet from values in array. More...
	rangeToArray ($pRange='A1', $nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
	Create array from a range of cells. More...
	namedRangeToArray ($pNamedRange='', $nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
	Create array from a range of cells. More...
	toArray ($nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
	Create array from worksheet. More...
	getRowIterator ($startRow=1, $endRow=null)
	Get row iterator. More...
	getColumnIterator ($startColumn='A', $endColumn=null)
	Get column iterator. More...
	garbageCollect ()
	Run PHPExcel garabage collector. More...
	getHashCode ()
	Get hash code. More...
	getHyperlink ($pCellCoordinate='A1')
	Get hyperlink. More...
	setHyperlink ($pCellCoordinate='A1', PHPExcel_Cell_Hyperlink $pHyperlink=null)
	Set hyperlnk. More...
	hyperlinkExists ($pCoordinate='A1')
	Hyperlink at a specific coordinate exists? More...
	getHyperlinkCollection ()
	Get collection of hyperlinks. More...
	getDataValidation ($pCellCoordinate='A1')
	Get data validation. More...
	setDataValidation ($pCellCoordinate='A1', PHPExcel_Cell_DataValidation $pDataValidation=null)
	Set data validation. More...
	dataValidationExists ($pCoordinate='A1')
	Data validation at a specific coordinate exists? More...
	getDataValidationCollection ()
	Get collection of data validations. More...
	shrinkRangeToFit ($range)
	Accepts a range, returning it as a range that falls within the current highest row and column of the worksheet. More...
	getTabColor ()
	Get tab color. More...
	resetTabColor ()
	Reset tab color. More...
	isTabColorSet ()
	Tab color set? More...
	copy ()
	Copy worksheet (!= clone!) More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...
	setCodeName ($pValue=null)
	Define the code name of the sheet. More...
	getCodeName ()
	Return the code name of the sheet. More...
	hasCodeName ()
	Sheet has a code name ? More...
	getHashCode ()
	Get hash code. More...

Static Public Member Functions
static	getInvalidCharacters ()
	Get array of invalid characters for sheet title. More...
static	extractSheetTitle ($pRange, $returnRange=false)
	Extract worksheet title from range. More...

Data Fields
const	BREAK_NONE = 0
const	BREAK_ROW = 1
const	BREAK_COLUMN = 2
const	SHEETSTATE_VISIBLE = 'visible'
const	SHEETSTATE_HIDDEN = 'hidden'
const	SHEETSTATE_VERYHIDDEN = 'veryHidden'

Private Member Functions
	_createNewCell ($pCoordinate)
	Create a new cell at the specified coordinate. More...

Static Private Member Functions
static	_checkSheetCodeName ($pValue)
	Check sheet code name for valid Excel syntax. More...
static	_checkSheetTitle ($pValue)
	Check sheet title for valid Excel syntax. More...

Private Attributes
	$_parent
	$_cellCollection = null
	$_rowDimensions = array()
	$_defaultRowDimension = null
	$_columnDimensions = array()
	$_defaultColumnDimension = null
	$_drawingCollection = null
	$_chartCollection = array()
	$_title
	$_sheetState
	$_pageSetup
	$_pageMargins
	$_headerFooter
	$_sheetView
	$_protection
	$_styles = array()
	$_conditionalStylesCollection = array()
	$_cellCollectionIsSorted = false
	$_breaks = array()
	$_mergeCells = array()
	$_protectedCells = array()
	$_autoFilter = NULL
	$_freezePane = ''
	$_showGridlines = true
	$_printGridlines = false
	$_showRowColHeaders = true
	$_showSummaryBelow = true
	$_showSummaryRight = true
	$_comments = array()
	$_activeCell = 'A1'
	$_selectedCells = 'A1'
	$_cachedHighestColumn = 'A'
	$_cachedHighestRow = 1
	$_rightToLeft = false
	$_hyperlinkCollection = array()
	$_dataValidationCollection = array()
	$_tabColor
	$_dirty = true
	$_hash = null
	$_codeName = null

Static Private Attributes
static	$_invalidCharacters = array('*', ':', '/', '\\', '?', '[', ']')

Detailed Description

Definition at line 36 of file Worksheet.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Worksheet::__construct	(	PHPExcel	$pParent = null,
			$pTitle = 'Worksheet'
	)

Create a new worksheet.

Parameters

PHPExcel	$pParent
string	$pTitle

Definition at line 341 of file Worksheet.php.

    {
        // Set parent and title
        $this->_parent = $pParent;
        $this->setTitle($pTitle, FALSE);
        // setTitle can change $pTitle
            $this->setCodeName($this->getTitle());
        $this->setSheetState(PHPExcel_Worksheet::SHEETSTATE_VISIBLE);
 
        $this->_cellCollection        = PHPExcel_CachedObjectStorageFactory::getInstance($this);
 
        // Set page setup
        $this->_pageSetup            = new PHPExcel_Worksheet_PageSetup();
 
        // Set page margins
        $this->_pageMargins         = new PHPExcel_Worksheet_PageMargins();
 
        // Set page header/footer
        $this->_headerFooter        = new PHPExcel_Worksheet_HeaderFooter();
 
        // Set sheet view
        $this->_sheetView            = new PHPExcel_Worksheet_SheetView();
 
        // Drawing collection
        $this->_drawingCollection    = new ArrayObject();
 
        // Chart collection
        $this->_chartCollection     = new ArrayObject();
 
        // Protection
        $this->_protection            = new PHPExcel_Worksheet_Protection();
 
        // Default row dimension
        $this->_defaultRowDimension = new PHPExcel_Worksheet_RowDimension(NULL);
 
        // Default column dimension
        $this->_defaultColumnDimension    = new PHPExcel_Worksheet_ColumnDimension(NULL);
 
        $this->_autoFilter            = new PHPExcel_Worksheet_AutoFilter(NULL, $this);
    }

References PHPExcel_CachedObjectStorageFactory\getInstance(), getTitle(), setCodeName(), setSheetState(), setTitle(), and SHEETSTATE_VISIBLE.

Here is the call graph for this function:

__destruct()

PHPExcel_Worksheet::__destruct

(

)

Code to execute when this worksheet is unset()

Definition at line 401 of file Worksheet.php.

                              {
                PHPExcel_Calculation::getInstance($this->_parent)
                    ->clearCalculationCacheForWorksheet($this->_title);
 
                $this->disconnectCells();
        }

References disconnectCells(), and PHPExcel_Calculation\getInstance().

Here is the call graph for this function:

Member Function Documentation

__clone()

PHPExcel_Worksheet::__clone

(

)

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 2856 of file Worksheet.php.

                                  {
        foreach ($this as $key => $val) {
            if ($key == '_parent') {
                continue;
            }
 
            if (is_object($val) || (is_array($val))) {
                if ($key == '_cellCollection') {
                    $newCollection = clone $this->_cellCollection;
                    $newCollection->copyCellCollection($this);
                    $this->_cellCollection = $newCollection;
                } elseif ($key == '_drawingCollection') {
                    $newCollection = clone $this->_drawingCollection;
                    $this->_drawingCollection = $newCollection;
                } elseif (($key == '_autoFilter') && ($this->_autoFilter instanceof PHPExcel_Worksheet_AutoFilter)) {
                    $newAutoFilter = clone $this->_autoFilter;
                    $this->_autoFilter = $newAutoFilter;
                    $this->_autoFilter->setParent($this);
                } else {
                    $this->{$key} = unserialize(serialize($val));
                }
            }
        }
    }

References $_autoFilter, $_cellCollection, and $_drawingCollection.

_checkSheetCodeName()

static PHPExcel_Worksheet::_checkSheetCodeName (   $pValue )

staticprivate

Check sheet code name for valid Excel syntax.

Parameters

string

$pValue

The string to check

Returns

string The valid string

Exceptions

Exception

Definition at line 435 of file Worksheet.php.

    {
        $CharCount = PHPExcel_Shared_String::CountCharacters($pValue);
        if ($CharCount == 0) {
            throw new PHPExcel_Exception('Sheet code name cannot be empty.');
        }
        // Some of the printable ASCII characters are invalid:  * : / \ ? [ ] and  first and last characters cannot be a "'"
        if ((str_replace(self::$_invalidCharacters, '', $pValue) !== $pValue) || 
            (PHPExcel_Shared_String::Substring($pValue,-1,1)=='\'') || 
            (PHPExcel_Shared_String::Substring($pValue,0,1)=='\'')) {
            throw new PHPExcel_Exception('Invalid character found in sheet code name');
        }
 
        // Maximum 31 characters allowed for sheet title
        if ($CharCount > 31) {
            throw new PHPExcel_Exception('Maximum 31 characters allowed in sheet code name.');
        }
 
        return $pValue;
    }

References PHPExcel_Shared_String\CountCharacters(), and PHPExcel_Shared_String\Substring().

Referenced by setCodeName().

Here is the call graph for this function:

Here is the caller graph for this function:

_checkSheetTitle()

static PHPExcel_Worksheet::_checkSheetTitle (   $pValue )

staticprivate

Check sheet title for valid Excel syntax.

Parameters

string

$pValue

The string to check

Returns

string The valid string

Exceptions

PHPExcel_Exception

Definition at line 463 of file Worksheet.php.

    {
        // Some of the printable ASCII characters are invalid:  * : / \ ? [ ]
        if (str_replace(self::$_invalidCharacters, '', $pValue) !== $pValue) {
            throw new PHPExcel_Exception('Invalid character found in sheet title');
        }
 
        // Maximum 31 characters allowed for sheet title
        if (PHPExcel_Shared_String::CountCharacters($pValue) > 31) {
            throw new PHPExcel_Exception('Maximum 31 characters allowed in sheet title.');
        }
 
        return $pValue;
    }

References PHPExcel_Shared_String\CountCharacters().

Referenced by setTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

_createNewCell()

PHPExcel_Worksheet::_createNewCell (   $pCoordinate )

private

Create a new cell at the specified coordinate.

Parameters

string

$pCoordinate

Coordinate of the cell

Returns

PHPExcel_Cell Cell that was created

Definition at line 1215 of file Worksheet.php.

        {
                $cell = $this->_cellCollection->addCacheData(
                        $pCoordinate,
                        new PHPExcel_Cell(
                                NULL, 
                                PHPExcel_Cell_DataType::TYPE_NULL, 
                                $this
                        )
                );
        $this->_cellCollectionIsSorted = false;
 
        // Coordinates
        $aCoordinates = PHPExcel_Cell::coordinateFromString($pCoordinate);
        if (PHPExcel_Cell::columnIndexFromString($this->_cachedHighestColumn) < PHPExcel_Cell::columnIndexFromString($aCoordinates[0]))
            $this->_cachedHighestColumn = $aCoordinates[0];
        $this->_cachedHighestRow = max($this->_cachedHighestRow, $aCoordinates[1]);
 
        // Cell needs appropriate xfIndex from dimensions records
                //    but don't create dimension records if they don't already exist
        $rowDimension    = $this->getRowDimension($aCoordinates[1], FALSE);
        $columnDimension = $this->getColumnDimension($aCoordinates[0], FALSE);
 
        if ($rowDimension !== NULL && $rowDimension->getXfIndex() > 0) {
            // then there is a row dimension with explicit style, assign it to the cell
            $cell->setXfIndex($rowDimension->getXfIndex());
        } elseif ($columnDimension !== NULL && $columnDimension->getXfIndex() > 0) {
            // then there is a column dimension, assign it to the cell
            $cell->setXfIndex($columnDimension->getXfIndex());
        }
 
        return $cell;
        }

References PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\coordinateFromString(), getColumnDimension(), getRowDimension(), and PHPExcel_Cell_DataType\TYPE_NULL.

Referenced by getCell(), and getCellByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

addChart()

PHPExcel_Worksheet::addChart	(	PHPExcel_Chart	$pChart = null,
			$iChartIndex = null
	)

Add chart.

Parameters

PHPExcel_Chart	$pChart
int | null	$iChartIndex	Index where chart should go (0,1,..., or null for last)

Returns

PHPExcel_Chart

Definition at line 576 of file Worksheet.php.

    {
        $pChart->setWorksheet($this);
        if (is_null($iChartIndex)) {
            $this->_chartCollection[] = $pChart;
        } else {
            // Insert the chart at the requested index
            array_splice($this->_chartCollection, $iChartIndex, 0, array($pChart));
        }
 
        return $pChart;
    }

calculateColumnWidths()

PHPExcel_Worksheet::calculateColumnWidths

(

$calculateMergeCells = false

)

Calculate widths for auto-size columns.

Parameters

boolean

$calculateMergeCells

Calculate merge cell width

Returns

PHPExcel_Worksheet;

Definition at line 724 of file Worksheet.php.

    {
        // initialize $autoSizes array
        $autoSizes = array();
        foreach ($this->getColumnDimensions() as $colDimension) {
            if ($colDimension->getAutoSize()) {
                $autoSizes[$colDimension->getColumnIndex()] = -1;
            }
        }
 
        // There is only something to do if there are some auto-size columns
        if (!empty($autoSizes)) {
 
            // build list of cells references that participate in a merge
            $isMergeCell = array();
            foreach ($this->getMergeCells() as $cells) {
                foreach (PHPExcel_Cell::extractAllCellReferencesInRange($cells) as $cellReference) {
                    $isMergeCell[$cellReference] = true;
                }
            }
 
            // loop through all cells in the worksheet
            foreach ($this->getCellCollection(false) as $cellID) {
                $cell = $this->getCell($cellID);
                                if (isset($autoSizes[$this->_cellCollection->getCurrentColumn()])) {
                    // Determine width if cell does not participate in a merge
                                        if (!isset($isMergeCell[$this->_cellCollection->getCurrentAddress()])) {
                        // Calculated value
                        // To formatted string
                                                $cellValue = PHPExcel_Style_NumberFormat::toFormattedString(
                                                        $cell->getCalculatedValue(),
                                                        $this->getParent()->getCellXfByIndex($cell->getXfIndex())->getNumberFormat()->getFormatCode()
                                                );
 
                                                $autoSizes[$this->_cellCollection->getCurrentColumn()] = max(
                                                        (float) $autoSizes[$this->_cellCollection->getCurrentColumn()],
                            (float)PHPExcel_Shared_Font::calculateColumnWidth(
                                                                $this->getParent()->getCellXfByIndex($cell->getXfIndex())->getFont(),
                                $cellValue,
                                                                $this->getParent()->getCellXfByIndex($cell->getXfIndex())->getAlignment()->getTextRotation(),
                                $this->getDefaultStyle()->getFont()
                            )
                        );
                    }
                }
            }
 
            // adjust column widths
            foreach ($autoSizes as $columnIndex => $width) {
                if ($width == -1) $width = $this->getDefaultColumnDimension()->getWidth();
                $this->getColumnDimension($columnIndex)->setWidth($width);
            }
        }
 
        return $this;
    }

References PHPExcel_Shared_Font\calculateColumnWidth(), PHPExcel_Cell\extractAllCellReferencesInRange(), getCell(), getCellCollection(), getColumnDimension(), getColumnDimensions(), getDefaultColumnDimension(), getMergeCells(), and PHPExcel_Style_NumberFormat\toFormattedString().

Here is the call graph for this function:

calculateWorksheetDataDimension()

PHPExcel_Worksheet::calculateWorksheetDataDimension

(

)

Calculate worksheet data dimension.

Returns

string String containing the dimension of this worksheet that actually contain data

Definition at line 712 of file Worksheet.php.

    {
        // Return
        return 'A1' . ':' .  $this->getHighestDataColumn() . $this->getHighestDataRow();
    }

References getHighestDataColumn(), and getHighestDataRow().

Here is the call graph for this function:

calculateWorksheetDimension()

PHPExcel_Worksheet::calculateWorksheetDimension

(

)

Calculate worksheet dimension.

Returns

string String containing the dimension of this worksheet

Definition at line 701 of file Worksheet.php.

    {
        // Return
        return 'A1' . ':' .  $this->getHighestColumn() . $this->getHighestRow();
    }

References getHighestColumn(), and getHighestRow().

Here is the call graph for this function:

cellExists()

PHPExcel_Worksheet::cellExists

(

$pCoordinate = 'A1'

)

Does the cell at a specific coordinate exist?

Parameters

string

$pCoordinate

Coordinate of the cell

Exceptions

PHPExcel_Exception

Returns

boolean

Definition at line 1256 of file Worksheet.php.

    {
       // Worksheet reference?
        if (strpos($pCoordinate, '!') !== false) {
            $worksheetReference = PHPExcel_Worksheet::extractSheetTitle($pCoordinate, true);
                        return $this->_parent->getSheetByName($worksheetReference[0])->cellExists(strtoupper($worksheetReference[1]));
        }
 
        // Named range?
        if ((!preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_CELLREF.'$/i', $pCoordinate, $matches)) &&
            (preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_NAMEDRANGE.'$/i', $pCoordinate, $matches))) {
            $namedRange = PHPExcel_NamedRange::resolveRange($pCoordinate, $this);
            if ($namedRange !== NULL) {
                $pCoordinate = $namedRange->getRange();
                if ($this->getHashCode() != $namedRange->getWorksheet()->getHashCode()) {
                    if (!$namedRange->getLocalOnly()) {
                        return $namedRange->getWorksheet()->cellExists($pCoordinate);
                    } else {
                        throw new PHPExcel_Exception('Named range ' . $namedRange->getName() . ' is not accessible from within sheet ' . $this->getTitle());
                    }
                }
            }
            else { return false; }
        }
 
        // Uppercase coordinate
        $pCoordinate = strtoupper($pCoordinate);
 
        if (strpos($pCoordinate,':') !== false || strpos($pCoordinate,',') !== false) {
            throw new PHPExcel_Exception('Cell coordinate can not be a range of cells.');
        } elseif (strpos($pCoordinate,'$') !== false) {
            throw new PHPExcel_Exception('Cell coordinate must not be absolute.');
        } else {
            // Coordinates
            $aCoordinates = PHPExcel_Cell::coordinateFromString($pCoordinate);
 
            // Cell exists?
            return $this->_cellCollection->isDataSet($pCoordinate);
        }
    }

References PHPExcel_Calculation\CALCULATION_REGEXP_CELLREF, PHPExcel_Calculation\CALCULATION_REGEXP_NAMEDRANGE, PHPExcel_Cell\coordinateFromString(), extractSheetTitle(), getHashCode(), and PHPExcel_NamedRange\resolveRange().

Referenced by cellExistsByColumnAndRow(), and mergeCells().

Here is the call graph for this function:

Here is the caller graph for this function:

cellExistsByColumnAndRow()

PHPExcel_Worksheet::cellExistsByColumnAndRow	(		$pColumn = 0,
			$pRow = 1
	)

Cell at a specific coordinate by using numeric cell coordinates exists?

Parameters

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

Returns

boolean

Definition at line 1304 of file Worksheet.php.

    {
        return $this->cellExists(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
    }

References cellExists(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

conditionalStylesExists()

PHPExcel_Worksheet::conditionalStylesExists

(

$pCoordinate = 'A1'

)

Do conditional styles exist for this cell?

Parameters

string

$pCoordinate

Returns

boolean

Definition at line 1445 of file Worksheet.php.

    {
        if (isset($this->_conditionalStylesCollection[strtoupper($pCoordinate)])) {
            return true;
        }
        return false;
    }

copy()

PHPExcel_Worksheet::copy

(

)

Copy worksheet (!= clone!)

Returns

PHPExcel_Worksheet

Definition at line 2847 of file Worksheet.php.

                               {
        $copied = clone $this;
 
        return $copied;
    }

dataValidationExists()

PHPExcel_Worksheet::dataValidationExists

(

$pCoordinate = 'A1'

)

Data validation at a specific coordinate exists?

Parameters

string

$pCoordinate

Returns

boolean

Definition at line 2764 of file Worksheet.php.

    {
        return isset($this->_dataValidationCollection[$pCoordinate]);
    }

disconnectCells()

PHPExcel_Worksheet::disconnectCells

(

)

Disconnect all cells from this PHPExcel_Worksheet object, typically so that the worksheet object can be unset.

Definition at line 388 of file Worksheet.php.

                                          {
        if ( $this->_cellCollection !== NULL){
            $this->_cellCollection->unsetWorksheetCells();
            $this->_cellCollection = NULL;
        }
        //    detach ourself from the workbook, so that it can then delete this worksheet successfully
        $this->_parent = null;
    }

Referenced by __destruct().

Here is the caller graph for this function:

duplicateConditionalStyle()

PHPExcel_Worksheet::duplicateConditionalStyle	(	array	$pCellStyle = null,
			$pRange = ''
	)

Duplicate conditional style to a range of cells.

Please note that this will overwrite existing cell styles for cells in range!

@param      array of PHPExcel_Style_Conditional     $pCellStyle     Cell style to duplicate

Parameters

string

$pRange

Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1581 of file Worksheet.php.

    {
        foreach($pCellStyle as $cellStyle) {
            if (!($cellStyle instanceof PHPExcel_Style_Conditional)) {
                throw new PHPExcel_Exception('Style is not a conditional style');
            }
        }
 
        // Calculate range outer borders
        list($rangeStart, $rangeEnd) = PHPExcel_Cell::rangeBoundaries($pRange . ':' . $pRange);
 
        // Make sure we can loop upwards on rows and columns
        if ($rangeStart[0] > $rangeEnd[0] && $rangeStart[1] > $rangeEnd[1]) {
            $tmp = $rangeStart;
            $rangeStart = $rangeEnd;
            $rangeEnd = $tmp;
        }
 
        // Loop through cells and apply styles
        for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
            for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
                $this->setConditionalStyles(PHPExcel_Cell::stringFromColumnIndex($col - 1) . $row, $pCellStyle);
            }
        }
 
        return $this;
    }

References $row, PHPExcel_Cell\rangeBoundaries(), setConditionalStyles(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

duplicateStyle()

PHPExcel_Worksheet::duplicateStyle	(	PHPExcel_Style	$pCellStyle = null,
			$pRange = ''
	)

Duplicate cell style to a range of cells.

Please note that this will overwrite existing cell styles for cells in range!

Parameters

PHPExcel_Style	$pCellStyle	Cell style to duplicate
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1535 of file Worksheet.php.

    {
        // make sure we have a real style and not supervisor
        $style = $pCellStyle->getIsSupervisor() ? $pCellStyle->getSharedComponent() : $pCellStyle;
 
        // Add the style to the workbook if necessary
        $workbook = $this->_parent;
                if ($existingStyle = $this->_parent->getCellXfByHashCode($pCellStyle->getHashCode())) {
            // there is already such cell Xf in our collection
            $xfIndex = $existingStyle->getIndex();
        } else {
            // we don't have such a cell Xf, need to add
            $workbook->addCellXf($pCellStyle);
            $xfIndex = $pCellStyle->getIndex();
        }
 
        // Calculate range outer borders
        list($rangeStart, $rangeEnd) = PHPExcel_Cell::rangeBoundaries($pRange . ':' . $pRange);
 
        // Make sure we can loop upwards on rows and columns
        if ($rangeStart[0] > $rangeEnd[0] && $rangeStart[1] > $rangeEnd[1]) {
            $tmp = $rangeStart;
            $rangeStart = $rangeEnd;
            $rangeEnd = $tmp;
        }
 
        // Loop through cells and apply styles
        for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
            for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
                $this->getCell(PHPExcel_Cell::stringFromColumnIndex($col - 1) . $row)->setXfIndex($xfIndex);
            }
        }
 
        return $this;
    }

References $_parent, $row, $style, getCell(), PHPExcel_Cell\rangeBoundaries(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by setSharedStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

duplicateStyleArray()

PHPExcel_Worksheet::duplicateStyleArray	(		$pStyles = null,
			$pRange = '',
			$pAdvanced = true
	)

Duplicate cell style array to a range of cells.

Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. For example, if you decide to set a range of cells to font bold, only include font bold in the styles array.

Deprecated:

Parameters

array	$pStyles	Array containing style information
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
boolean	$pAdvanced	Advanced mode for setting borders.

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1623 of file Worksheet.php.

    {
        $this->getStyle($pRange)->applyFromArray($pStyles, $pAdvanced);
        return $this;
    }

References getStyle().

Here is the call graph for this function:

extractSheetTitle()

static PHPExcel_Worksheet::extractSheetTitle (   $pRange,   $returnRange = false  )

static

Extract worksheet title from range.

Example: extractSheetTitle("testSheet!A1") ==> 'A1' Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1');

Parameters

string	$pRange	Range to extract title from
bool	$returnRange	Return range? (see example)

Returns

mixed

Definition at line 2654 of file Worksheet.php.

                                                                                {
        // Sheet title included?
        if (($sep = strpos($pRange, '!')) === false) {
            return '';
        }
 
        if ($returnRange) {
            return array( trim(substr($pRange, 0, $sep),"'"),
                          substr($pRange, $sep + 1)
                        );
        }
 
        return substr($pRange, $sep + 1);
    }

Referenced by cellExists(), PHPExcel_Calculation\extractCellRange(), PHPExcel_Calculation\extractNamedRange(), getCell(), and PHPExcel_Reader_Excel2007\load().

Here is the caller graph for this function:

freezePane()

PHPExcel_Worksheet::freezePane

(

$pCell = ''

)

Freeze Pane.

Parameters

string

$pCell

Cell (i.e. A2) Examples: A2 will freeze the rows above cell A2 (i.e row 1) B1 will freeze the columns to the left of cell B1 (i.e column A) B2 will freeze the rows above and to the left of cell A2 (i.e row 1 and column A)

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1969 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pCell = strtoupper($pCell);
 
        if (strpos($pCell,':') === false && strpos($pCell,',') === false) {
            $this->_freezePane = $pCell;
        } else {
            throw new PHPExcel_Exception('Freeze pane can not be set on a range of cells.');
        }
        return $this;
    }

Referenced by freezePaneByColumnAndRow(), and unfreezePane().

Here is the caller graph for this function:

freezePaneByColumnAndRow()

PHPExcel_Worksheet::freezePaneByColumnAndRow	(		$pColumn = 0,
			$pRow = 1
	)

Freeze Pane by using numeric cell coordinates.

Parameters

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1990 of file Worksheet.php.

    {
        return $this->freezePane(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
    }

References freezePane(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

fromArray()

PHPExcel_Worksheet::fromArray	(		$source = null,
			$nullValue = null,
			$startCell = 'A1',
			$strictNullComparison = false
	)

Fill worksheet from values in array.

Parameters

array	$source	Source array
mixed	$nullValue	Value in source array that stands for blank cell
string	$startCell	Insert array starting from this cell address as the top left coordinate
boolean	$strictNullComparison	Apply strict comparison when testing for null values in the array

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2405 of file Worksheet.php.

                                                                                                                   {
        if (is_array($source)) {
            //    Convert a 1-D array to 2-D (for ease of looping)
            if (!is_array(end($source))) {
                $source = array($source);
            }
 
            // start coordinate
            list ($startColumn, $startRow) = PHPExcel_Cell::coordinateFromString($startCell);
 
            // Loop through $source
            foreach ($source as $rowData) {
                $currentColumn = $startColumn;
                foreach($rowData as $cellValue) {
                    if ($strictNullComparison) {
                        if ($cellValue !== $nullValue) {
                            // Set cell value
                            $this->getCell($currentColumn . $startRow)->setValue($cellValue);
                        }
                    } else {
                        if ($cellValue != $nullValue) {
                            // Set cell value
                            $this->getCell($currentColumn . $startRow)->setValue($cellValue);
                        }
                    }
                    ++$currentColumn;
                }
                ++$startRow;
            }
        } else {
            throw new PHPExcel_Exception("Parameter \$source should be an array.");
        }
        return $this;
    }

References PHPExcel_Cell\coordinateFromString(), and getCell().

Here is the call graph for this function:

garbageCollect()

PHPExcel_Worksheet::garbageCollect

(

)

Run PHPExcel garabage collector.

Returns

PHPExcel_Worksheet

Definition at line 2588 of file Worksheet.php.

                                         {
        // Flush cache
        $this->_cellCollection->getCacheData('A1');
        // Build a reference table from images
//        $imageCoordinates = array();
//        $iterator = $this->getDrawingCollection()->getIterator();
//        while ($iterator->valid()) {
//            $imageCoordinates[$iterator->current()->getCoordinates()] = true;
//
//            $iterator->next();
//        }
//
        // Lookup highest column and highest row if cells are cleaned
        $colRow = $this->_cellCollection->getHighestRowAndColumn();
        $highestRow = $colRow['row'];
        $highestColumn = PHPExcel_Cell::columnIndexFromString($colRow['column']);
 
        // Loop through column dimensions
        foreach ($this->_columnDimensions as $dimension) {
            $highestColumn = max($highestColumn,PHPExcel_Cell::columnIndexFromString($dimension->getColumnIndex()));
        }
 
        // Loop through row dimensions
        foreach ($this->_rowDimensions as $dimension) {
            $highestRow = max($highestRow,$dimension->getRowIndex());
        }
 
        // Cache values
        if ($highestColumn < 0) {
            $this->_cachedHighestColumn = 'A';
        } else {
            $this->_cachedHighestColumn = PHPExcel_Cell::stringFromColumnIndex(--$highestColumn);
        }
        $this->_cachedHighestRow = $highestRow;
 
        // Return
        return $this;
    }

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

Referenced by toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

getActiveCell()

PHPExcel_Worksheet::getActiveCell

(

)

Get active cell.

Returns

string Example: 'A1'

Definition at line 2302 of file Worksheet.php.

    {
        return $this->_activeCell;
    }

References $_activeCell.

getAutoFilter()

PHPExcel_Worksheet::getAutoFilter

(

)

Get Autofilter.

Returns

PHPExcel_Worksheet_AutoFilter

Definition at line 1892 of file Worksheet.php.

    {
        return $this->_autoFilter;
    }

References $_autoFilter.

getBreaks()

PHPExcel_Worksheet::getBreaks

(

)

Get breaks.

Returns

array[]

Definition at line 1675 of file Worksheet.php.

    {
        return $this->_breaks;
    }

References $_breaks.

Referenced by PHPExcel_ReferenceHelper\_adjustPageBreaks(), and PHPExcel_Writer_HTML\_generateRow().

Here is the caller graph for this function:

getCell()

PHPExcel_Worksheet::getCell

(

$pCoordinate = 'A1'

)

Get cell at a specific coordinate.

Parameters

string

$pCoordinate

Coordinate of the cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Cell Cell that was found

Definition at line 1153 of file Worksheet.php.

    {
        $pCoordinate = strtoupper($pCoordinate);
        // Check cell collection
        if ($this->_cellCollection->isDataSet($pCoordinate)) {
            return $this->_cellCollection->getCacheData($pCoordinate);
        }
 
        // Worksheet reference?
        if (strpos($pCoordinate, '!') !== false) {
            $worksheetReference = PHPExcel_Worksheet::extractSheetTitle($pCoordinate, true);
                        return $this->_parent->getSheetByName($worksheetReference[0])->getCell($worksheetReference[1]);
        }
 
        // Named range?
        if ((!preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_CELLREF.'$/i', $pCoordinate, $matches)) &&
            (preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_NAMEDRANGE.'$/i', $pCoordinate, $matches))) {
            $namedRange = PHPExcel_NamedRange::resolveRange($pCoordinate, $this);
            if ($namedRange !== NULL) {
                $pCoordinate = $namedRange->getRange();
                return $namedRange->getWorksheet()->getCell($pCoordinate);
            }
        }
 
        // Uppercase coordinate
        $pCoordinate = strtoupper($pCoordinate);
 
        if (strpos($pCoordinate, ':') !== false || strpos($pCoordinate, ',') !== false) {
            throw new PHPExcel_Exception('Cell coordinate can not be a range of cells.');
        } elseif (strpos($pCoordinate, '$') !== false) {
            throw new PHPExcel_Exception('Cell coordinate must not be absolute.');
        }
 
        // Create new cell object
        return $this->_createNewCell($pCoordinate);
    }

References _createNewCell(), PHPExcel_Calculation\CALCULATION_REGEXP_CELLREF, PHPExcel_Calculation\CALCULATION_REGEXP_NAMEDRANGE, extractSheetTitle(), and PHPExcel_NamedRange\resolveRange().

Referenced by PHPExcel_Writer_HTML\_generateRow(), PHPExcel\addExternalSheet(), calculateColumnWidths(), duplicateStyle(), fromArray(), mergeCells(), setCellValue(), and setCellValueExplicit().

Here is the call graph for this function:

Here is the caller graph for this function:

getCellByColumnAndRow()

PHPExcel_Worksheet::getCellByColumnAndRow	(		$pColumn = 0,
			$pRow = 1
	)

Get cell at a specific coordinate by using numeric cell coordinates.

Parameters

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

Returns

PHPExcel_Cell Cell that was found

Definition at line 1197 of file Worksheet.php.

    {
        $columnLetter = PHPExcel_Cell::stringFromColumnIndex($pColumn);
        $coordinate = $columnLetter . $pRow;
 
        if ($this->_cellCollection->isDataSet($coordinate)) {
            return $this->_cellCollection->getCacheData($coordinate);
        }
 
                return $this->_createNewCell($coordinate);
    }

References _createNewCell(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by setCellValueByColumnAndRow(), and setCellValueExplicitByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

getCellCacheController()

PHPExcel_Worksheet::getCellCacheController

(

)

Return the cache controller for the cell collection.

Returns

PHPExcel_CachedObjectStorage_xxx

Definition at line 413 of file Worksheet.php.

                                                 {
        return $this->_cellCollection;
    }    //    function getCellCacheController()

References $_cellCollection.

Referenced by PHPExcel_Cell\rebindParent(), removeColumn(), and removeRow().

Here is the caller graph for this function:

getCellCollection()

PHPExcel_Worksheet::getCellCollection

(

$pSorted = true

)

Get collection of cells.

Parameters

boolean

$pSorted

Also sort the cell collection?

Returns

PHPExcel_Cell[]

Definition at line 484 of file Worksheet.php.

    {
        if ($pSorted) {
            // Re-order cell collection
            return $this->sortCellCollection();
        }
        if ($this->_cellCollection !== NULL) {
            return $this->_cellCollection->getCellList();
        }
        return array();
    }

References sortCellCollection().

Referenced by PHPExcel\addExternalSheet(), and calculateColumnWidths().

Here is the call graph for this function:

Here is the caller graph for this function:

getChartByIndex()

PHPExcel_Worksheet::getChartByIndex

(

$index = null

)

Get a chart by its index position.

Parameters

string

$index

Chart index position

Returns

false|PHPExcel_Chart

Exceptions

PHPExcel_Exception

Definition at line 606 of file Worksheet.php.

    {
        $chartCount = count($this->_chartCollection);
        if ($chartCount == 0) {
            return false;
        }
        if (is_null($index)) {
            $index = --$chartCount;
        }
        if (!isset($this->_chartCollection[$index])) {
            return false;
        }
 
        return $this->_chartCollection[$index];
    }

getChartByName()

PHPExcel_Worksheet::getChartByName

(

$chartName = ''

)

Get a chart by name.

Parameters

string

$chartName

Chart name

Returns

false|PHPExcel_Chart

Exceptions

PHPExcel_Exception

Definition at line 644 of file Worksheet.php.

    {
        $chartCount = count($this->_chartCollection);
        if ($chartCount == 0) {
            return false;
        }
        foreach($this->_chartCollection as $index => $chart) {
            if ($chart->getName() == $chartName) {
                return $this->_chartCollection[$index];
            }
        }
        return false;
    }

References $chart.

getChartCollection()

PHPExcel_Worksheet::getChartCollection

(

)

Get collection of charts.

Returns

PHPExcel_Chart[]

Definition at line 564 of file Worksheet.php.

    {
        return $this->_chartCollection;
    }

References $_chartCollection.

Referenced by PHPExcel_Writer_HTML\_extendRowsForChartsAndImages(), and PHPExcel_Writer_HTML\_writeChartInCell().

Here is the caller graph for this function:

getChartCount()

PHPExcel_Worksheet::getChartCount

(

)

Return the count of charts on this worksheet.

Returns

int The number of charts

Definition at line 594 of file Worksheet.php.

    {
        return count($this->_chartCollection);
    }

getChartNames()

PHPExcel_Worksheet::getChartNames

(

)

Return an array of the names of charts on this worksheet.

Returns

string[] The names of charts

Exceptions

PHPExcel_Exception

Definition at line 628 of file Worksheet.php.

    {
        $chartNames = array();
        foreach($this->_chartCollection as $chart) {
            $chartNames[] = $chart->getName();
        }
        return $chartNames;
    }

References $chart.

getCodeName()

PHPExcel_Worksheet::getCodeName

(

)

Return the code name of the sheet.

Returns

null|string

Definition at line 2935 of file Worksheet.php.

                                     {
                return $this->_codeName;
        }

References $_codeName.

Referenced by setCodeName().

Here is the caller graph for this function:

getColumnDimension()

PHPExcel_Worksheet::getColumnDimension	(		$pColumn = 'A',
			$create = TRUE
	)

Get column dimension at a specific column.

Parameters

string

$pColumn

String index of the column

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 1337 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pColumn = strtoupper($pColumn);
 
        // Fetch dimensions
        if (!isset($this->_columnDimensions[$pColumn])) {
                        if (!$create)
                                return NULL;
            $this->_columnDimensions[$pColumn] = new PHPExcel_Worksheet_ColumnDimension($pColumn);
 
            if (PHPExcel_Cell::columnIndexFromString($this->_cachedHighestColumn) < PHPExcel_Cell::columnIndexFromString($pColumn))
                $this->_cachedHighestColumn = $pColumn;
        }
        return $this->_columnDimensions[$pColumn];
    }

References PHPExcel_Cell\columnIndexFromString().

Referenced by _createNewCell(), calculateColumnWidths(), and getColumnDimensionByColumn().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumnDimensionByColumn()

PHPExcel_Worksheet::getColumnDimensionByColumn

(

$pColumn = 0

)

Get column dimension at a specific column by using numeric cell coordinates.

Parameters

string

$pColumn

Numeric column coordinate of the cell

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 1360 of file Worksheet.php.

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

References getColumnDimension(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

getColumnDimensions()

PHPExcel_Worksheet::getColumnDimensions

(

)

Get collection of column dimensions.

Returns

PHPExcel_Worksheet_ColumnDimension[]

Definition at line 534 of file Worksheet.php.

    {
        return $this->_columnDimensions;
    }

References $_columnDimensions.

Referenced by calculateColumnWidths(), and refreshColumnDimensions().

Here is the caller graph for this function:

getColumnIterator()

PHPExcel_Worksheet::getColumnIterator	(		$startColumn = 'A',
			$endColumn = null
	)

Get column iterator.

Parameters

string	$startColumn	The column address at which to start iterating
string	$endColumn	The column address at which to stop iterating

Returns

PHPExcel_Worksheet_ColumnIterator

Definition at line 2579 of file Worksheet.php.

                                                                                 {
        return new PHPExcel_Worksheet_ColumnIterator($this, $startColumn, $endColumn);
    }

getComment()

PHPExcel_Worksheet::getComment

(

$pCellCoordinate = 'A1'

)

Get comment for cell.

Parameters

string

$pCellCoordinate

Cell coordinate to get comment for

Returns

PHPExcel_Comment

Exceptions

PHPExcel_Exception

Definition at line 2250 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pCellCoordinate = strtoupper($pCellCoordinate);
 
        if (strpos($pCellCoordinate,':') !== false || strpos($pCellCoordinate,',') !== false) {
            throw new PHPExcel_Exception('Cell coordinate string can not be a range of cells.');
        } else if (strpos($pCellCoordinate,'$') !== false) {
            throw new PHPExcel_Exception('Cell coordinate string must not be absolute.');
        } else if ($pCellCoordinate == '') {
            throw new PHPExcel_Exception('Cell coordinate can not be zero-length string.');
        } else {
            // Check if we already have a comment for this cell.
            // If not, create a new comment.
            if (isset($this->_comments[$pCellCoordinate])) {
                return $this->_comments[$pCellCoordinate];
            } else {
                $newComment = new PHPExcel_Comment();
                $this->_comments[$pCellCoordinate] = $newComment;
                return $newComment;
            }
        }
    }

Referenced by getCommentByColumnAndRow().

Here is the caller graph for this function:

getCommentByColumnAndRow()

PHPExcel_Worksheet::getCommentByColumnAndRow	(		$pColumn = 0,
			$pRow = 1
	)

Get comment for cell by using numeric cell coordinates.

Parameters

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

Returns

PHPExcel_Comment

Definition at line 2281 of file Worksheet.php.

    {
        return $this->getComment(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
    }

References getComment(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

getComments()

PHPExcel_Worksheet::getComments

(

)

Get comments.

Returns

PHPExcel_Comment[]

Definition at line 2225 of file Worksheet.php.

    {
        return $this->_comments;
    }

References $_comments.

getConditionalStyles()

PHPExcel_Worksheet::getConditionalStyles

(

$pCoordinate = 'A1'

)

Get conditional styles for a cell.

Parameters

string

$pCoordinate

Returns

PHPExcel_Style_Conditional[]

Definition at line 1430 of file Worksheet.php.

    {
        $pCoordinate = strtoupper($pCoordinate);
        if (!isset($this->_conditionalStylesCollection[$pCoordinate])) {
            $this->_conditionalStylesCollection[$pCoordinate] = array();
        }
        return $this->_conditionalStylesCollection[$pCoordinate];
    }

getConditionalStylesCollection()

PHPExcel_Worksheet::getConditionalStylesCollection

(

)

Get collection of conditional styles.

Returns

array

Definition at line 1470 of file Worksheet.php.

    {
        return $this->_conditionalStylesCollection;
    }

References $_conditionalStylesCollection.

getDataValidation()

PHPExcel_Worksheet::getDataValidation

(

$pCellCoordinate = 'A1'

)

Get data validation.

Parameters

string

$pCellCoordinate

Cell coordinate to get data validation for

Definition at line 2729 of file Worksheet.php.

    {
        // return data validation if we already have one
        if (isset($this->_dataValidationCollection[$pCellCoordinate])) {
            return $this->_dataValidationCollection[$pCellCoordinate];
        }
 
        // else create data validation
        $this->_dataValidationCollection[$pCellCoordinate] = new PHPExcel_Cell_DataValidation();
        return $this->_dataValidationCollection[$pCellCoordinate];
    }

getDataValidationCollection()

PHPExcel_Worksheet::getDataValidationCollection

(

)

Get collection of data validations.

Returns

PHPExcel_Cell_DataValidation[]

Definition at line 2774 of file Worksheet.php.

    {
        return $this->_dataValidationCollection;
    }

References $_dataValidationCollection.

getDefaultColumnDimension()

PHPExcel_Worksheet::getDefaultColumnDimension

(

)

Get default column dimension.

Returns

PHPExcel_Worksheet_ColumnDimension

Definition at line 544 of file Worksheet.php.

    {
        return $this->_defaultColumnDimension;
    }

References $_defaultColumnDimension.

Referenced by calculateColumnWidths().

Here is the caller graph for this function:

getDefaultRowDimension()

PHPExcel_Worksheet::getDefaultRowDimension

(

)

Get default row dimension.

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 524 of file Worksheet.php.

    {
        return $this->_defaultRowDimension;
    }

References $_defaultRowDimension.

getDefaultStyle()

PHPExcel_Worksheet::getDefaultStyle

(

)

Get default style of workbook.

Deprecated:

Returns

PHPExcel_Style

Exceptions

PHPExcel_Exception

Definition at line 1382 of file Worksheet.php.

    {
        return $this->_parent->getDefaultStyle();
    }

getDrawingCollection()

PHPExcel_Worksheet::getDrawingCollection

(

)

Get collection of drawings.

Returns

PHPExcel_Worksheet_BaseDrawing[]

Definition at line 554 of file Worksheet.php.

    {
        return $this->_drawingCollection;
    }

References $_drawingCollection.

Referenced by PHPExcel_Writer_HTML\_extendRowsForChartsAndImages(), and PHPExcel_Writer_HTML\_writeImageInCell().

Here is the caller graph for this function:

getFreezePane()

PHPExcel_Worksheet::getFreezePane

(

)

Get Freeze Pane.

Returns

string

Definition at line 1952 of file Worksheet.php.

    {
        return $this->_freezePane;
    }

References $_freezePane.

getHashCode()

PHPExcel_Worksheet::getHashCode

(

)

Get hash code.

Returns

string Hash code

Implements PHPExcel_IComparable.

Definition at line 2632 of file Worksheet.php.

                                      {
        if ($this->_dirty) {
            $this->_hash = md5( $this->_title .
                                $this->_autoFilter .
                                ($this->_protection->isProtectionEnabled() ? 't' : 'f') .
                                __CLASS__
                              );
            $this->_dirty = false;
        }
        return $this->_hash;
    }

References $_hash.

Referenced by cellExists(), and PHPExcel\getIndex().

Here is the caller graph for this function:

getHeaderFooter()

PHPExcel_Worksheet::getHeaderFooter

(

)

Get page header/footer.

Returns

PHPExcel_Worksheet_HeaderFooter

Definition at line 958 of file Worksheet.php.

    {
        return $this->_headerFooter;
    }

References $_headerFooter.

getHighestColumn()

PHPExcel_Worksheet::getHighestColumn

(

$row = null

)

Get highest worksheet column.

Parameters

string

$row

Return the data highest column for the specified row, or the highest column of any row if no row number is passed

Returns

string Highest column name

Definition at line 1028 of file Worksheet.php.

    {
        if ($row == null) {
            return $this->_cachedHighestColumn;
        }
        return $this->getHighestDataColumn($row);
    }

References $_cachedHighestColumn, $row, and getHighestDataColumn().

Referenced by calculateWorksheetDimension(), shrinkRangeToFit(), and toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

getHighestDataColumn()

PHPExcel_Worksheet::getHighestDataColumn

(

$row = null

)

Get highest worksheet column that contains data.

Parameters

string

$row

Return the highest data column for the specified row, or the highest data column of any row if no row number is passed

Returns

string Highest column name that contains data

Definition at line 1043 of file Worksheet.php.

    {
        return $this->_cellCollection->getHighestColumn($row);
    }

References $row.

Referenced by calculateWorksheetDataDimension(), getHighestColumn(), and removeColumn().

Here is the caller graph for this function:

getHighestDataRow()

PHPExcel_Worksheet::getHighestDataRow

(

$column = null

)

Get highest worksheet row that contains data.

Parameters

string

$column

Return the highest data row for the specified column, or the highest data row of any column if no column letter is passed

Returns

string Highest row number that contains data

Definition at line 1070 of file Worksheet.php.

    {
        return $this->_cellCollection->getHighestRow($column);
    }

References $column.

Referenced by calculateWorksheetDataDimension(), getHighestRow(), and removeRow().

Here is the caller graph for this function:

getHighestRow()

PHPExcel_Worksheet::getHighestRow

(

$column = null

)

Get highest worksheet row.

Parameters

string

$column

Return the highest data row for the specified column, or the highest row of any column if no column letter is passed

Returns

int Highest row number

Definition at line 1055 of file Worksheet.php.

    {
        if ($column == null) {
            return $this->_cachedHighestRow;
        }
        return $this->getHighestDataRow($column);
    }

References $_cachedHighestRow, $column, and getHighestDataRow().

Referenced by calculateWorksheetDimension(), shrinkRangeToFit(), and toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

getHighestRowAndColumn()

PHPExcel_Worksheet::getHighestRowAndColumn

(

)

Get highest worksheet column and highest row that have cell records.

Returns

array Highest column name and highest row number

Definition at line 1080 of file Worksheet.php.

    {
        return $this->_cellCollection->getHighestRowAndColumn();
    }

getHyperlink()

PHPExcel_Worksheet::getHyperlink

(

$pCellCoordinate = 'A1'

)

Get hyperlink.

Parameters

string

$pCellCoordinate

Cell coordinate to get hyperlink for

Definition at line 2674 of file Worksheet.php.

    {
        // return hyperlink if we already have one
        if (isset($this->_hyperlinkCollection[$pCellCoordinate])) {
            return $this->_hyperlinkCollection[$pCellCoordinate];
        }
 
        // else create hyperlink
        $this->_hyperlinkCollection[$pCellCoordinate] = new PHPExcel_Cell_Hyperlink();
        return $this->_hyperlinkCollection[$pCellCoordinate];
    }

Referenced by PHPExcel_Writer_HTML\_generateRow().

Here is the caller graph for this function:

getHyperlinkCollection()

PHPExcel_Worksheet::getHyperlinkCollection

(

)

Get collection of hyperlinks.

Returns

PHPExcel_Cell_Hyperlink[]

Definition at line 2719 of file Worksheet.php.

    {
        return $this->_hyperlinkCollection;
    }

References $_hyperlinkCollection.

getInvalidCharacters()

static PHPExcel_Worksheet::getInvalidCharacters ( )

static

Get array of invalid characters for sheet title.

Returns

array

Definition at line 423 of file Worksheet.php.

    {
        return self::$_invalidCharacters;
    }

References $_invalidCharacters.

getMergeCells()

PHPExcel_Worksheet::getMergeCells

(

)

Get merge cells array.

Returns

array[]

Definition at line 1781 of file Worksheet.php.

    {
        return $this->_mergeCells;
    }

References $_mergeCells.

Referenced by calculateColumnWidths().

Here is the caller graph for this function:

getPageMargins()

PHPExcel_Worksheet::getPageMargins

(

)

Get page margins.

Returns

PHPExcel_Worksheet_PageMargins

Definition at line 936 of file Worksheet.php.

    {
        return $this->_pageMargins;
    }

References $_pageMargins.

Referenced by PHPExcel_Writer_HTML\_setMargins().

Here is the caller graph for this function:

getPageSetup()

PHPExcel_Worksheet::getPageSetup

(

)

Get page setup.

Returns

PHPExcel_Worksheet_PageSetup

Definition at line 914 of file Worksheet.php.

    {
        return $this->_pageSetup;
    }

References $_pageSetup.

getParent()

PHPExcel_Worksheet::getParent

(

)

Get parent.

Returns

PHPExcel

Definition at line 786 of file Worksheet.php.

                                    {
        return $this->_parent;
    }

References $_parent.

Referenced by PHPExcel_Writer_HTML\_generateRow(), PHPExcel\addExternalSheet(), PHPExcel\addSheet(), PHPExcel_NamedRange\resolveRange(), and setCodeName().

Here is the caller graph for this function:

getPrintGridlines()

PHPExcel_Worksheet::getPrintGridlines

(

)

Print gridlines?

Returns

boolean

Definition at line 2145 of file Worksheet.php.

                                        {
        return $this->_printGridlines;
    }

References $_printGridlines.

getProtectedCells()

PHPExcel_Worksheet::getProtectedCells

(

)

Get protected cells.

Returns

array[]

Definition at line 1882 of file Worksheet.php.

    {
        return $this->_protectedCells;
    }

References $_protectedCells.

getProtection()

PHPExcel_Worksheet::getProtection

(

)

Get Protection.

Returns

PHPExcel_Worksheet_Protection

Definition at line 1002 of file Worksheet.php.

    {
        return $this->_protection;
    }

References $_protection.

getRightToLeft()

PHPExcel_Worksheet::getRightToLeft

(

)

Get right-to-left.

Returns

boolean

Definition at line 2380 of file Worksheet.php.

                                     {
        return $this->_rightToLeft;
    }

References $_rightToLeft.

getRowDimension()

PHPExcel_Worksheet::getRowDimension	(		$pRow = 1,
			$create = TRUE
	)

Get row dimension at a specific row.

Parameters

int

$pRow

Numeric index of the row

Returns

PHPExcel_Worksheet_RowDimension

Definition at line 1315 of file Worksheet.php.

    {
        // Found
        $found = null;
 
        // Get row dimension
        if (!isset($this->_rowDimensions[$pRow])) {
                        if (!$create)
                                return NULL;
            $this->_rowDimensions[$pRow] = new PHPExcel_Worksheet_RowDimension($pRow);
 
            $this->_cachedHighestRow = max($this->_cachedHighestRow,$pRow);
        }
        return $this->_rowDimensions[$pRow];
    }

Referenced by _createNewCell().

Here is the caller graph for this function:

getRowDimensions()

PHPExcel_Worksheet::getRowDimensions

(

)

Get collection of row dimensions.

Returns

PHPExcel_Worksheet_RowDimension[]

Definition at line 514 of file Worksheet.php.

    {
        return $this->_rowDimensions;
    }

References $_rowDimensions.

Referenced by refreshRowDimensions().

Here is the caller graph for this function:

getRowIterator()

PHPExcel_Worksheet::getRowIterator	(		$startRow = 1,
			$endRow = null
	)

Get row iterator.

Parameters

integer	$startRow	The row number at which to start iterating
integer	$endRow	The row number at which to stop iterating

Returns

PHPExcel_Worksheet_RowIterator

Definition at line 2567 of file Worksheet.php.

                                                                      {
        return new PHPExcel_Worksheet_RowIterator($this, $startRow, $endRow);
    }

Referenced by PHPExcel_Writer_OpenDocument_Content\_writeRows().

Here is the caller graph for this function:

getSelectedCell()

PHPExcel_Worksheet::getSelectedCell

(

)

Get selected cell.

Deprecated:

Returns

string

Definition at line 2292 of file Worksheet.php.

    {
        return $this->getSelectedCells();
    }

References getSelectedCells().

Here is the call graph for this function:

getSelectedCells()

PHPExcel_Worksheet::getSelectedCells

(

)

Get selected cells.

Returns

string

Definition at line 2312 of file Worksheet.php.

    {
        return $this->_selectedCells;
    }

References $_selectedCells.

Referenced by getSelectedCell().

Here is the caller graph for this function:

getSheetState()

PHPExcel_Worksheet::getSheetState

(

)

Get sheet state.

Returns

string Sheet state (visible, hidden, veryHidden)

Definition at line 894 of file Worksheet.php.

                                        {
        return $this->_sheetState;
    }

References $_sheetState.

getSheetView()

PHPExcel_Worksheet::getSheetView

(

)

Get sheet view.

Returns

PHPExcel_Worksheet_SheetView

Definition at line 980 of file Worksheet.php.

    {
        return $this->_sheetView;
    }

References $_sheetView.

getShowGridlines()

PHPExcel_Worksheet::getShowGridlines

(

)

Show gridlines?

Returns

boolean

Definition at line 2125 of file Worksheet.php.

                                       {
        return $this->_showGridlines;
    }

References $_showGridlines.

getShowRowColHeaders()

PHPExcel_Worksheet::getShowRowColHeaders

(

)

Show row and column headers?

Returns

boolean

Definition at line 2165 of file Worksheet.php.

                                           {
        return $this->_showRowColHeaders;
    }

References $_showRowColHeaders.

getShowSummaryBelow()

PHPExcel_Worksheet::getShowSummaryBelow

(

)

Show summary below? (Row/Column outlining)

Returns

boolean

Definition at line 2185 of file Worksheet.php.

                                          {
        return $this->_showSummaryBelow;
    }

References $_showSummaryBelow.

getShowSummaryRight()

PHPExcel_Worksheet::getShowSummaryRight

(

)

Show summary right? (Row/Column outlining)

Returns

boolean

Definition at line 2205 of file Worksheet.php.

                                          {
        return $this->_showSummaryRight;
    }

References $_showSummaryRight.

getStyle()

PHPExcel_Worksheet::getStyle

(

$pCellCoordinate = 'A1'

)

Get style for cell.

Parameters

string

$pCellCoordinate

Cell coordinate (or range) to get style for

Returns

PHPExcel_Style

Exceptions

PHPExcel_Exception

Definition at line 1413 of file Worksheet.php.

    {
        // set this sheet as active
        $this->_parent->setActiveSheetIndex($this->_parent->getIndex($this));
 
        // set cell coordinate as active
        $this->setSelectedCells(strtoupper($pCellCoordinate));
 
        return $this->_parent->getCellXfSupervisor();
    }

References setSelectedCells().

Referenced by duplicateStyleArray(), and getStyleByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

getStyleByColumnAndRow()

PHPExcel_Worksheet::getStyleByColumnAndRow	(		$pColumn = 0,
			$pRow = 1,
			$pColumn2 = null,
			$pRow2 = null
	)

Get style for cell by using numeric cell coordinates.

Parameters

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell
	int	pColumn2 Numeric column coordinate of the range cell
	int	pRow2 Numeric row coordinate of the range cell

Returns

PHPExcel_Style

Definition at line 1497 of file Worksheet.php.

    {
        if (!is_null($pColumn2) && !is_null($pRow2)) {
                    $cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow . ':' . 
                PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
                    return $this->getStyle($cellRange);
            }
 
        return $this->getStyle(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
    }

References getStyle(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

getStyles()

PHPExcel_Worksheet::getStyles

(

)

Get styles.

Returns

PHPExcel_Style[]

Definition at line 1370 of file Worksheet.php.

    {
        return $this->_styles;
    }

References $_styles.

getTabColor()

PHPExcel_Worksheet::getTabColor

(

)

Get tab color.

Returns

PHPExcel_Style_Color

Definition at line 2811 of file Worksheet.php.

    {
        if ($this->_tabColor === NULL)
            $this->_tabColor = new PHPExcel_Style_Color();
 
        return $this->_tabColor;
    }

References $_tabColor.

getTitle()

PHPExcel_Worksheet::getTitle

(

)

Get title.

Returns

string

Definition at line 817 of file Worksheet.php.

    {
        return $this->_title;
    }

References $_title.

Referenced by __construct(), PHPExcel\addExternalSheet(), PHPExcel\addSheet(), and setTitle().

Here is the caller graph for this function:

hasCodeName()

PHPExcel_Worksheet::hasCodeName

(

)

Sheet has a code name ?

Returns

boolean

Definition at line 2942 of file Worksheet.php.

                                     {
                return !(is_null($this->_codeName));
        }

hyperlinkExists()

PHPExcel_Worksheet::hyperlinkExists

(

$pCoordinate = 'A1'

)

Hyperlink at a specific coordinate exists?

Parameters

string

$pCoordinate

Returns

boolean

Definition at line 2709 of file Worksheet.php.

    {
        return isset($this->_hyperlinkCollection[$pCoordinate]);
    }

Referenced by PHPExcel_Writer_HTML\_generateRow().

Here is the caller graph for this function:

insertNewColumnBefore()

PHPExcel_Worksheet::insertNewColumnBefore	(		$pBefore = 'A',
			$pNumCols = 1
	)

Insert a new column, updating all possible related data.

Parameters

int	$pBefore	Insert before this one
int	$pNumCols	Number of columns to insert

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2031 of file Worksheet.php.

                                                                         {
        if (!is_numeric($pBefore)) {
            $objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
            $objReferenceHelper->insertNewBefore($pBefore . '1', $pNumCols, 0, $this);
        } else {
            throw new PHPExcel_Exception("Column references should not be numeric.");
        }
        return $this;
    }

References PHPExcel_ReferenceHelper\getInstance().

Referenced by insertNewColumnBeforeByIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewColumnBeforeByIndex()

PHPExcel_Worksheet::insertNewColumnBeforeByIndex	(		$pBefore = 0,
			$pNumCols = 1
	)

Insert a new column, updating all possible related data.

Parameters

int	$pBefore	Insert before this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to insert

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2049 of file Worksheet.php.

                                                                              {
        if ($pBefore >= 0) {
            return $this->insertNewColumnBefore(PHPExcel_Cell::stringFromColumnIndex($pBefore), $pNumCols);
        } else {
            throw new PHPExcel_Exception("Columns can only be inserted before at least column A (0).");
        }
    }

References insertNewColumnBefore(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

insertNewRowBefore()

PHPExcel_Worksheet::insertNewRowBefore	(		$pBefore = 1,
			$pNumRows = 1
	)

Insert a new row, updating all possible related data.

Parameters

int	$pBefore	Insert before this one
int	$pNumRows	Number of rows to insert

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2013 of file Worksheet.php.

                                                                    {
        if ($pBefore >= 1) {
            $objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
            $objReferenceHelper->insertNewBefore('A' . $pBefore, 0, $pNumRows, $this);
        } else {
            throw new PHPExcel_Exception("Rows can only be inserted before at least row 1.");
        }
        return $this;
    }

References PHPExcel_ReferenceHelper\getInstance().

Here is the call graph for this function:

isTabColorSet()

PHPExcel_Worksheet::isTabColorSet

(

)

Tab color set?

Returns

boolean

Definition at line 2837 of file Worksheet.php.

    {
        return ($this->_tabColor !== NULL);
    }

mergeCells()

PHPExcel_Worksheet::mergeCells

(

$pRange = 'A1:A1'

)

Set merge on a cell range.

Parameters

string

$pRange

Cell range (e.g. A1:E1)

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1687 of file Worksheet.php.

                                            :A1')
    {
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        if (strpos($pRange,':') !== false) {
            $this->_mergeCells[$pRange] = $pRange;
 
            // make sure cells are created
 
            // get the cells in the range
            $aReferences = PHPExcel_Cell::extractAllCellReferencesInRange($pRange);
 
            // create upper left cell if it does not already exist
            $upperLeft = $aReferences[0];
            if (!$this->cellExists($upperLeft)) {
                $this->getCell($upperLeft)->setValueExplicit(null, PHPExcel_Cell_DataType::TYPE_NULL);
            }
 
            // create or blank out the rest of the cells in the range
            $count = count($aReferences);
            for ($i = 1; $i < $count; $i++) {
                $this->getCell($aReferences[$i])->setValueExplicit(null, PHPExcel_Cell_DataType::TYPE_NULL);
            }
 
        } else {
            throw new PHPExcel_Exception('Merge must be set on a range of cells.');
        }
 
        return $this;
    }

References cellExists(), PHPExcel_Cell\extractAllCellReferencesInRange(), getCell(), and PHPExcel_Cell_DataType\TYPE_NULL.

Referenced by mergeCellsByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

mergeCellsByColumnAndRow()

PHPExcel_Worksheet::mergeCellsByColumnAndRow	(		$pColumn1 = 0,
			$pRow1 = 1,
			$pColumn2 = 0,
			$pRow2 = 1
	)

Set merge on a cell range by using numeric cell coordinates.

Parameters

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1729 of file Worksheet.php.

    {
        $cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
        return $this->mergeCells($cellRange);
    }

References mergeCells(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

namedRangeToArray()

PHPExcel_Worksheet::namedRangeToArray	(		$pNamedRange = '',
			$nullValue = null,
			$calculateFormulas = true,
			$formatData = true,
			$returnCellRef = false
	)

Create array from a range of cells.

Parameters

string	$pNamedRange	Name of the Named Range
mixed	$nullValue	Value returned in the array entry if a cell doesn't exist
boolean	$calculateFormulas	Should formulas be calculated?
boolean	$formatData	Should formatting be applied to cell values?
boolean	$returnCellRef	False - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs

Returns

array

Exceptions

PHPExcel_Exception

Definition at line 2523 of file Worksheet.php.

                                                                                                                                                       {
        $namedRange = PHPExcel_NamedRange::resolveRange($pNamedRange, $this);
        if ($namedRange !== NULL) {
            $pWorkSheet = $namedRange->getWorksheet();
            $pCellRange = $namedRange->getRange();
 
                        return $pWorkSheet->rangeToArray(       $pCellRange,
                                                                                                $nullValue, $calculateFormulas, $formatData, $returnCellRef);
        }
 
        throw new PHPExcel_Exception('Named Range '.$pNamedRange.' does not exist.');
    }

References PHPExcel_NamedRange\resolveRange().

Here is the call graph for this function:

protectCells()

PHPExcel_Worksheet::protectCells	(		$pRange = 'A1',
			$pPassword = '',
			$pAlreadyHashed = false
	)

Set protection on a cell range.

Parameters

string	$pRange	Cell (e.g. A1) or cell range (e.g. A1:E1)
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1808 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        if (!$pAlreadyHashed) {
            $pPassword = PHPExcel_Shared_PasswordHasher::hashPassword($pPassword);
        }
        $this->_protectedCells[$pRange] = $pPassword;
 
        return $this;
    }

References PHPExcel_Shared_PasswordHasher\hashPassword().

Referenced by protectCellsByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

protectCellsByColumnAndRow()

PHPExcel_Worksheet::protectCellsByColumnAndRow	(		$pColumn1 = 0,
			$pRow1 = 1,
			$pColumn2 = 0,
			$pRow2 = 1,
			$pPassword = '',
			$pAlreadyHashed = false
	)

Set protection on a cell range by using numeric cell coordinates.

Parameters

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1833 of file Worksheet.php.

    {
        $cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
        return $this->protectCells($cellRange, $pPassword, $pAlreadyHashed);
    }

References protectCells(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

rangeToArray()

PHPExcel_Worksheet::rangeToArray	(		$pRange = 'A1',
			$nullValue = null,
			$calculateFormulas = true,
			$formatData = true,
			$returnCellRef = false
	)

Create array from a range of cells.

Parameters

string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
mixed	$nullValue	Value returned in the array entry if a cell doesn't exist
boolean	$calculateFormulas	Should formulas be calculated?
boolean	$formatData	Should formatting be applied to cell values?
boolean	$returnCellRef	False - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs

Returns

array

Definition at line 2451 of file Worksheet.php.

                                                                                                                                               {
        // Returnvalue
        $returnValue = array();
        //    Identify the range that we need to extract from the worksheet
        list($rangeStart, $rangeEnd) = PHPExcel_Cell::rangeBoundaries($pRange);
        $minCol = PHPExcel_Cell::stringFromColumnIndex($rangeStart[0] -1);
        $minRow = $rangeStart[1];
        $maxCol = PHPExcel_Cell::stringFromColumnIndex($rangeEnd[0] -1);
        $maxRow = $rangeEnd[1];
 
        $maxCol++;
        // Loop through rows
        $r = -1;
        for ($row = $minRow; $row <= $maxRow; ++$row) {
            $rRef = ($returnCellRef) ? $row : ++$r;
            $c = -1;
            // Loop through columns in the current row
            for ($col = $minCol; $col != $maxCol; ++$col) {
                $cRef = ($returnCellRef) ? $col : ++$c;
                //    Using getCell() will create a new cell if it doesn't already exist. We don't want that to happen
                //        so we test and retrieve directly against _cellCollection
                if ($this->_cellCollection->isDataSet($col.$row)) {
                    // Cell exists
                    $cell = $this->_cellCollection->getCacheData($col.$row);
                    if ($cell->getValue() !== null) {
                        if ($cell->getValue() instanceof PHPExcel_RichText) {
                            $returnValue[$rRef][$cRef] = $cell->getValue()->getPlainText();
                        } else {
                            if ($calculateFormulas) {
                                $returnValue[$rRef][$cRef] = $cell->getCalculatedValue();
                            } else {
                                $returnValue[$rRef][$cRef] = $cell->getValue();
                            }
                        }
 
                        if ($formatData) {
                            $style = $this->_parent->getCellXfByIndex($cell->getXfIndex());
                            $returnValue[$rRef][$cRef] = PHPExcel_Style_NumberFormat::toFormattedString(
                                $returnValue[$rRef][$cRef],
                                                                ($style && $style->getNumberFormat()) ?
                                                                        $style->getNumberFormat()->getFormatCode() :
                                                                        PHPExcel_Style_NumberFormat::FORMAT_GENERAL
                            );
                        }
                    } else {
                        // Cell holds a NULL
                        $returnValue[$rRef][$cRef] = $nullValue;
                    }
                } else {
                    // Cell doesn't exist
                    $returnValue[$rRef][$cRef] = $nullValue;
                }
            }
        }
 
        // Return
        return $returnValue;
    }

References $r, $row, $style, PHPExcel_Style_NumberFormat\FORMAT_GENERAL, PHPExcel_Cell\rangeBoundaries(), PHPExcel_Cell\stringFromColumnIndex(), and PHPExcel_Style_NumberFormat\toFormattedString().

Referenced by toArray().

Here is the call graph for this function:

Here is the caller graph for this function:

rebindParent()

PHPExcel_Worksheet::rebindParent

(

PHPExcel

$parent

)

Re-bind parent.

Parameters

PHPExcel

$parent

Returns

PHPExcel_Worksheet

Definition at line 796 of file Worksheet.php.

                                                       {
        if ($this->_parent !== null) {
            $namedRanges = $this->_parent->getNamedRanges();
            foreach ($namedRanges as $namedRange) {
                $parent->addNamedRange($namedRange);
            }
 
            $this->_parent->removeSheetByIndex(
                $this->_parent->getIndex($this)
            );
        }
        $this->_parent = $parent;
 
        return $this;
    }

References PHPExcel\addNamedRange().

Referenced by PHPExcel\addExternalSheet(), and PHPExcel\addSheet().

Here is the call graph for this function:

Here is the caller graph for this function:

refreshColumnDimensions()

PHPExcel_Worksheet::refreshColumnDimensions

(

)

Refresh column dimensions.

Returns

PHPExcel_Worksheet

Definition at line 663 of file Worksheet.php.

    {
        $currentColumnDimensions = $this->getColumnDimensions();
        $newColumnDimensions = array();
 
        foreach ($currentColumnDimensions as $objColumnDimension) {
            $newColumnDimensions[$objColumnDimension->getColumnIndex()] = $objColumnDimension;
        }
 
        $this->_columnDimensions = $newColumnDimensions;
 
        return $this;
    }

References getColumnDimensions().

Here is the call graph for this function:

refreshRowDimensions()

PHPExcel_Worksheet::refreshRowDimensions

(

)

Refresh row dimensions.

Returns

PHPExcel_Worksheet

Definition at line 682 of file Worksheet.php.

    {
        $currentRowDimensions = $this->getRowDimensions();
        $newRowDimensions = array();
 
        foreach ($currentRowDimensions as $objRowDimension) {
            $newRowDimensions[$objRowDimension->getRowIndex()] = $objRowDimension;
        }
 
        $this->_rowDimensions = $newRowDimensions;
 
        return $this;
    }

References getRowDimensions().

Here is the call graph for this function:

removeAutoFilter()

PHPExcel_Worksheet::removeAutoFilter

(

)

Remove autofilter.

Returns

PHPExcel_Worksheet

Definition at line 1941 of file Worksheet.php.

    {
        $this->_autoFilter->setRange(NULL);
        return $this;
    }

removeColumn()

PHPExcel_Worksheet::removeColumn	(		$pColumn = 'A',
			$pNumCols = 1
	)

Remove a column, updating all possible related data.

Parameters

string	$pColumn	Remove starting with this one
int	$pNumCols	Number of columns to remove

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2088 of file Worksheet.php.

                                                                {
        if (!is_numeric($pColumn)) {
            $highestColumn = $this->getHighestDataColumn();
            $pColumn = PHPExcel_Cell::stringFromColumnIndex(PHPExcel_Cell::columnIndexFromString($pColumn) - 1 + $pNumCols);
            $objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
            $objReferenceHelper->insertNewBefore($pColumn . '1', -$pNumCols, 0, $this);
            for($c = 0; $c < $pNumCols; ++$c) {
                $this->getCellCacheController()->removeColumn($highestColumn);
                $highestColumn = PHPExcel_Cell::stringFromColumnIndex(PHPExcel_Cell::columnIndexFromString($highestColumn) - 2);
            }
        } else {
            throw new PHPExcel_Exception("Column references should not be numeric.");
        }
        return $this;
    }

References PHPExcel_Cell\columnIndexFromString(), getCellCacheController(), getHighestDataColumn(), PHPExcel_ReferenceHelper\getInstance(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by removeColumnByIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

removeColumnByIndex()

PHPExcel_Worksheet::removeColumnByIndex	(		$pColumn = 0,
			$pNumCols = 1
	)

Remove a column, updating all possible related data.

Parameters

int	$pColumn	Remove starting with this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to remove

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2112 of file Worksheet.php.

                                                                     {
        if ($pColumn >= 0) {
            return $this->removeColumn(PHPExcel_Cell::stringFromColumnIndex($pColumn), $pNumCols);
        } else {
            throw new PHPExcel_Exception("Columns to be deleted should at least start from column 0");
        }
    }

References removeColumn(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

removeConditionalStyles()

PHPExcel_Worksheet::removeConditionalStyles

(

$pCoordinate = 'A1'

)

Removes conditional styles for a cell.

Parameters

string

$pCoordinate

Returns

PHPExcel_Worksheet

Definition at line 1459 of file Worksheet.php.

    {
        unset($this->_conditionalStylesCollection[strtoupper($pCoordinate)]);
        return $this;
    }

removeRow()

PHPExcel_Worksheet::removeRow	(		$pRow = 1,
			$pNumRows = 1
	)

Delete a row, updating all possible related data.

Parameters

int	$pRow	Remove starting with this one
int	$pNumRows	Number of rows to remove

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2065 of file Worksheet.php.

                                                        {
        if ($pRow >= 1) {
            $highestRow = $this->getHighestDataRow();
            $objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
            $objReferenceHelper->insertNewBefore('A' . ($pRow + $pNumRows), 0, -$pNumRows, $this);
            for($r = 0; $r < $pNumRows; ++$r) {
                $this->getCellCacheController()->removeRow($highestRow);
                --$highestRow;
            }
        } else {
            throw new PHPExcel_Exception("Rows to be deleted should at least start from row 1.");
        }
        return $this;
    }

References $r, getCellCacheController(), getHighestDataRow(), and PHPExcel_ReferenceHelper\getInstance().

Here is the call graph for this function:

resetTabColor()

PHPExcel_Worksheet::resetTabColor

(

)

Reset tab color.

Returns

PHPExcel_Worksheet

Definition at line 2824 of file Worksheet.php.

    {
        $this->_tabColor = null;
        unset($this->_tabColor);
 
        return $this;
    }

setAutoFilter()

PHPExcel_Worksheet::setAutoFilter

(

$pValue

)

Set AutoFilter.

Parameters

PHPExcel_Worksheet_AutoFilter | string

$pValue

A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1905 of file Worksheet.php.

    {
        $pRange = strtoupper($pValue);
 
        if (is_string($pValue)) {
            $this->_autoFilter->setRange($pValue);
        } elseif(is_object($pValue) && ($pValue instanceof PHPExcel_Worksheet_AutoFilter)) {
            $this->_autoFilter = $pValue;
        }
        return $this;
    }

Referenced by setAutoFilterByColumnAndRow().

Here is the caller graph for this function:

setAutoFilterByColumnAndRow()

PHPExcel_Worksheet::setAutoFilterByColumnAndRow	(		$pColumn1 = 0,
			$pRow1 = 1,
			$pColumn2 = 0,
			$pRow2 = 1
	)

Set Autofilter Range by using numeric cell coordinates.

Parameters

integer	$pColumn1	Numeric column coordinate of the first cell
integer	$pRow1	Numeric row coordinate of the first cell
integer	$pColumn2	Numeric column coordinate of the second cell
integer	$pRow2	Numeric row coordinate of the second cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1927 of file Worksheet.php.

    {
        return $this->setAutoFilter(
            PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1
            . ':' .
            PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2
        );
    }

References setAutoFilter(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

setBreak()

PHPExcel_Worksheet::setBreak	(		$pCell = 'A1',
			$pBreak = PHPExcel_Worksheet::BREAK_NONE
	)

Set break on a cell.

Parameters

string	$pCell	Cell coordinate (e.g. A1)
int	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1637 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pCell = strtoupper($pCell);
 
        if ($pCell != '') {
                if ($pBreak == PHPExcel_Worksheet::BREAK_NONE) {
                        if (isset($this->_breaks[$pCell])) {
                        unset($this->_breaks[$pCell]);
                        }
                } else {
                    $this->_breaks[$pCell] = $pBreak;
                }
        } else {
            throw new PHPExcel_Exception('No cell coordinate specified.');
        }
 
        return $this;
    }

References BREAK_NONE.

Referenced by PHPExcel_ReferenceHelper\_adjustPageBreaks(), and setBreakByColumnAndRow().

Here is the caller graph for this function:

setBreakByColumnAndRow()

PHPExcel_Worksheet::setBreakByColumnAndRow	(		$pColumn = 0,
			$pRow = 1,
			$pBreak = PHPExcel_Worksheet::BREAK_NONE
	)

Set break on a cell by using numeric cell coordinates.

Parameters

integer	$pColumn	Numeric column coordinate of the cell
integer	$pRow	Numeric row coordinate of the cell
integer	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

Returns

PHPExcel_Worksheet

Definition at line 1665 of file Worksheet.php.

    {
        return $this->setBreak(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow, $pBreak);
    }

References setBreak(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

setCellValue()

PHPExcel_Worksheet::setCellValue	(		$pCoordinate = 'A1',
			$pValue = null,
			$returnCell = false
	)

Set a cell value.

Parameters

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell
bool	$returnCell	Return the worksheet (false, default) or the cell (true)

Returns

PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 1093 of file Worksheet.php.

    {
        $cell = $this->getCell(strtoupper($pCoordinate))->setValue($pValue);
        return ($returnCell) ? $cell : $this;
    }

References getCell().

Here is the call graph for this function:

setCellValueByColumnAndRow()

PHPExcel_Worksheet::setCellValueByColumnAndRow	(		$pColumn = 0,
			$pRow = 1,
			$pValue = null,
			$returnCell = false
	)

Set a cell value by using numeric cell coordinates.

Parameters

string	$pColumn	Numeric column coordinate of the cell (A = 0)
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell
bool	$returnCell	Return the worksheet (false, default) or the cell (true)

Returns

PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 1108 of file Worksheet.php.

    {
        $cell = $this->getCellByColumnAndRow($pColumn, $pRow)->setValue($pValue);
        return ($returnCell) ? $cell : $this;
    }

References getCellByColumnAndRow().

Here is the call graph for this function:

setCellValueExplicit()

PHPExcel_Worksheet::setCellValueExplicit	(		$pCoordinate = 'A1',
			$pValue = null,
			$pDataType = PHPExcel_Cell_DataType::TYPE_STRING,
			$returnCell = false
	)

Set a cell value.

Parameters

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type
bool	$returnCell	Return the worksheet (false, default) or the cell (true)

Returns

PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 1123 of file Worksheet.php.

    {
        // Set value
        $cell = $this->getCell(strtoupper($pCoordinate))->setValueExplicit($pValue, $pDataType);
        return ($returnCell) ? $cell : $this;
    }

References getCell().

Here is the call graph for this function:

setCellValueExplicitByColumnAndRow()

PHPExcel_Worksheet::setCellValueExplicitByColumnAndRow	(		$pColumn = 0,
			$pRow = 1,
			$pValue = null,
			$pDataType = PHPExcel_Cell_DataType::TYPE_STRING,
			$returnCell = false
	)

Set a cell value by using numeric cell coordinates.

Parameters

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type
bool	$returnCell	Return the worksheet (false, default) or the cell (true)

Returns

PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 1140 of file Worksheet.php.

    {
        $cell = $this->getCellByColumnAndRow($pColumn, $pRow)->setValueExplicit($pValue, $pDataType);
        return ($returnCell) ? $cell : $this;
    }

References getCellByColumnAndRow().

Here is the call graph for this function:

setCodeName()

PHPExcel_Worksheet::setCodeName

(

$pValue = null

)

Define the code name of the sheet.

Parameters

null|string

Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)

Returns

objWorksheet

Exceptions

PHPExcel_Exception

Definition at line 2887 of file Worksheet.php.

                                                 {
                // Is this a 'rename' or not?
                if ($this->getCodeName() == $pValue) {
                        return $this;
                }
                $pValue = str_replace(' ', '_', $pValue);//Excel does this automatically without flinching, we are doing the same
                // Syntax check
        // throw an exception if not valid
                self::_checkSheetCodeName($pValue);
 
                // We use the same code that setTitle to find a valid codeName else not using a space (Excel don't like) but a '_'
                
        if ($this->getParent()) {
                        // Is there already such sheet name?
                        if ($this->getParent()->sheetCodeNameExists($pValue)) {
                                // Use name, but append with lowest possible integer
 
                                if (PHPExcel_Shared_String::CountCharacters($pValue) > 29) {
                                        $pValue = PHPExcel_Shared_String::Substring($pValue,0,29);
                                }
                                $i = 1;
                                while ($this->getParent()->sheetCodeNameExists($pValue . '_' . $i)) {
                                        ++$i;
                                        if ($i == 10) {
                                                if (PHPExcel_Shared_String::CountCharacters($pValue) > 28) {
                                                        $pValue = PHPExcel_Shared_String::Substring($pValue,0,28);
                                                }
                                        } elseif ($i == 100) {
                                                if (PHPExcel_Shared_String::CountCharacters($pValue) > 27) {
                                                        $pValue = PHPExcel_Shared_String::Substring($pValue,0,27);
                                                }
                                        }
                                }
 
                                $pValue = $pValue . '_' . $i;// ok, we have a valid name
                                //codeName is'nt used in formula : no need to call for an update
                                //return $this->setTitle($altTitle,$updateFormulaCellReferences);
                        }
                }
 
                $this->_codeName=$pValue;
                return $this;
        }

References _checkSheetCodeName(), PHPExcel_Shared_String\CountCharacters(), getCodeName(), getParent(), and PHPExcel_Shared_String\Substring().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setComments()

PHPExcel_Worksheet::setComments

(

$pValue = array()

)

Set comments array for the entire sheet.

@param array of PHPExcel_Comment

Returns

PHPExcel_Worksheet

Definition at line 2236 of file Worksheet.php.

    {
        $this->_comments = $pValue;
 
        return $this;
    }

setConditionalStyles()

PHPExcel_Worksheet::setConditionalStyles	(		$pCoordinate = 'A1',
			$pValue
	)

Set conditional styles.

Parameters

$pCoordinate	string E.g. 'A1'
$pValue	PHPExcel_Style_Conditional[]

Returns

PHPExcel_Worksheet

Definition at line 1482 of file Worksheet.php.

    {
        $this->_conditionalStylesCollection[strtoupper($pCoordinate)] = $pValue;
        return $this;
    }

Referenced by duplicateConditionalStyle().

Here is the caller graph for this function:

setDataValidation()

PHPExcel_Worksheet::setDataValidation	(		$pCellCoordinate = 'A1',
		PHPExcel_Cell_DataValidation	$pDataValidation = null
	)

Set data validation.

Parameters

string	$pCellCoordinate	Cell coordinate to insert data validation
PHPExcel_Cell_DataValidation	$pDataValidation

Returns

PHPExcel_Worksheet

Definition at line 2748 of file Worksheet.php.

    {
        if ($pDataValidation === null) {
            unset($this->_dataValidationCollection[$pCellCoordinate]);
        } else {
            $this->_dataValidationCollection[$pCellCoordinate] = $pDataValidation;
        }
        return $this;
    }

setDefaultStyle()

PHPExcel_Worksheet::setDefaultStyle

(

PHPExcel_Style

$pValue

)

Set default style - should only be used by PHPExcel_IReader implementations!

Deprecated:

Parameters

PHPExcel_Style

$pValue

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1395 of file Worksheet.php.

    {
        $this->_parent->getDefaultStyle()->applyFromArray(array(
            'font' => array(
                'name' => $pValue->getFont()->getName(),
                'size' => $pValue->getFont()->getSize(),
            ),
        ));
        return $this;
    }

References PHPExcel_Style\getFont().

Here is the call graph for this function:

setHeaderFooter()

PHPExcel_Worksheet::setHeaderFooter

(

PHPExcel_Worksheet_HeaderFooter

$pValue

)

Set page header/footer.

Parameters

PHPExcel_Worksheet_HeaderFooter

$pValue

Returns

PHPExcel_Worksheet

Definition at line 969 of file Worksheet.php.

    {
        $this->_headerFooter = $pValue;
        return $this;
    }

setHyperlink()

PHPExcel_Worksheet::setHyperlink	(		$pCellCoordinate = 'A1',
		PHPExcel_Cell_Hyperlink	$pHyperlink = null
	)

Set hyperlnk.

Parameters

string	$pCellCoordinate	Cell coordinate to insert hyperlink
PHPExcel_Cell_Hyperlink	$pHyperlink

Returns

PHPExcel_Worksheet

Definition at line 2693 of file Worksheet.php.

    {
        if ($pHyperlink === null) {
            unset($this->_hyperlinkCollection[$pCellCoordinate]);
        } else {
            $this->_hyperlinkCollection[$pCellCoordinate] = $pHyperlink;
        }
        return $this;
    }

setMergeCells()

PHPExcel_Worksheet::setMergeCells

(

$pValue = array()

)

Set merge cells array for the entire sheet.

Use instead mergeCells() to merge a single cell range.

Parameters

array

Definition at line 1792 of file Worksheet.php.

    {
        $this->_mergeCells = $pValue;
 
        return $this;
    }

setPageMargins()

PHPExcel_Worksheet::setPageMargins

(

PHPExcel_Worksheet_PageMargins

$pValue

)

Set page margins.

Parameters

PHPExcel_Worksheet_PageMargins

$pValue

Returns

PHPExcel_Worksheet

Definition at line 947 of file Worksheet.php.

    {
        $this->_pageMargins = $pValue;
        return $this;
    }

setPageSetup()

PHPExcel_Worksheet::setPageSetup

(

PHPExcel_Worksheet_PageSetup

$pValue

)

Set page setup.

Parameters

PHPExcel_Worksheet_PageSetup

$pValue

Returns

PHPExcel_Worksheet

Definition at line 925 of file Worksheet.php.

    {
        $this->_pageSetup = $pValue;
        return $this;
    }

setPrintGridlines()

PHPExcel_Worksheet::setPrintGridlines

(

$pValue = false

)

Set print gridlines.

Parameters

boolean

$pValue

Print gridlines (true/false)

Returns

PHPExcel_Worksheet

Definition at line 2155 of file Worksheet.php.

                                                       {
        $this->_printGridlines = $pValue;
        return $this;
    }

setProtection()

PHPExcel_Worksheet::setProtection

(

PHPExcel_Worksheet_Protection

$pValue

)

Set Protection.

Parameters

PHPExcel_Worksheet_Protection

$pValue

Returns

PHPExcel_Worksheet

Definition at line 1013 of file Worksheet.php.

    {
        $this->_protection = $pValue;
        $this->_dirty = true;
 
        return $this;
    }

setRightToLeft()

PHPExcel_Worksheet::setRightToLeft

(

$value = false

)

Set right-to-left.

Parameters

boolean

$value

Right-to-left true/false

Returns

PHPExcel_Worksheet

Definition at line 2390 of file Worksheet.php.

                                                   {
        $this->_rightToLeft = $value;
        return $this;
    }

setSelectedCell()

PHPExcel_Worksheet::setSelectedCell

(

$pCoordinate = 'A1'

)

Selected cell.

Parameters

string

$pCoordinate

Cell (i.e. A1)

Returns

PHPExcel_Worksheet

Definition at line 2323 of file Worksheet.php.

    {
        return $this->setSelectedCells($pCoordinate);
    }

References setSelectedCells().

Here is the call graph for this function:

setSelectedCellByColumnAndRow()

PHPExcel_Worksheet::setSelectedCellByColumnAndRow	(		$pColumn = 0,
			$pRow = 1
	)

Selected cell by using numeric cell coordinates.

Parameters

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2370 of file Worksheet.php.

    {
        return $this->setSelectedCells(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
    }

References setSelectedCells(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

setSelectedCells()

PHPExcel_Worksheet::setSelectedCells

(

$pCoordinate = 'A1'

)

Select a range of cells.

Parameters

string

$pCoordinate

Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 2335 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pCoordinate = strtoupper($pCoordinate);
 
        // Convert 'A' to 'A:A'
        $pCoordinate = preg_replace('/^([A-Z]+)$/', '${1}:${1}', $pCoordinate);
 
        // Convert '1' to '1:1'
        $pCoordinate = preg_replace('/^([0-9]+)$/', '${1}:${1}', $pCoordinate);
 
        // Convert 'A:C' to 'A1:C1048576'
        $pCoordinate = preg_replace('/^([A-Z]+):([A-Z]+)$/', '${1}1:${2}1048576', $pCoordinate);
 
        // Convert '1:3' to 'A1:XFD3'
        $pCoordinate = preg_replace('/^([0-9]+):([0-9]+)$/', 'A${1}:XFD${2}', $pCoordinate);
 
        if (strpos($pCoordinate,':') !== false || strpos($pCoordinate,',') !== false) {
            list($first, ) = PHPExcel_Cell::splitRange($pCoordinate);
            $this->_activeCell = $first[0];
        } else {
            $this->_activeCell = $pCoordinate;
        }
        $this->_selectedCells = $pCoordinate;
        return $this;
    }

References PHPExcel_Cell\splitRange().

Referenced by getStyle(), setSelectedCell(), and setSelectedCellByColumnAndRow().

Here is the call graph for this function:

Here is the caller graph for this function:

setSharedStyle()

PHPExcel_Worksheet::setSharedStyle	(	PHPExcel_Style	$pSharedCellStyle = null,
			$pRange = ''
	)

Set shared cell style to a range of cells.

Please note that this will overwrite existing cell styles for cells in range!

Deprecated:

Parameters

PHPExcel_Style	$pSharedCellStyle	Cell style to share
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1519 of file Worksheet.php.

    {
        $this->duplicateStyle($pSharedCellStyle, $pRange);
        return $this;
    }

References duplicateStyle().

Here is the call graph for this function:

setSheetState()

PHPExcel_Worksheet::setSheetState

(

$value = PHPExcel_Worksheet::SHEETSTATE_VISIBLE

)

Set sheet state.

Parameters

string

$value

Sheet state (visible, hidden, veryHidden)

Returns

PHPExcel_Worksheet

Definition at line 904 of file Worksheet.php.

                                                                                     {
        $this->_sheetState = $value;
        return $this;
    }

Referenced by __construct().

Here is the caller graph for this function:

setSheetView()

PHPExcel_Worksheet::setSheetView

(

PHPExcel_Worksheet_SheetView

$pValue

)

Set sheet view.

Parameters

PHPExcel_Worksheet_SheetView

$pValue

Returns

PHPExcel_Worksheet

Definition at line 991 of file Worksheet.php.

    {
        $this->_sheetView = $pValue;
        return $this;
    }

setShowGridlines()

PHPExcel_Worksheet::setShowGridlines

(

$pValue = false

)

Set show gridlines.

Parameters

boolean

$pValue

Show gridlines (true/false)

Returns

PHPExcel_Worksheet

Definition at line 2135 of file Worksheet.php.

                                                      {
        $this->_showGridlines = $pValue;
        return $this;
    }

setShowRowColHeaders()

PHPExcel_Worksheet::setShowRowColHeaders

(

$pValue = false

)

Set show row and column headers.

Parameters

boolean

$pValue

Show row and column headers (true/false)

Returns

PHPExcel_Worksheet

Definition at line 2175 of file Worksheet.php.

                                                          {
        $this->_showRowColHeaders = $pValue;
        return $this;
    }

setShowSummaryBelow()

PHPExcel_Worksheet::setShowSummaryBelow

(

$pValue = true

)

Set show summary below.

Parameters

boolean

$pValue

Show summary below (true/false)

Returns

PHPExcel_Worksheet

Definition at line 2195 of file Worksheet.php.

                                                        {
        $this->_showSummaryBelow = $pValue;
        return $this;
    }

setShowSummaryRight()

PHPExcel_Worksheet::setShowSummaryRight

(

$pValue = true

)

Set show summary right.

Parameters

boolean

$pValue

Show summary right (true/false)

Returns

PHPExcel_Worksheet

Definition at line 2215 of file Worksheet.php.

                                                        {
        $this->_showSummaryRight = $pValue;
        return $this;
    }

setTitle()

PHPExcel_Worksheet::setTitle	(		$pValue = 'Worksheet',
			$updateFormulaCellReferences = true
	)

Set title.

Parameters

string	$pValue	String containing the dimension of this worksheet
string	$updateFormulaCellReferences	boolean Flag indicating whether cell references in formulae should be updated to reflect the new sheet name. This should be left as the default true, unless you are certain that no formula cells on any worksheet contain references to this worksheet

Returns

PHPExcel_Worksheet

Definition at line 833 of file Worksheet.php.

    {
        // Is this a 'rename' or not?
        if ($this->getTitle() == $pValue) {
            return $this;
        }
 
        // Syntax check
        self::_checkSheetTitle($pValue);
 
        // Old title
        $oldTitle = $this->getTitle();
 
        if ($this->_parent) {
            // Is there already such sheet name?
                        if ($this->_parent->sheetNameExists($pValue)) {
                // Use name, but append with lowest possible integer
 
                if (PHPExcel_Shared_String::CountCharacters($pValue) > 29) {
                    $pValue = PHPExcel_Shared_String::Substring($pValue,0,29);
                }
                $i = 1;
                                while ($this->_parent->sheetNameExists($pValue . ' ' . $i)) {
                    ++$i;
                    if ($i == 10) {
                        if (PHPExcel_Shared_String::CountCharacters($pValue) > 28) {
                            $pValue = PHPExcel_Shared_String::Substring($pValue,0,28);
                        }
                    } elseif ($i == 100) {
                        if (PHPExcel_Shared_String::CountCharacters($pValue) > 27) {
                            $pValue = PHPExcel_Shared_String::Substring($pValue,0,27);
                        }
                    }
                }
 
                $altTitle = $pValue . ' ' . $i;
                return $this->setTitle($altTitle,$updateFormulaCellReferences);
            }
        }
 
        // Set title
        $this->_title = $pValue;
        $this->_dirty = true;
 
        if ($this->_parent) {
            // New title
            $newTitle = $this->getTitle();
                        PHPExcel_Calculation::getInstance($this->_parent)
                            ->renameCalculationCacheForWorksheet($oldTitle, $newTitle);
            if ($updateFormulaCellReferences)
                                PHPExcel_ReferenceHelper::getInstance()->updateNamedFormulas($this->_parent, $oldTitle, $newTitle);
        }
 
        return $this;
    }

References _checkSheetTitle(), PHPExcel_Shared_String\CountCharacters(), PHPExcel_ReferenceHelper\getInstance(), PHPExcel_Calculation\getInstance(), getTitle(), setTitle(), and PHPExcel_Shared_String\Substring().

Referenced by __construct(), and setTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

shrinkRangeToFit()

PHPExcel_Worksheet::shrinkRangeToFit

(

$range

)

Accepts a range, returning it as a range that falls within the current highest row and column of the worksheet.

Parameters

string

$range

Returns

string Adjusted range value

Definition at line 2785 of file Worksheet.php.

                                                 {
        $maxCol = $this->getHighestColumn();
        $maxRow = $this->getHighestRow();
        $maxCol = PHPExcel_Cell::columnIndexFromString($maxCol);
 
        $rangeBlocks = explode(' ',$range);
        foreach ($rangeBlocks as &$rangeSet) {
            $rangeBoundaries = PHPExcel_Cell::getRangeBoundaries($rangeSet);
 
            if (PHPExcel_Cell::columnIndexFromString($rangeBoundaries[0][0]) > $maxCol) { $rangeBoundaries[0][0] = PHPExcel_Cell::stringFromColumnIndex($maxCol); }
            if ($rangeBoundaries[0][1] > $maxRow) { $rangeBoundaries[0][1] = $maxRow; }
            if (PHPExcel_Cell::columnIndexFromString($rangeBoundaries[1][0]) > $maxCol) { $rangeBoundaries[1][0] = PHPExcel_Cell::stringFromColumnIndex($maxCol); }
            if ($rangeBoundaries[1][1] > $maxRow) { $rangeBoundaries[1][1] = $maxRow; }
            $rangeSet = $rangeBoundaries[0][0].$rangeBoundaries[0][1].':'.$rangeBoundaries[1][0].$rangeBoundaries[1][1];
        }
        unset($rangeSet);
        $stRange = implode(' ',$rangeBlocks);
 
        return $stRange;
    }

References PHPExcel_Cell\columnIndexFromString(), getHighestColumn(), getHighestRow(), PHPExcel_Cell\getRangeBoundaries(), and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

sortCellCollection()

PHPExcel_Worksheet::sortCellCollection

(

)

Sort collection of cells.

Returns

PHPExcel_Worksheet

Definition at line 501 of file Worksheet.php.

    {
        if ($this->_cellCollection !== NULL) {
            return $this->_cellCollection->getSortedCellList();
        }
        return array();
    }

Referenced by getCellCollection().

Here is the caller graph for this function:

toArray()

PHPExcel_Worksheet::toArray	(		$nullValue = null,
			$calculateFormulas = true,
			$formatData = true,
			$returnCellRef = false
	)

Create array from worksheet.

Parameters

mixed	$nullValue	Value returned in the array entry if a cell doesn't exist
boolean	$calculateFormulas	Should formulas be calculated?
boolean	$formatData	Should formatting be applied to cell values?
boolean	$returnCellRef	False - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs

Returns

array

Definition at line 2547 of file Worksheet.php.

                                                                                                                          {
        // Garbage collect...
        $this->garbageCollect();
 
        //    Identify the range that we need to extract from the worksheet
        $maxCol = $this->getHighestColumn();
        $maxRow = $this->getHighestRow();
        // Return
                return $this->rangeToArray(     'A1:'.$maxCol.$maxRow,
                                                                        $nullValue, $calculateFormulas, $formatData, $returnCellRef);
    }

References garbageCollect(), getHighestColumn(), getHighestRow(), and rangeToArray().

Here is the call graph for this function:

unfreezePane()

PHPExcel_Worksheet::unfreezePane

(

)

Unfreeze Pane.

Returns

PHPExcel_Worksheet

Definition at line 2000 of file Worksheet.php.

    {
        return $this->freezePane('');
    }

References freezePane().

Here is the call graph for this function:

unmergeCells()

PHPExcel_Worksheet::unmergeCells

(

$pRange = 'A1:A1'

)

Remove merge on a cell range.

Parameters

string

$pRange

Cell range (e.g. A1:E1)

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1742 of file Worksheet.php.

                                              :A1')
    {
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        if (strpos($pRange,':') !== false) {
            if (isset($this->_mergeCells[$pRange])) {
                unset($this->_mergeCells[$pRange]);
            } else {
                throw new PHPExcel_Exception('Cell range ' . $pRange . ' not known as merged.');
            }
        } else {
            throw new PHPExcel_Exception('Merge can only be removed from a range of cells.');
        }
 
        return $this;
    }

Referenced by unmergeCellsByColumnAndRow().

Here is the caller graph for this function:

unmergeCellsByColumnAndRow()

PHPExcel_Worksheet::unmergeCellsByColumnAndRow	(		$pColumn1 = 0,
			$pRow1 = 1,
			$pColumn2 = 0,
			$pRow2 = 1
	)

Remove merge on a cell range by using numeric cell coordinates.

Parameters

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1770 of file Worksheet.php.

    {
        $cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
        return $this->unmergeCells($cellRange);
    }

References PHPExcel_Cell\stringFromColumnIndex(), and unmergeCells().

Here is the call graph for this function:

unprotectCells()

PHPExcel_Worksheet::unprotectCells

(

$pRange = 'A1'

)

Remove protection on a cell range.

Parameters

string

$pRange

Cell (e.g. A1) or cell range (e.g. A1:E1)

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1846 of file Worksheet.php.

    {
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        if (isset($this->_protectedCells[$pRange])) {
            unset($this->_protectedCells[$pRange]);
        } else {
            throw new PHPExcel_Exception('Cell range ' . $pRange . ' not known as protected.');
        }
        return $this;
    }

Referenced by unprotectCellsByColumnAndRow().

Here is the caller graph for this function:

unprotectCellsByColumnAndRow()

PHPExcel_Worksheet::unprotectCellsByColumnAndRow	(		$pColumn1 = 0,
			$pRow1 = 1,
			$pColumn2 = 0,
			$pRow2 = 1,
			$pPassword = '',
			$pAlreadyHashed = false
	)

Remove protection on a cell range by using numeric cell coordinates.

Parameters

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet

Definition at line 1871 of file Worksheet.php.

    {
        $cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
        return $this->unprotectCells($cellRange, $pPassword, $pAlreadyHashed);
    }

References PHPExcel_Cell\stringFromColumnIndex(), and unprotectCells().

Here is the call graph for this function:

Field Documentation

$_activeCell

PHPExcel_Worksheet::$_activeCell = 'A1'

private

Definition at line 263 of file Worksheet.php.

Referenced by getActiveCell().

$_autoFilter

PHPExcel_Worksheet::$_autoFilter = NULL

private

Definition at line 207 of file Worksheet.php.

Referenced by __clone(), and getAutoFilter().

$_breaks

PHPExcel_Worksheet::$_breaks = array()

private

Definition at line 186 of file Worksheet.php.

Referenced by getBreaks().

$_cachedHighestColumn

PHPExcel_Worksheet::$_cachedHighestColumn = 'A'

private

Definition at line 277 of file Worksheet.php.

Referenced by getHighestColumn().

$_cachedHighestRow

PHPExcel_Worksheet::$_cachedHighestRow = 1

private

Definition at line 284 of file Worksheet.php.

Referenced by getHighestRow().

$_cellCollection

PHPExcel_Worksheet::$_cellCollection = null

private

Definition at line 67 of file Worksheet.php.

Referenced by __clone(), and getCellCacheController().

$_cellCollectionIsSorted

PHPExcel_Worksheet::$_cellCollectionIsSorted = false

private

Definition at line 179 of file Worksheet.php.

$_chartCollection

PHPExcel_Worksheet::$_chartCollection = array()

private

Definition at line 109 of file Worksheet.php.

Referenced by getChartCollection().

$_codeName

PHPExcel_Worksheet::$_codeName = null

private

Definition at line 333 of file Worksheet.php.

Referenced by getCodeName().

$_columnDimensions

PHPExcel_Worksheet::$_columnDimensions = array()

private

Definition at line 88 of file Worksheet.php.

Referenced by getColumnDimensions().

$_comments

PHPExcel_Worksheet::$_comments = array()

private

Definition at line 256 of file Worksheet.php.

Referenced by getComments().

$_conditionalStylesCollection

PHPExcel_Worksheet::$_conditionalStylesCollection = array()

private

Definition at line 172 of file Worksheet.php.

Referenced by getConditionalStylesCollection().

$_dataValidationCollection

PHPExcel_Worksheet::$_dataValidationCollection = array()

private

Definition at line 305 of file Worksheet.php.

Referenced by getDataValidationCollection().

$_defaultColumnDimension

PHPExcel_Worksheet::$_defaultColumnDimension = null

private

Definition at line 95 of file Worksheet.php.

Referenced by getDefaultColumnDimension().

$_defaultRowDimension

PHPExcel_Worksheet::$_defaultRowDimension = null

private

Definition at line 81 of file Worksheet.php.

Referenced by getDefaultRowDimension().

$_dirty

PHPExcel_Worksheet::$_dirty = true

private

Definition at line 319 of file Worksheet.php.

$_drawingCollection

PHPExcel_Worksheet::$_drawingCollection = null

private

Definition at line 102 of file Worksheet.php.

Referenced by __clone(), and getDrawingCollection().

$_freezePane

PHPExcel_Worksheet::$_freezePane = ''

private

Definition at line 214 of file Worksheet.php.

Referenced by getFreezePane().

$_hash

PHPExcel_Worksheet::$_hash = null

private

Definition at line 326 of file Worksheet.php.

Referenced by getHashCode().

$_headerFooter

PHPExcel_Worksheet::$_headerFooter

private

Definition at line 144 of file Worksheet.php.

Referenced by getHeaderFooter().

$_hyperlinkCollection

PHPExcel_Worksheet::$_hyperlinkCollection = array()

private

Definition at line 298 of file Worksheet.php.

Referenced by getHyperlinkCollection().

$_invalidCharacters

PHPExcel_Worksheet::$_invalidCharacters = array('*', ':', '/', '\\', '?', '[', ']')

staticprivate

Definition at line 53 of file Worksheet.php.

Referenced by getInvalidCharacters().

$_mergeCells

PHPExcel_Worksheet::$_mergeCells = array()

private

Definition at line 193 of file Worksheet.php.

Referenced by getMergeCells().

$_pageMargins

PHPExcel_Worksheet::$_pageMargins

private

Definition at line 137 of file Worksheet.php.

Referenced by getPageMargins().

$_pageSetup

PHPExcel_Worksheet::$_pageSetup

private

Definition at line 130 of file Worksheet.php.

Referenced by getPageSetup().

$_parent

PHPExcel_Worksheet::$_parent

private

Definition at line 60 of file Worksheet.php.

Referenced by duplicateStyle(), and getParent().

$_printGridlines

PHPExcel_Worksheet::$_printGridlines = false

private

Definition at line 228 of file Worksheet.php.

Referenced by getPrintGridlines().

$_protectedCells

PHPExcel_Worksheet::$_protectedCells = array()

private

Definition at line 200 of file Worksheet.php.

Referenced by getProtectedCells().

$_protection

PHPExcel_Worksheet::$_protection

private

Definition at line 158 of file Worksheet.php.

Referenced by getProtection().

$_rightToLeft

PHPExcel_Worksheet::$_rightToLeft = false

private

Definition at line 291 of file Worksheet.php.

Referenced by getRightToLeft().

$_rowDimensions

PHPExcel_Worksheet::$_rowDimensions = array()

private

Definition at line 74 of file Worksheet.php.

Referenced by getRowDimensions().

$_selectedCells

PHPExcel_Worksheet::$_selectedCells = 'A1'

private

Definition at line 270 of file Worksheet.php.

Referenced by getSelectedCells().

$_sheetState

PHPExcel_Worksheet::$_sheetState

private

Definition at line 123 of file Worksheet.php.

Referenced by getSheetState().

$_sheetView

PHPExcel_Worksheet::$_sheetView

private

Definition at line 151 of file Worksheet.php.

Referenced by getSheetView().

$_showGridlines

PHPExcel_Worksheet::$_showGridlines = true

private

Definition at line 221 of file Worksheet.php.

Referenced by getShowGridlines().

$_showRowColHeaders

PHPExcel_Worksheet::$_showRowColHeaders = true

private

Definition at line 235 of file Worksheet.php.

Referenced by getShowRowColHeaders().

$_showSummaryBelow

PHPExcel_Worksheet::$_showSummaryBelow = true

private

Definition at line 242 of file Worksheet.php.

Referenced by getShowSummaryBelow().

$_showSummaryRight

PHPExcel_Worksheet::$_showSummaryRight = true

private

Definition at line 249 of file Worksheet.php.

Referenced by getShowSummaryRight().

$_styles

PHPExcel_Worksheet::$_styles = array()

private

Definition at line 165 of file Worksheet.php.

Referenced by getStyles().

$_tabColor

PHPExcel_Worksheet::$_tabColor

private

Definition at line 312 of file Worksheet.php.

Referenced by getTabColor().

$_title

PHPExcel_Worksheet::$_title

private

Definition at line 116 of file Worksheet.php.

Referenced by getTitle().

BREAK_COLUMN

const PHPExcel_Worksheet::BREAK_COLUMN = 2

Definition at line 41 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readVerticalPageBreaks(), PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), PHPExcel_Writer_Excel2007_Worksheet\_writeBreaks(), and PHPExcel_Reader_Excel2007\load().

BREAK_NONE

const PHPExcel_Worksheet::BREAK_NONE = 0

Definition at line 39 of file Worksheet.php.

Referenced by PHPExcel_ReferenceHelper\_adjustPageBreaks(), PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), and setBreak().

BREAK_ROW

const PHPExcel_Worksheet::BREAK_ROW = 1

Definition at line 40 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readHorizontalPageBreaks(), PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), PHPExcel_Writer_Excel2007_Worksheet\_writeBreaks(), and PHPExcel_Reader_Excel2007\load().

SHEETSTATE_HIDDEN

const PHPExcel_Worksheet::SHEETSTATE_HIDDEN = 'hidden'

Definition at line 45 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readSheet().

SHEETSTATE_VERYHIDDEN

const PHPExcel_Worksheet::SHEETSTATE_VERYHIDDEN = 'veryHidden'

Definition at line 46 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readSheet().

SHEETSTATE_VISIBLE

const PHPExcel_Worksheet::SHEETSTATE_VISIBLE = 'visible'

Definition at line 44 of file Worksheet.php.

Referenced by __construct(), and PHPExcel_Reader_Excel5\_readSheet().

---

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

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