Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\SheetView:

Public Member Functions
	__construct ()
	Create a new SheetView. More...

	getZoomScale ()
	Get ZoomScale. More...

	setZoomScale ($pValue)
	Set ZoomScale. More...

	getZoomScaleNormal ()
	Get ZoomScaleNormal. More...

	setZoomScaleNormal ($pValue)
	Set ZoomScale. More...

	setShowZeros ($pValue)
	Set ShowZeroes setting. More...

	getShowZeros ()

	getView ()
	Get View. More...

	setView ($pValue)
	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

	$showZeros = true

	$sheetviewType = self::SHEETVIEW_NORMAL

Static Private Attributes
static	$sheetViewTypes

Detailed Description

Definition at line 7 of file SheetView.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::__construct ( )

Create a new SheetView.

Definition at line 60 of file SheetView.php.

61 {

62 }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::__clone ( )

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

Definition at line 182 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.

◆ getShowZeros()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::getShowZeros ( )

Returns: bool

Definition at line 137 of file SheetView.php.

    {
        return $this->showZeros;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\SheetView\$showZeros.

◆ getView()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::getView ( )

Get View.

Returns: string

Definition at line 147 of file SheetView.php.

    {
        return $this->sheetviewType;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\SheetView\$sheetviewType.

◆ getZoomScale()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::getZoomScale ( )

Get ZoomScale.

Returns: int

Definition at line 69 of file SheetView.php.

    {
        return $this->zoomScale;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\SheetView\$zoomScale.

◆ getZoomScaleNormal()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::getZoomScaleNormal ( )

Get ZoomScaleNormal.

Returns: int

Definition at line 100 of file SheetView.php.

    {
        return $this->zoomScaleNormal;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\SheetView\$zoomScaleNormal.

◆ setShowZeros()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::setShowZeros ( $pValue )

Set ShowZeroes setting.

Parameters

bool $pValue

Definition at line 129 of file SheetView.php.

                                         : void
    {
        $this->showZeros = $pValue;
    }

◆ setView()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::setView ( $pValue )

Set View.

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

Parameters

string $pValue

Returns: $this

Definition at line 164 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 PhpSpreadsheetException('Invalid sheetview layout type.');
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Worksheet\SheetView\SHEETVIEW_NORMAL.

◆ setZoomScale()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::setZoomScale ( $pValue )

Set ZoomScale.

Valid values range from 10 to 400.

Parameters

int $pValue

Returns: $this

Definition at line 82 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) || $pValue === null) {
            $this->zoomScale = $pValue;
        } else {
            throw new PhpSpreadsheetException('Scale must be greater than or equal to 1.');
        }
 
        return $this;
    }

◆ setZoomScaleNormal()

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::setZoomScaleNormal ( $pValue )

Set ZoomScale.

Valid values range from 10 to 400.

Parameters

int $pValue

Returns: $this

Definition at line 113 of file SheetView.php.

    {
        if (($pValue >= 1) || $pValue === null) {
            $this->zoomScaleNormal = $pValue;
        } else {
            throw new PhpSpreadsheetException('Scale must be greater than or equal to 1.');
        }
 
        return $this;
    }

Field Documentation

◆ $sheetviewType

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::$sheetviewType = self::SHEETVIEW_NORMAL

private

Definition at line 55 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\SheetView\getView().

◆ $sheetViewTypes

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::$sheetViewTypes

staticprivate

Initial value:

= [
        self::SHEETVIEW_NORMAL,
        self::SHEETVIEW_PAGE_LAYOUT,
        self::SHEETVIEW_PAGE_BREAK_PREVIEW,
    ]

Definition at line 14 of file SheetView.php.

◆ $showZeros

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::$showZeros = true

private

Definition at line 46 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\SheetView\getShowZeros().

◆ $zoomScale

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::$zoomScale = 100

private

Definition at line 27 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\SheetView\getZoomScale().

◆ $zoomScaleNormal

PhpOffice\PhpSpreadsheet\Worksheet\SheetView::$zoomScaleNormal = 100

private

Definition at line 36 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\SheetView\getZoomScaleNormal().

◆ SHEETVIEW_NORMAL

const PhpOffice\PhpSpreadsheet\Worksheet\SheetView::SHEETVIEW_NORMAL = 'normal'

Definition at line 10 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readWindow2(), PhpOffice\PhpSpreadsheet\Worksheet\SheetView\setView(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetViews().

◆ SHEETVIEW_PAGE_BREAK_PREVIEW

const PhpOffice\PhpSpreadsheet\Worksheet\SheetView::SHEETVIEW_PAGE_BREAK_PREVIEW = 'pageBreakPreview'

Definition at line 12 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readWindow2(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeWindow2().

◆ SHEETVIEW_PAGE_LAYOUT

const PhpOffice\PhpSpreadsheet\Worksheet\SheetView::SHEETVIEW_PAGE_LAYOUT = 'pageLayout'

Definition at line 11 of file SheetView.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readPageLayoutView(), PhpOffice\PhpSpreadsheet\Reader\Xls\readWindow2(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writePageLayoutView().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/SheetView.php

Public Member Functions

Data Fields

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getShowZeros()

◆ getView()

◆ getZoomScale()

◆ getZoomScaleNormal()

◆ setShowZeros()

◆ setView()

◆ setZoomScale()

◆ setZoomScaleNormal()

Field Documentation

◆ $sheetviewType

◆ $sheetViewTypes

◆ $showZeros

◆ $zoomScale

◆ $zoomScaleNormal

◆ SHEETVIEW_NORMAL

◆ SHEETVIEW_PAGE_BREAK_PREVIEW

◆ SHEETVIEW_PAGE_LAYOUT