TableRows

Part of the ProFields package

Please do not distribute.

Copyright 2024 by Ryan Cramer

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the TableRows class also inherits all the methods and properties of: PaginatedArray, WireArray and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
TableRows::getColumn($n)
array

Return array of information about the column

 
TableRows::getColumns()
array

Return array of information about all columns

 
TableRows::getField()
None 
TableRows::getLabel($n)
string

Return the label for this column

 
TableRows::getLabels()
array

Return array of all column labels (indexed by column name)

 
TableRows::getPage()
None 
TableRows::importCSV(string $csvFile)
int

Import CSV file

 
TableRows::isFormatted()
bool

Get or set whether this is a formatted value

 
TableRows::isValidItem($item)
bool

Is item valid for this TableRows?

 
TableRows::makeBlankItem()
TableRow

Make a new/blank TableRow item

 
TableRows::makeNew()
TableRows

Make a new TableRows object

 
TableRows::new()
TableRow

Create a new TableRow item and add to this TableRows

TableRows::render()
string

Render a basic table containing the data from this TableRows

TableRows::setField($field)
None 
TableRows::setPage($page)
None 

Properties

NameReturnSummary 
TableRows::labels array 

Additional methods and properties

In addition to the methods and properties above, TableRows also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.259