DataFrame

Full name: \MammothPHP\WoollyM\DataFrame
Parent class: \MammothPHP\WoollyM\DataFrameHelpers

Methods

fromArray

Factory method for creating a DataFrame from a two-dimensional associative array.

php

public static fromArray(array $data): static

This method is static.

Parameters:

Parameter	Type	Description
`$data`	array

Inherited methods

insert

Return an Update statement, methods will return the same DataFrame object

php

public insert(): \MammothPHP\WoollyM\Statements\Insert\Insert

__construct

php

public __construct(array&lt;int,array&gt; $data = [], mixed $dataDriver = null): mixed

Parameters:

Parameter	Type	Description
`$data`	array<int,array>	Array data to ingest
`$dataDriver`	mixed	- Class of custom driver to use. if null, the PhpArray (in-memory) driver will used.

Throws:

InvalidDriverClassException

__clone

php

public __clone(): mixed

addColumn

Adds a new column to the DataFrame. If column already exist, then nothing will happen.

php

public addColumn(string $columnName): static

Parameters:

Parameter	Type	Description
`$columnName`	string

addColumns

Adds multiple columns to the DataFrame.

php

public addColumns(string[] $columnNames): static

Parameters:

Parameter	Type	Description
`$columnNames`	string[]

removeColumn

Removes a column (and all associated data) from the DataFrame.

php

public removeColumn(string $columnName): static

Parameters:

Parameter	Type	Description
`$columnName`	string

hasColumn

Returns a boolean of whether the specified column exists.

php

public hasColumn(\MammothPHP\WoollyM\Statements\Select\ColumnRepresentation|string $column): bool

Parameters:

Parameter	Type	Description
`$column`	\MammothPHP\WoollyM\Statements\Select\ColumnRepresentation\|string

countColumns

Count unique columns already known

php

public countColumns(): int

columns

Return ColumnRepresentation Object extending Select object

php

public columns(): array&lt;int,\MammothPHP\WoollyM\Statements\Select\ColumnRepresentation&gt;

columnsNames

Get unique columns already known

php

public columnsNames(): array&lt;int,string&gt;

mustHaveColumn

Assertion that the DataFrame must have the column specified. If not then an exception is thrown.

php

public mustHaveColumn(string $columnName): static

Parameters:

Parameter	Type	Description
`$columnName`	string

Throws:

InvalidSelectException

getColumnKey

php

protected getColumnKey(string $columnName): int

Parameters:

Parameter	Type	Description
`$columnName`	string

createColumnRepresentation

php

protected createColumnRepresentation(\MammothPHP\WoollyM\ColumnIndex $columnIndex): void

Parameters:

Parameter	Type	Description
`$columnIndex`	\MammothPHP\WoollyM\ColumnIndex

addRecord

Add a record, providing an array indexed by column => value

php

public addRecord(array&lt;string,mixed&gt; $recordArray): static

Parameters:

Parameter	Type	Description
`$recordArray`	array<string,mixed>

updateRecord

Update a record by record key. If key does not exist, record will be created.

php

public updateRecord(int $key, array $recordArray): static

Parameters:

Parameter	Type	Description
`$key`	int
`$recordArray`	array

updateCell

php

public updateCell(int $recordKey, string $column, mixed $newValue): static

Parameters:

Parameter	Type	Description
`$recordKey`	int
`$column`	string
`$newValue`	mixed

removeRecord

Remove a record by key

php

public removeRecord(int $key): static

Parameters:

Parameter	Type	Description
`$key`	int

Throws:

KeyNotExistException

getRecord

Get a record by key

php

public getRecord(int $key): array&lt;string,array&gt;

Parameters:

Parameter	Type	Description
`$key`	int

getRecordAsArray

Get a record by key and return an array

php

public getRecordAsArray(int $key): array&lt;string,array&gt;

Parameters:

Parameter	Type	Description
`$key`	int

recordKeyExist

Check if a record key exist

php

public recordKeyExist(int $recordKey): bool

Parameters:

Parameter	Type	Description
`$recordKey`	int

convertRecordToAbstract

php

protected convertRecordToAbstract(array $recordArray): array

Parameters:

Parameter	Type	Description
`$recordArray`	array

convertAbstractToRecordObject

php

protected convertAbstractToRecordObject(array $abstractRecord): \MammothPHP\WoollyM\Record

Parameters:

