PHPExcel_Worksheet_SheetView Class Reference

Collaboration diagram for PHPExcel_Worksheet_SheetView:

Public Member Functions
	__construct ()
	Create a new PHPExcel_Worksheet_SheetView. More...
	getZoomScale ()
	Get ZoomScale. More...
	setZoomScale ($pValue=100)
	Set ZoomScale. More...
	getZoomScaleNormal ()
	Get ZoomScaleNormal. More...
	setZoomScaleNormal ($pValue=100)
	Set ZoomScale. More...
	getView ()
	Get View. More...
	setView ($pValue=NULL)
	Set View. More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Data Fields
const	SHEETVIEW_NORMAL = 'normal'
const	SHEETVIEW_PAGE_LAYOUT = 'pageLayout'
const	SHEETVIEW_PAGE_BREAK_PREVIEW = 'pageBreakPreview'

Private Attributes
	$_zoomScale = 100
	$_zoomScaleNormal = 100
	$_sheetviewType = self::SHEETVIEW_NORMAL

Static Private Attributes
static	$_sheetViewTypes

Detailed Description

Definition at line 36 of file SheetView.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Worksheet_SheetView::__construct

(

)

Create a new PHPExcel_Worksheet_SheetView.

Definition at line 80 of file SheetView.php.

    {
    }

Member Function Documentation

__clone()

PHPExcel_Worksheet_SheetView::__clone

(

)

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

Definition at line 178 of file SheetView.php.

                                  {
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if (is_object($value)) {
                                $this->$key = clone $value;
                        } else {
                                $this->$key = $value;
                        }
                }
        }

References $key.

getView()

PHPExcel_Worksheet_SheetView::getView

(

)

Get View.

Returns

string

Definition at line 145 of file SheetView.php.

                                  {
                return $this->_sheetviewType;
        }

References $_sheetviewType.

getZoomScale()

PHPExcel_Worksheet_SheetView::getZoomScale

(

)

Get ZoomScale.

Returns

int

Definition at line 89 of file SheetView.php.

                                       {
                return $this->_zoomScale;
        }

References $_zoomScale.

getZoomScaleNormal()

PHPExcel_Worksheet_SheetView::getZoomScaleNormal

(

)

Get ZoomScaleNormal.

Returns

int

Definition at line 118 of file SheetView.php.

                                             {
                return $this->_zoomScaleNormal;
        }

References $_zoomScaleNormal.

setView()

PHPExcel_Worksheet_SheetView::setView

(

$pValue = NULL

)

Set View.

Valid values are 'normal' self::SHEETVIEW_NORMAL 'pageLayout' self::SHEETVIEW_PAGE_LAYOUT 'pageBreakPreview' self::SHEETVIEW_PAGE_BREAK_PREVIEW

Parameters

string

$pValue

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet_SheetView

Definition at line 161 of file SheetView.php.

                                                {
                //      MS Excel 2007 allows setting the view to 'normal', 'pageLayout' or 'pageBreakPreview'
                //              via the user interface
                if ($pValue === NULL)
                        $pValue = self::SHEETVIEW_NORMAL;
                if (in_array($pValue, self::$_sheetViewTypes)) {
                        $this->_sheetviewType = $pValue;
                } else {
                        throw new PHPExcel_Exception("Invalid sheetview layout type.");
                }
 
                return $this;
        }

References SHEETVIEW_NORMAL.

setZoomScale()

PHPExcel_Worksheet_SheetView::setZoomScale

(

$pValue = 100

)

Set ZoomScale.

Valid values range from 10 to 400.

Parameters

int

$pValue

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet_SheetView

Definition at line 102 of file SheetView.php.

                                                    {
                // Microsoft Office Excel 2007 only allows setting a scale between 10 and 400 via the user interface,
                // but it is apparently still able to handle any scale >= 1
                if (($pValue >= 1) || is_null($pValue)) {
                        $this->_zoomScale = $pValue;
                } else {
                        throw new PHPExcel_Exception("Scale must be greater than or equal to 1.");
                }
                return $this;
        }

setZoomScaleNormal()

PHPExcel_Worksheet_SheetView::setZoomScaleNormal

(

$pValue = 100

)

Set ZoomScale.

Valid values range from 10 to 400.

Parameters

int

$pValue

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Worksheet_SheetView

Definition at line 131 of file SheetView.php.

                                                          {
                if (($pValue >= 1) || is_null($pValue)) {
                        $this->_zoomScaleNormal = $pValue;
                } else {
                        throw new PHPExcel_Exception("Scale must be greater than or equal to 1.");
                }
                return $this;
        }

Field Documentation

$_sheetviewType

PHPExcel_Worksheet_SheetView::$_sheetviewType = self::SHEETVIEW_NORMAL

private

Definition at line 75 of file SheetView.php.

Referenced by getView().

$_sheetViewTypes

PHPExcel_Worksheet_SheetView::$_sheetViewTypes

staticprivate

Initial value:

= array(
                self::SHEETVIEW_NORMAL,
                self::SHEETVIEW_PAGE_LAYOUT,
                self::SHEETVIEW_PAGE_BREAK_PREVIEW,
        )

Definition at line 44 of file SheetView.php.

$_zoomScale

PHPExcel_Worksheet_SheetView::$_zoomScale = 100

private

Definition at line 57 of file SheetView.php.

Referenced by getZoomScale().

$_zoomScaleNormal

PHPExcel_Worksheet_SheetView::$_zoomScaleNormal = 100

private

Definition at line 66 of file SheetView.php.

Referenced by getZoomScaleNormal().

SHEETVIEW_NORMAL

const PHPExcel_Worksheet_SheetView::SHEETVIEW_NORMAL = 'normal'

Definition at line 40 of file SheetView.php.

Referenced by PHPExcel_Reader_Excel5\_readWindow2(), PHPExcel_Writer_Excel2007_Worksheet\_writeSheetViews(), and setView().

SHEETVIEW_PAGE_BREAK_PREVIEW

const PHPExcel_Worksheet_SheetView::SHEETVIEW_PAGE_BREAK_PREVIEW = 'pageBreakPreview'

Definition at line 42 of file SheetView.php.

Referenced by PHPExcel_Reader_Excel5\_readWindow2(), and PHPExcel_Writer_Excel5_Worksheet\_writeWindow2().

SHEETVIEW_PAGE_LAYOUT

const PHPExcel_Worksheet_SheetView::SHEETVIEW_PAGE_LAYOUT = 'pageLayout'

Definition at line 41 of file SheetView.php.

Referenced by PHPExcel_Reader_Excel5\_readPageLayoutView(), PHPExcel_Reader_Excel5\_readWindow2(), and PHPExcel_Writer_Excel5_Worksheet\_writePageLayoutView().

---

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

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