Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Alignment:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Alignment:

Public Member Functions
	__construct ($isSupervisor=false, $isConditional=false)
	Create a new Alignment. More...

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getStyleArray ($array)
	Build style array from subcomponents. More...

	applyFromArray (array $pStyles)
	Apply styles from array. More...

	getHorizontal ()
	Get Horizontal. More...

	setHorizontal ($pValue)
	Set Horizontal. More...

	getVertical ()
	Get Vertical. More...

	setVertical ($pValue)
	Set Vertical. More...

	getTextRotation ()
	Get TextRotation. More...

	setTextRotation ($pValue)
	Set TextRotation. More...

	getWrapText ()
	Get Wrap Text. More...

	setWrapText ($pValue)
	Set Wrap Text. More...

	getShrinkToFit ()
	Get Shrink to fit. More...

	setShrinkToFit ($pValue)
	Set Shrink to fit. More...

	getIndent ()
	Get indent. More...

	setIndent ($pValue)
	Set indent. More...

	getReadOrder ()
	Get read order. More...

	setReadOrder ($pValue)
	Set read order. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	__construct ($isSupervisor=false)
	Create a new Supervisor. More...

	bindParent ($parent, $parentPropertyName=null)
	Bind parent. More...

	getIsSupervisor ()
	Is this a supervisor or a cell style component? More...

	getActiveSheet ()
	Get the currently active sheet. More...

	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet. More...

	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet. More...

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

	exportArray ()
	Export style as array. More...

	getHashCode ()
	Get hash code. More...

Data Fields
const	HORIZONTAL_GENERAL = 'general'

const	HORIZONTAL_LEFT = 'left'

const	HORIZONTAL_RIGHT = 'right'

const	HORIZONTAL_CENTER = 'center'

const	HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous'

const	HORIZONTAL_JUSTIFY = 'justify'

const	HORIZONTAL_FILL = 'fill'

const	HORIZONTAL_DISTRIBUTED = 'distributed'

const	VERTICAL_BOTTOM = 'bottom'

const	VERTICAL_TOP = 'top'

const	VERTICAL_CENTER = 'center'

const	VERTICAL_JUSTIFY = 'justify'

const	VERTICAL_DISTRIBUTED = 'distributed'

const	READORDER_CONTEXT = 0

const	READORDER_LTR = 1

const	READORDER_RTL = 2

const	TEXTROTATION_STACK_EXCEL = 255

const	TEXTROTATION_STACK_PHPSPREADSHEET = -165

Protected Member Functions
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

	exportArray2 (array &$exportedArray, string $index, $objOrValue)
	Populate array from exportArray1. More...

Protected Attributes
	$horizontal = self::HORIZONTAL_GENERAL

	$vertical = self::VERTICAL_BOTTOM

	$textRotation = 0

	$wrapText = false

	$shrinkToFit = false

	$indent = 0

	$readOrder = 0

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	$isSupervisor

	$parent

	$parentPropertyName

Detailed Description

Definition at line 7 of file Alignment.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Alignment::__construct	(	$isSupervisor = `false`,
		$isConditional = `false`
	)

Create a new Alignment.

Parameters

bool	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
bool	$isConditional	Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

Definition at line 94 of file Alignment.php.

    {
        // Supervisor?
        parent::__construct($isSupervisor);
 
        if ($isConditional) {
            $this->horizontal = null;
            $this->vertical = null;
            $this->textRotation = null;
        }
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor.

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\Alignment::applyFromArray ( array $pStyles )

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getAlignment()->applyFromArray( [ 'horizontal' => \PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_CENTER, 'vertical' => \PhpOffice\PhpSpreadsheet\Style\Alignment::VERTICAL_CENTER, 'textRotation' => 0, 'wrapText' => TRUE ] );

Parameters

array $pStyles Array containing style information

Returns: $this

Definition at line 147 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            $this->getActiveSheet()->getStyle($this->getSelectedCells())
                ->applyFromArray($this->getStyleArray($pStyles));
        } else {
            if (isset($pStyles['horizontal'])) {
                $this->setHorizontal($pStyles['horizontal']);
            }
            if (isset($pStyles['vertical'])) {
                $this->setVertical($pStyles['vertical']);
            }
            if (isset($pStyles['textRotation'])) {
                $this->setTextRotation($pStyles['textRotation']);
            }
            if (isset($pStyles['wrapText'])) {
                $this->setWrapText($pStyles['wrapText']);
            }
            if (isset($pStyles['shrinkToFit'])) {
                $this->setShrinkToFit($pStyles['shrinkToFit']);
            }
            if (isset($pStyles['indent'])) {
                $this->setIndent($pStyles['indent']);
            }
            if (isset($pStyles['readOrder'])) {
                $this->setReadOrder($pStyles['readOrder']);
            }
        }
 
        return $this;
    }

Here is the call graph for this function:

