Phpxforms documentation

Sheet
in package

Sheet page in document

Table of Contents

Properties

$colCount  : int
$colDefault  : string|float|null
$cols  : array<string|int, string|float>
$headers  : array<string|int, string>
$name  : string
$rows  : array<int, array<string|int, mixed>>
$styles  : array<int, string>

Methods

__construct()  : mixed
Create sheet with name
addArray()  : void
Add 2d array
addColHeader()  : void
Add sheet header
addRow()  : void
Add row with style
filterName()  : string
Normalize sheet name
getColCount()  : int
Return max column count
getCols()  : array<string|int, string|float>
Return width of the columns
getDefCol()  : string|float|null
Return default column width
getHeaders()  : array<string|int, string>
Return headers
getName()  : string
Return sheet name
getRows()  : array<int, array<string|int, mixed>>
Return all rows
getStyle()  : string|null
Return style for selected row
setColHeaders()  : void
Set sheet headers
setColWidth()  : void
Set width of the columns

Properties

$colCount

protected int $colCount = 0

$colDefault

protected string|float|null $colDefault = null

$cols

protected array<string|int, string|float> $cols = []

$headers

protected array<string|int, string> $headers = []

$name

protected string $name

$rows

protected array<int, array<string|int, mixed>> $rows = []

$styles

protected array<int, string> $styles = []

Methods

__construct()

Create sheet with name

public __construct(string $name) : mixed
Parameters
$name : string

addArray()

Add 2d array

public addArray(array<string|int, array<string|int, mixed>> $array[, string|null $style = null ]) : void
Parameters
$array : array<string|int, array<string|int, mixed>>
$style : string|null = null

addColHeader()

Add sheet header

public addColHeader(string $column) : void
Parameters
$column : string

addRow()

Add row with style

public addRow(array<string|int, mixed> $row[, string|null $style = null ]) : void
Parameters
$row : array<string|int, mixed>
$style : string|null = null

filterName()

Normalize sheet name

public static filterName(string $name) : string
Parameters
$name : string
Return values
string

getColCount()

Return max column count

public getColCount() : int
Return values
int

getCols()

Return width of the columns

public getCols() : array<string|int, string|float>
Return values
array<string|int, string|float>

getDefCol()

Return default column width

public getDefCol() : string|float|null
Return values
string|float|null

getHeaders()

Return headers

public getHeaders() : array<string|int, string>
Return values
array<string|int, string>

getName()

Return sheet name

public getName() : string
Return values
string

getRows()

Return all rows

public getRows() : array<int, array<string|int, mixed>>
Return values
array<int, array<string|int, mixed>>

getStyle()

Return style for selected row

public getStyle(int $num) : string|null
Parameters
$num : int
Return values
string|null

setColHeaders()

Set sheet headers

public setColHeaders(array<string|int, string> $headers) : void
Parameters
$headers : array<string|int, string>

setColWidth()

Set width of the columns

public setColWidth(array<string|int, string|float> $widths[, string|float $default = null ]) : void
Parameters
$widths : array<string|int, string|float>
$default : string|float = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results