[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Writer/Common/Helper/ -> AbstractStyleHelper.php (summary)

Class AbstractStyleHelper This class provides helper functions to manage styles

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

Defines 8 functions

  __construct()
  registerStyle()
  hasStyleAlreadyBeenRegistered()
  getStyleFromSerializedStyle()
  getRegisteredStyles()
  getDefaultStyle()
  applyExtraStylesIfNeeded()
  applyWrapTextIfCellContainsNewLine()

Functions
Functions that are not part of a class:

__construct($defaultStyle)   X-Ref

param: \Box\Spout\Writer\Style\Style $defaultStyle

registerStyle($style)   X-Ref
Registers the given style as a used style.
Duplicate styles won't be registered more than once.

param: \Box\Spout\Writer\Style\Style $style The style to be registered
return: \Box\Spout\Writer\Style\Style The registered style, updated with an internal ID.

hasStyleAlreadyBeenRegistered($style)   X-Ref
Returns whether the given style has already been registered.

param: \Box\Spout\Writer\Style\Style $style
return: bool

getStyleFromSerializedStyle($serializedStyle)   X-Ref
Returns the registered style associated to the given serialization.

param: string $serializedStyle The serialized style from which the actual style should be fetched from
return: \Box\Spout\Writer\Style\Style

getRegisteredStyles()   X-Ref

return: \Box\Spout\Writer\Style\Style[] List of registered styles

getDefaultStyle()   X-Ref
Returns the default style

return: \Box\Spout\Writer\Style\Style Default style

applyExtraStylesIfNeeded($style, $dataRow)   X-Ref
Apply additional styles if the given row needs it.
Typically, set "wrap text" if a cell contains a new line.

param: \Box\Spout\Writer\Style\Style $style The original style
param: array $dataRow The row the style will be applied to
return: \Box\Spout\Writer\Style\Style The updated style

applyWrapTextIfCellContainsNewLine($style, $dataRow)   X-Ref
Set the "wrap text" option if a cell of the given row contains a new line.

param: \Box\Spout\Writer\Style\Style $style The original style
param: array $dataRow The row the style will be applied to
return: \Box\Spout\Writer\Style\Style The eventually updated style



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1