◆ exportArray1()

PhpOffice\PhpSpreadsheet\Style\Alignment::exportArray1 ( )

protected

Abstract method to be implemented in anything which extends this class.

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

Reimplemented from PhpOffice\PhpSpreadsheet\Style\Supervisor.

Definition at line 470 of file Alignment.php.

                                     : array
    {
        $exportedArray = [];
        $this->exportArray2($exportedArray, 'horizontal', $this->getHorizontal());
        $this->exportArray2($exportedArray, 'indent', $this->getIndent());
        $this->exportArray2($exportedArray, 'readOrder', $this->getReadOrder());
        $this->exportArray2($exportedArray, 'shrinkToFit', $this->getShrinkToFit());
        $this->exportArray2($exportedArray, 'textRotation', $this->getTextRotation());
        $this->exportArray2($exportedArray, 'vertical', $this->getVertical());
        $this->exportArray2($exportedArray, 'wrapText', $this->getWrapText());
 
        return $exportedArray;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), PhpOffice\PhpSpreadsheet\Style\Alignment\getHorizontal(), PhpOffice\PhpSpreadsheet\Style\Alignment\getIndent(), PhpOffice\PhpSpreadsheet\Style\Alignment\getReadOrder(), PhpOffice\PhpSpreadsheet\Style\Alignment\getShrinkToFit(), PhpOffice\PhpSpreadsheet\Style\Alignment\getTextRotation(), PhpOffice\PhpSpreadsheet\Style\Alignment\getVertical(), and PhpOffice\PhpSpreadsheet\Style\Alignment\getWrapText().

Here is the call graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Style\Alignment::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 452 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHashCode();
        }
 
        return md5(
            $this->horizontal .
            $this->vertical .
            $this->textRotation .
            ($this->wrapText ? 't' : 'f') .
            ($this->shrinkToFit ? 't' : 'f') .
            $this->indent .
            $this->readOrder .
            __CLASS__
        );
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Here is the call graph for this function:

◆ getHorizontal()

PhpOffice\PhpSpreadsheet\Style\Alignment::getHorizontal ( )

Get Horizontal.

Returns: null|string

Definition at line 184 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHorizontal();
        }
 
        return $this->horizontal;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$horizontal, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment(), PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1(), and PhpOffice\PhpSpreadsheet\Style\Alignment\setIndent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIndent()

PhpOffice\PhpSpreadsheet\Style\Alignment::getIndent ( )

Get indent.

Returns: int

Definition at line 373 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getIndent();
        }
 
        return $this->indent;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$indent, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment(), and PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReadOrder()

PhpOffice\PhpSpreadsheet\Style\Alignment::getReadOrder ( )

Get read order.

Returns: int

Definition at line 416 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getReadOrder();
        }
 
        return $this->readOrder;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$readOrder, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSharedComponent()

PhpOffice\PhpSpreadsheet\Style\Alignment::getSharedComponent ( )

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor.

Returns: Alignment

Definition at line 112 of file Alignment.php.

    {
        return $this->parent->getSharedComponent()->getAlignment();
    }

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\getHashCode(), PhpOffice\PhpSpreadsheet\Style\Alignment\getHorizontal(), PhpOffice\PhpSpreadsheet\Style\Alignment\getIndent(), PhpOffice\PhpSpreadsheet\Style\Alignment\getReadOrder(), PhpOffice\PhpSpreadsheet\Style\Alignment\getShrinkToFit(), PhpOffice\PhpSpreadsheet\Style\Alignment\getTextRotation(), PhpOffice\PhpSpreadsheet\Style\Alignment\getVertical(), and PhpOffice\PhpSpreadsheet\Style\Alignment\getWrapText().

Here is the caller graph for this function:

◆ getShrinkToFit()

PhpOffice\PhpSpreadsheet\Style\Alignment::getShrinkToFit ( )

Get Shrink to fit.

Returns: bool

Definition at line 337 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getShrinkToFit();
        }
 
        return $this->shrinkToFit;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$shrinkToFit, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleArray()

PhpOffice\PhpSpreadsheet\Style\Alignment::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 124 of file Alignment.php.

    {
        return ['alignment' => $array];
    }

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\Alignment\setHorizontal(), PhpOffice\PhpSpreadsheet\Style\Alignment\setIndent(), PhpOffice\PhpSpreadsheet\Style\Alignment\setReadOrder(), PhpOffice\PhpSpreadsheet\Style\Alignment\setShrinkToFit(), PhpOffice\PhpSpreadsheet\Style\Alignment\setTextRotation(), PhpOffice\PhpSpreadsheet\Style\Alignment\setVertical(), and PhpOffice\PhpSpreadsheet\Style\Alignment\setWrapText().

Here is the caller graph for this function:

◆ getTextRotation()

PhpOffice\PhpSpreadsheet\Style\Alignment::getTextRotation ( )

