Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\PageMargins:

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

	getLeft ()
	Get Left. More...

	setLeft ($pValue)
	Set Left. More...

	getRight ()
	Get Right. More...

	setRight ($pValue)
	Set Right. More...

	getTop ()
	Get Top. More...

	setTop ($pValue)
	Set Top. More...

	getBottom ()
	Get Bottom. More...

	setBottom ($pValue)
	Set Bottom. More...

	getHeader ()
	Get Header. More...

	setHeader ($pValue)
	Set Header. More...

	getFooter ()
	Get Footer. More...

	setFooter ($pValue)
	Set Footer. More...

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

Static Public Member Functions
static	fromCentimeters (float $value)

static	toCentimeters (float $value)

static	fromMillimeters (float $value)

static	toMillimeters (float $value)

static	fromPoints (float $value)

static	toPoints (float $value)

Private Attributes
	$left = 0.7

	$right = 0.7

	$top = 0.75

	$bottom = 0.75

	$header = 0.3

	$footer = 0.3

Detailed Description

Definition at line 5 of file PageMargins.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new PageMargins.

Definition at line 52 of file PageMargins.php.

53 {

54 }

Member Function Documentation

◆ __clone()

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

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

Definition at line 203 of file PageMargins.php.

References $key.

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

◆ fromCentimeters()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::fromCentimeters ( float $value )

static

Definition at line 215 of file PageMargins.php.

                                                         : float
     {
         return $value / 2.54;
     }

◆ fromMillimeters()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::fromMillimeters ( float $value )

static

Definition at line 225 of file PageMargins.php.

                                                         : float
     {
         return $value / 25.4;
     }

◆ fromPoints()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::fromPoints ( float $value )

static

Definition at line 235 of file PageMargins.php.

                                                    : float
     {
         return $value / 72;
     }

◆ getBottom()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getBottom ( )

Get Bottom.

Returns: float

Definition at line 133 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$bottom.

     {
         return $this->bottom;
     }

◆ getFooter()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getFooter ( )

Get Footer.

Returns: float

Definition at line 181 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$footer.

     {
         return $this->footer;
     }

◆ getHeader()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getHeader ( )

Get Header.

Returns: float

Definition at line 157 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$header.

     {
         return $this->header;
     }

◆ getLeft()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getLeft ( )

Get Left.

Returns: float

Definition at line 61 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$left.

     {
         return $this->left;
     }

◆ getRight()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getRight ( )

Get Right.

Returns: float

Definition at line 85 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$right.

     {
         return $this->right;
     }

◆ getTop()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::getTop ( )

Get Top.

Returns: float

Definition at line 109 of file PageMargins.php.

References PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\$top.

     {
         return $this->top;
     }

◆ setBottom()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setBottom ( $pValue )

Set Bottom.

Parameters

float $pValue

Returns: $this

Definition at line 145 of file PageMargins.php.

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

◆ setFooter()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setFooter ( $pValue )

Set Footer.

Parameters

float $pValue

Returns: $this

Definition at line 193 of file PageMargins.php.

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

◆ setHeader()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setHeader ( $pValue )

Set Header.

Parameters

float $pValue

Returns: $this

Definition at line 169 of file PageMargins.php.

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

◆ setLeft()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setLeft ( $pValue )

Set Left.

Parameters

float $pValue

Returns: $this

Definition at line 73 of file PageMargins.php.

References left.

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

◆ setRight()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setRight ( $pValue )

Set Right.

Parameters

float $pValue

Returns: $this

Definition at line 97 of file PageMargins.php.

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

◆ setTop()

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::setTop ( $pValue )

Set Top.

Parameters

float $pValue

Returns: $this

Definition at line 121 of file PageMargins.php.

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

◆ toCentimeters()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::toCentimeters ( float $value )

static

Definition at line 220 of file PageMargins.php.

                                                       : float
     {
         return $value * 2.54;
     }

◆ toMillimeters()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::toMillimeters ( float $value )

static

Definition at line 230 of file PageMargins.php.

                                                       : float
     {
         return $value * 25.4;
     }

◆ toPoints()

static PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::toPoints ( float $value )

static

Definition at line 240 of file PageMargins.php.

                                                  : float
     {
         return $value * 72;
     }

Field Documentation

◆ $bottom

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$bottom = 0.75

private

Definition at line 33 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getBottom().

◆ $footer

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$footer = 0.3

private

Definition at line 47 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getFooter().

◆ $header

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$header = 0.3

private

Definition at line 40 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getHeader().

◆ $left

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$left = 0.7

private

Definition at line 12 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getLeft().

◆ $right

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$right = 0.7

private

Definition at line 19 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getRight().

◆ $top

PhpOffice\PhpSpreadsheet\Worksheet\PageMargins::$top = 0.75

private

Definition at line 26 of file PageMargins.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\PageMargins\getTop().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ fromCentimeters()

◆ fromMillimeters()

◆ fromPoints()

◆ getBottom()

◆ getFooter()

◆ getHeader()

◆ getLeft()

◆ getRight()

◆ getTop()

◆ setBottom()

◆ setFooter()

◆ setHeader()

◆ setLeft()

◆ setRight()

◆ setTop()

◆ toCentimeters()

◆ toMillimeters()

◆ toPoints()

Field Documentation

◆ $bottom

◆ $footer

◆ $header

◆ $left

◆ $right

◆ $top