Parameter	Type	Description
`$abstractRecord`	array

toArray

Outputs a DataFrame as a two-dimensional associative array.

php

public toArray(bool $fillInNonExistentCol = false): array

Parameters:

Parameter	Type	Description
`$fillInNonExistentCol`	bool

initDriverIterator

php

protected initDriverIterator(): void

getRecordsAsArrayIterator

php

public getRecordsAsArrayIterator(bool $fillAllColumn = false): \Iterator

Parameters:

Parameter	Type	Description
`$fillAllColumn`	bool

select

Return a Select object

php

public select(string[] $selections): \MammothPHP\WoollyM\Statements\Select\Select

Parameters:

Parameter	Type	Description
`$selections`	string[]	column(s) name(s) to select

selectAll

Return a fixed selectAll object

php

public selectAll(): \MammothPHP\WoollyM\Statements\Select\SelectAll

col

Return a ColumnRepresentation object, extending Select object.

php

public col(string $columnName): \MammothPHP\WoollyM\Statements\Select\ColumnRepresentation

Parameters:

Parameter	Type	Description
`$columnName`	string

Throws:

InvalidSelectException

column

Alias for col() method.

php

public column(string $columnName): \MammothPHP\WoollyM\Statements\Select\ColumnRepresentation

Parameters:

Parameter	Type	Description
`$columnName`	string

extract

Return a Copy object, methods will return new DataFrame objects.

php

public extract(\MammothPHP\WoollyM\DataFrame $to = new DataFrame()): \MammothPHP\WoollyM\Extract

Parameters:

Parameter	Type	Description
`$to`	\MammothPHP\WoollyM\DataFrame

delete

Return a Copy object, methods will return new DataFrame objects.

php

public delete(): \MammothPHP\WoollyM\Statements\Delete\Delete

update

Return an Update statement, methods will return the same DataFrame object

php

public update(): \MammothPHP\WoollyM\Statements\Update\Update

sortColumns

Sort column order using a closure. Then retrieve records will respect the new order.

php

public sortColumns(mixed $callback = null): static

Parameters:

Parameter	Type	Description
`$callback`	mixed	- If null, sort will be alphabetic. For closure, example fn(string $a, string $b): int => $a <=> $b;

sortRecordsByColumns

Sort the records by columns

php

public sortRecordsByColumns(array|string $by, bool $ascending = true): static

Parameters:

Parameter	Type	Description
`$by`	array\|string
`$ascending`	bool

count

Count records

php

public count(): int

head

Return the the first records

php

public head(mixed $length = 5, mixed $offset, mixed $columns = null): array

Parameters:

Parameter	Type	Description
`$length`	mixed	- Number of records
`$offset`	mixed	- Start at record number x (from 0)
`$columns`	mixed	- Only these columns

Throws:

groupBy

php

public groupBy(string[] $args): \MammothPHP\WoollyM\DataFrame

Parameters:

Parameter	Type	Description
`$args`	string[]

Automatically generated on 2024-07-03

DataFrame ​

Methods ​

fromArray ​

Inherited methods ​

insert ​

__construct ​

__clone ​

addColumn ​

addColumns ​

removeColumn ​

hasColumn ​

countColumns ​

columns ​

columnsNames ​

mustHaveColumn ​

getColumnKey ​

createColumnRepresentation ​

addRecord ​

updateRecord ​

updateCell ​

removeRecord ​

getRecord ​

getRecordAsArray ​

recordKeyExist ​

convertRecordToAbstract ​

convertAbstractToRecordObject ​

toArray ​

initDriverIterator ​

getRecordsAsArrayIterator ​

select ​

selectAll ​

col ​

column ​

extract ​

delete ​

update ​

sortColumns ​

sortRecordsByColumns ​

count ​

head ​

groupBy ​

DataFrame

Methods

fromArray

Inherited methods

insert

__construct

__clone

addColumn

addColumns

removeColumn

hasColumn

countColumns

columns

columnsNames

mustHaveColumn

getColumnKey

createColumnRepresentation

addRecord

updateRecord

updateCell

removeRecord

getRecord

getRecordAsArray

recordKeyExist

convertRecordToAbstract

convertAbstractToRecordObject

toArray

initDriverIterator

getRecordsAsArrayIterator

select

selectAll

col

column

extract

delete

update

sortColumns

sortRecordsByColumns

count

head

groupBy