__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
exportArray()
getSharedComponent()
getStyleArray()
applyFromArray()
getHorizontal()
setHorizontal()
getVertical()
setVertical()
getTextRotation()
setTextRotation()
getWrapText()
setWrapText()
getShrinkToFit()
setShrinkToFit()
getIndent()
setIndent()
getReadOrder()
setReadOrder()
getHashCode()

No public properties found

HORIZONTAL_GENERAL
HORIZONTAL_LEFT
HORIZONTAL_RIGHT
HORIZONTAL_CENTER
HORIZONTAL_CENTER_CONTINUOUS
HORIZONTAL_JUSTIFY
HORIZONTAL_FILL
HORIZONTAL_DISTRIBUTED
VERTICAL_BOTTOM
VERTICAL_TOP
VERTICAL_CENTER
VERTICAL_JUSTIFY
VERTICAL_DISTRIBUTED
READORDER_CONTEXT
READORDER_LTR
READORDER_RTL
TEXTROTATION_STACK_EXCEL
TEXTROTATION_STACK_PHPSPREADSHEET

exportArray1()
exportArray2()

$isSupervisor
$parent
$parentPropertyName
$horizontal
$vertical
$textRotation
$wrapText
$shrinkToFit
$indent
$readOrder

N/A

No private methods found

No private properties found

N/A

File: serve/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Alignment.php
Package: Application
Class hierarchy: Supervisor

\PhpOffice\PhpSpreadsheet\Style\Alignment
Uses

Constants

HORIZONTAL_GENERAL

HORIZONTAL_GENERAL = 'general'

HORIZONTAL_LEFT

HORIZONTAL_LEFT = 'left'

HORIZONTAL_RIGHT

HORIZONTAL_RIGHT = 'right'

HORIZONTAL_CENTER

HORIZONTAL_CENTER = 'center'

HORIZONTAL_CENTER_CONTINUOUS

HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous'

HORIZONTAL_JUSTIFY

HORIZONTAL_JUSTIFY = 'justify'

HORIZONTAL_FILL

HORIZONTAL_FILL = 'fill'

HORIZONTAL_DISTRIBUTED

HORIZONTAL_DISTRIBUTED = 'distributed'

VERTICAL_BOTTOM

VERTICAL_BOTTOM = 'bottom'

VERTICAL_TOP

VERTICAL_TOP = 'top'

VERTICAL_CENTER

VERTICAL_CENTER = 'center'

VERTICAL_JUSTIFY

VERTICAL_JUSTIFY = 'justify'

VERTICAL_DISTRIBUTED

VERTICAL_DISTRIBUTED = 'distributed'

READORDER_CONTEXT

READORDER_CONTEXT = 0

READORDER_LTR

READORDER_LTR = 1

READORDER_RTL

READORDER_RTL = 2

TEXTROTATION_STACK_EXCEL

TEXTROTATION_STACK_EXCEL = 255

TEXTROTATION_STACK_PHPSPREADSHEET

TEXTROTATION_STACK_PHPSPREADSHEET = -165

Properties

$isSupervisor

$isSupervisor : bool

Supervisor?

Type

bool —

$parent

$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

Parent. Only used for supervisor.

Type

Style —

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string —

$horizontal

$horizontal : string

Horizontal alignment.

Type

string —

$vertical

$vertical : string

Vertical alignment.

Type

string —

$textRotation

$textRotation : int

Text rotation.

Type

int —

$wrapText

$wrapText : bool

Wrap text.

Type

bool —

$shrinkToFit

$shrinkToFit : bool

Shrink to fit.

Type

bool —

$indent

$indent : int

Indent - only possible with horizontal alignment left and right.

Type

int —

$readOrder

$readOrder : int

Read order.

Type

int —

Methods

__construct()

__construct(bool  $isSupervisor = false, bool  $isConditional = false) : mixed

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

Returns

mixed —

bindParent()

bindParent(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style  $parent, null|string  $parentPropertyName = null) : $this

Bind parent. Only used for supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet\|\PhpOffice\PhpSpreadsheet\Style\Style	$parent
null\|string	$parentPropertyName

Returns

$this —

getIsSupervisor()

getIsSupervisor() : bool

Is this a supervisor or a cell style component?

Returns

bool —

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get the currently active sheet. Only used for supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

__clone()

__clone() : mixed

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

Returns

mixed —

exportArray()

exportArray() : array

Export style as array.

Available to anything which extends this class: Alignment, Border, Borders, Color, Fill, Font, NumberFormat, Protection, and Style.

Returns

array —

getSharedComponent()

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

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Alignment —

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array

$array

Returns

array —

applyFromArray()

applyFromArray(array  $pStyles) : $this

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 —

getHorizontal()

getHorizontal() : string

Get Horizontal.

Returns

string —

setHorizontal()

setHorizontal(string  $pValue) : $this

Set Horizontal.

Parameters

string

$pValue

see self::HORIZONTAL_*

Returns

$this —

getVertical()

getVertical() : string

Get Vertical.

Returns

string —

setVertical()

setVertical(string  $pValue) : $this

Set Vertical.

Parameters

string

$pValue

see self::VERTICAL_*

Returns

$this —

getTextRotation()

getTextRotation() : int

Get TextRotation.

Returns

int —

setTextRotation()

setTextRotation(int  $pValue) : $this

Set TextRotation.

Parameters

int

$pValue

Returns

$this —

getWrapText()

getWrapText() : bool

Get Wrap Text.

Returns

bool —

setWrapText()

setWrapText(bool  $pValue) : $this

Set Wrap Text.

Parameters

bool

$pValue

Returns

$this —

getShrinkToFit()

getShrinkToFit() : bool

Get Shrink to fit.

Returns

bool —

setShrinkToFit()

setShrinkToFit(bool  $pValue) : $this

Set Shrink to fit.

Parameters

bool

$pValue

Returns

$this —

getIndent()

getIndent() : int

Get indent.

Returns

int —

setIndent()

setIndent(int  $pValue) : $this

Set indent.

Parameters

int

$pValue

Returns

$this —

getReadOrder()

getReadOrder() : int

Get read order.

Returns

int —

setReadOrder()

setReadOrder(int  $pValue) : $this

Set read order.

Parameters

int

$pValue

Returns

$this —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

exportArray1()

exportArray1() : array

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.

Returns

array —

exportArray2()

exportArray2(array  $exportedArray, string  $index, mixed  $objOrValue) : void

Populate array from exportArray1.

This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.

Parameters

array	$exportedArray
string	$index
mixed	$objOrValue