Class: HTML_Table_Matrix_Filler

Source Location: /HTML_Table_Matrix-1.0.10/HTML/Table/Matrix/Filler.php

Class Overview

Base class common to all Fillers

Author(s):

Ian Eure <ieure at php.net>

Variables

Methods

Child classes:

HTML_Table_Matrix_Filler_LRBT: Fill left-to-right, bottom-to-top.

HTML_Table_Matrix_Filler_BTRL: Fill bottom-to-top, right-to-left.

HTML_Table_Matrix_Filler_InC: Fill inwards, clockwise.

HTML_Table_Matrix_Filler_BTLR: Fill bottom-to-top, left-to-right.

HTML_Table_Matrix_Filler_LRTB: Fill left-to-right, top-to-bottom.

HTML_Table_Matrix_Filler_InCC: Fill inwards, clockwise.

HTML_Table_Matrix_Filler_Random: Fill randomly

HTML_Table_Matrix_Filler_TBRL: Fill top-to-bottom, right-to-left.

HTML_Table_Matrix_Filler_RLBT: Fill left-to-right, bottom-to-top.

HTML_Table_Matrix_Filler_TBLR: Fill top-to-bottom, left-to-right.

HTML_Table_Matrix_Filler_RLTB: Fill left-to-right, top-to-bottom.

Inherited Variables

Inherited Methods

Class Details

[line 28]
Base class common to all Fillers

Author: Ian Eure <ieure@php.net>
Since: 1.0

[ Top ]

Class Variables

$callback =

[line 72]

Callback function applied to _data

Type:

mixed

[ Top ]

$col = 0

[line 65]

Current column to fill

Type:

mixed

[ Top ]

$matrix = ''

[line 51]

Reference to the HTML_Table_Matrix instance we will be Filling for

Type:

mixed

[ Top ]

$options = ''

[line 44]

Filler options

See: HTML_Table_Matrix_Filler::setOptions()

Type:

mixed

[ Top ]

$row = 0

[line 58]

Current row to fill

Type:

mixed

[ Top ]

$_defaultOptions = array()

[line 36]

Default filler options

See: HTML_Table_Matrix_Filler::setOptions()
Access: protected

Type:

mixed

[ Top ]

Method Detail

factory [line 83]

mixed &factory(
string
$type, 
&$matrix, [array
$options = array()], Object
$matrix)

Create an instance of a Filler

Return: Filler instance on success, PEAR_Error otherwise

Parameters:

string	`$type`	—	Type of filler to instantiate
Object	`$matrix`	—	Reference to the HTML_Table_Matrix instance the Filler will work with
array	`$options`	—	Filler options
	`&$matrix`	—

[ Top ]

isValid [line 112]

boolean isValid(

&$object, mixed
$object)

Determine if a given object is a valid H_T_M Filler

Return: true if valid, false otherwise

Parameters:

mixed	`$object`	—	Object to check
	`&$object`	—

[ Top ]

next [line 127]

array next(
int
$index)

Get the next cell.

Return: 1-dimensional array in the form of (row, col) containing the coordinates to put the data for this loop iteration

Overridden in child classes as:

HTML_Table_Matrix_Filler_LRBT::next(): Get the next cell.

HTML_Table_Matrix_Filler_BTRL::next(): Get the next cell.

HTML_Table_Matrix_Filler_InC::next(): Get the next cell.

HTML_Table_Matrix_Filler_BTLR::next(): Get the next cell.

HTML_Table_Matrix_Filler_LRTB::next(): Get the next cell.

HTML_Table_Matrix_Filler_InCC::next(): Get the next cell.

HTML_Table_Matrix_Filler_Random::next(): Get the next cell.

HTML_Table_Matrix_Filler_TBRL::next(): Get the next cell.

HTML_Table_Matrix_Filler_RLBT::next(): Get the next cell.

HTML_Table_Matrix_Filler_TBLR::next(): Get the next cell.

HTML_Table_Matrix_Filler_RLTB::next(): Get the next cell.

Parameters:

int $index — Where we're at in the data-set

[ Top ]

setOptions [line 101]

void setOptions(
[array
$options = array()])

Set options for this Filler

Parameters:

array $options — Options to set

[ Top ]