Get TextRotation.

Returns: null|int

Definition at line 258 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getTextRotation();
        }
 
        return $this->textRotation;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$textRotation, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVertical()

PhpOffice\PhpSpreadsheet\Style\Alignment::getVertical ( )

Get Vertical.

Returns: null|string

Definition at line 221 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getVertical();
        }
 
        return $this->vertical;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$vertical, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment(), and PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWrapText()

PhpOffice\PhpSpreadsheet\Style\Alignment::getWrapText ( )

Get Wrap Text.

Returns: bool

Definition at line 301 of file Alignment.php.

    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getWrapText();
        }
 
        return $this->wrapText;
    }

References PhpOffice\PhpSpreadsheet\Style\Alignment\$wrapText, and PhpOffice\PhpSpreadsheet\Style\Alignment\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\exportArray1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHorizontal()

PhpOffice\PhpSpreadsheet\Style\Alignment::setHorizontal ( $pValue )

Set Horizontal.

Parameters

string $pValue see self::HORIZONTAL_*

Returns: $this

Definition at line 200 of file Alignment.php.

    {
        if ($pValue == '') {
            $pValue = self::HORIZONTAL_GENERAL;
        }
 
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['horizontal' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->horizontal = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\Alignment\HORIZONTAL_GENERAL.

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), PhpOffice\PhpSpreadsheet\Reader\Xls\Style\CellAlignment\horizontal(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIndent()

PhpOffice\PhpSpreadsheet\Style\Alignment::setIndent ( $pValue )

Set indent.

Parameters

int $pValue

Returns: $this

Definition at line 389 of file Alignment.php.

    {
        if ($pValue > 0) {
            if (
                $this->getHorizontal() != self::HORIZONTAL_GENERAL &&
                $this->getHorizontal() != self::HORIZONTAL_LEFT &&
                $this->getHorizontal() != self::HORIZONTAL_RIGHT &&
                $this->getHorizontal() != self::HORIZONTAL_DISTRIBUTED
            ) {
                $pValue = 0; // indent not supported
            }
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['indent' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->indent = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Alignment\getHorizontal(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReadOrder()

PhpOffice\PhpSpreadsheet\Style\Alignment::setReadOrder ( $pValue )

Set read order.

Parameters

int $pValue

Returns: $this

Definition at line 432 of file Alignment.php.

    {
        if ($pValue < 0 || $pValue > 2) {
            $pValue = 0;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['readOrder' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->readOrder = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShrinkToFit()

PhpOffice\PhpSpreadsheet\Style\Alignment::setShrinkToFit ( $pValue )

Set Shrink to fit.

Parameters

bool $pValue

Returns: $this

Definition at line 353 of file Alignment.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['shrinkToFit' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->shrinkToFit = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTextRotation()

PhpOffice\PhpSpreadsheet\Style\Alignment::setTextRotation ( $pValue )

Set TextRotation.

Parameters

int $pValue

Returns: $this

Definition at line 274 of file Alignment.php.

    {
        // Excel2007 value 255 => PhpSpreadsheet value -165
        if ($pValue == self::TEXTROTATION_STACK_EXCEL) {
            $pValue = self::TEXTROTATION_STACK_PHPSPREADSHEET;
        }
 
        // Set rotation
        if (($pValue >= -90 && $pValue <= 90) || $pValue == self::TEXTROTATION_STACK_PHPSPREADSHEET) {
            if ($this->isSupervisor) {
                $styleArray = $this->getStyleArray(['textRotation' => $pValue]);
                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
            } else {
                $this->textRotation = $pValue;
            }
        } else {
            throw new PhpSpreadsheetException('Text rotation should be a value between -90 and 90.');
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\Alignment\TEXTROTATION_STACK_PHPSPREADSHEET.

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVertical()

PhpOffice\PhpSpreadsheet\Style\Alignment::setVertical ( $pValue )

Set Vertical.

Parameters

string $pValue see self::VERTICAL_*

Returns: $this

Definition at line 237 of file Alignment.php.

    {
        if ($pValue == '') {
            $pValue = self::VERTICAL_BOTTOM;
        }
 
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['vertical' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->vertical = $pValue;
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\Alignment\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\Alignment\VERTICAL_BOTTOM.

Referenced by PhpOffice\PhpSpreadsheet\Style\Alignment\applyFromArray(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle(), and PhpOffice\PhpSpreadsheet\Reader\Xls\Style\CellAlignment\vertical().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setWrapText()

PhpOffice\PhpSpreadsheet\Style\Alignment::setWrapText ( $pValue )

Set Wrap Text.

Parameters

bool $pValue

Returns: $this

Definition at line 317 of file Alignment.php.

    {
        if ($pValue == '') {
            $pValue = false;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['wrapText' => $pValue]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->wrapText = $pValue;
        }
 
        return $this;
    }