Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

(no description)

File Size: 466 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Alignment:: (19 methods):
  __construct()
  getSharedComponent()
  getStyleArray()
  applyFromArray()
  getHorizontal()
  setHorizontal()
  getVertical()
  setVertical()
  getTextRotation()
  setTextRotation()
  getWrapText()
  setWrapText()
  getShrinkToFit()
  setShrinkToFit()
  getIndent()
  setIndent()
  getReadOrder()
  setReadOrder()
  getHashCode()


Class: Alignment  - X-Ref

__construct($isSupervisor = false, $isConditional = false)   X-Ref
Create a new Alignment.

param: bool $isSupervisor Flag indicating if this is a supervisor or not
param: bool $isConditional Flag indicating if this is a conditional style or not

getSharedComponent()   X-Ref
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor.

return: Alignment

getStyleArray($array)   X-Ref
Build style array from subcomponents.

param: array $array
return: array

applyFromArray(array $pStyles)   X-Ref
Apply styles from array.

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

param: array $pStyles Array containing style information
return: Alignment

getHorizontal()   X-Ref
Get Horizontal.

return: string

setHorizontal($pValue)   X-Ref
Set Horizontal.

param: string $pValue see self::HORIZONTAL_*
return: Alignment

getVertical()   X-Ref
Get Vertical.

return: string

setVertical($pValue)   X-Ref
Set Vertical.

param: string $pValue see self::VERTICAL_*
return: Alignment

getTextRotation()   X-Ref
Get TextRotation.

return: int

setTextRotation($pValue)   X-Ref
Set TextRotation.

param: int $pValue
return: Alignment

getWrapText()   X-Ref
Get Wrap Text.

return: bool

setWrapText($pValue)   X-Ref
Set Wrap Text.

param: bool $pValue
return: Alignment

getShrinkToFit()   X-Ref
Get Shrink to fit.

return: bool

setShrinkToFit($pValue)   X-Ref
Set Shrink to fit.

param: bool $pValue
return: Alignment

getIndent()   X-Ref
Get indent.

return: int

setIndent($pValue)   X-Ref
Set indent.

param: int $pValue
return: Alignment

getReadOrder()   X-Ref
Get read order.

return: int

setReadOrder($pValue)   X-Ref
Set read order.

param: int $pValue
return: Alignment

getHashCode()   X-Ref
Get hash code.

return: string Hash code