PaulSchulz\SilverStripe\Gallery\Views\ImageLineCollection
This class represents an image line collection, which is just all lines of an image collection.
Synopsis
class ImageLineCollection
extends ViewableData
{
- // constants
- const BIAS_MODE_AVG = 'avg';
- const BIAS_MODE_MAX = 'max';
- // methods
- public void __construct()
- public void addLine()
- public float getBias()
- public ArrayList getLines()
- public DBHTMLText forTemplate()
Hierarchy
Extends
- SilverStripe\View\ViewableData
Constants
Name | Value |
---|---|
BIAS_MODE_AVG | 'avg' |
BIAS_MODE_MAX | 'max' |
Members
protected
- $biasMode
—
string
The mode (algorithm) the deviation of the image lines between the desired line height and the actual line height is calculated with. - $lines
—
SilverStripe\ORM\ArrayList
All lines in this image line collection.
Methods
public
- __construct() — ImageLineCollection constructor.
- addLine() — Adds a line to this LineCollection. It adds the line to the start of this list if $atStart is true.
- forTemplate() — This function is called when this object should be rendered to a template.
- getBias() — This function calculates the deviation to the desired height of all lines of this collection.
- getLines() — Returns all lines of this image line collection.