API Documentation
\
Weby
Sloth
Func
Group
Value
Operation

\Weby\SlothSloth

Main class to perform data manipulations.

Summary

Methods
Properties
Constants
from()
__construct()
group()
pivot()
isColExists()
$data
$dataType
$isArray
$isAssoc
$isObject
DATA_UNKNOWN
DATA_ARRAY
DATA_ASSOC
DATA_OBJECT
COLUMN_SEPARATOR
ARRAY_OUTPUT_COLUMN_SEPARATOR
ASSOC_OUTPUT_COLUMN_SEPARATOR
No protected methods found
No protected properties found
N/A
assignFirstRow()
assignDataType()
$firstRow
N/A

Constants

DATA_UNKNOWN

DATA_UNKNOWN = 0

DATA_ARRAY

DATA_ARRAY = 1

DATA_ASSOC

DATA_ASSOC = 2

DATA_OBJECT

DATA_OBJECT = 3

COLUMN_SEPARATOR

COLUMN_SEPARATOR = "\u{241F}"

ARRAY_OUTPUT_COLUMN_SEPARATOR

ARRAY_OUTPUT_COLUMN_SEPARATOR = '.'

ASSOC_OUTPUT_COLUMN_SEPARATOR

ASSOC_OUTPUT_COLUMN_SEPARATOR = '|'

Properties

$data

$data : array

Input data.

Type

array

$dataType

$dataType : integer

Type of input data.

Type

integer

$isArray

$isArray : boolean

Input data is array of non-assoc arrays.

Type

boolean

$isAssoc

$isAssoc : boolean

Input data is array of assoc arrays.

Type

boolean

$isObject

$isObject : boolean

Input data is array of objects.

Type

boolean

$firstRow

$firstRow :

Type

Methods

from()

from(array  $data) : \Weby\Sloth\Sloth

Returns Sloth's instance created for specified data.

Parameters

array $data

Returns

\Weby\Sloth\Sloth

__construct()

__construct(array  $data)

Creates Sloth's instance for specified data.

Parameters

array $data

Throws

\Weby\Sloth\Exception

group()

group(string|array  $groupCols, string|array  $valueCols = null) : \Weby\Sloth\Operation\Group

Provides fluent interface to "group" operation.

Parameters

string|array $groupCols
string|array $valueCols

Returns

\Weby\Sloth\Operation\Group

pivot()

pivot(string|array  $groupCols, string|array  $columnCols, string|array  $valueCols) : \Weby\Sloth\Operation\Pivot

Provides fluent interface to "pivot" operation.

Parameters

string|array $groupCols
string|array $columnCols
string|array $valueCols

Returns

\Weby\Sloth\Operation\Pivot

isColExists()

isColExists(string|integer  $colName) : boolean

Checks whether a colum exists in the input data.

Parameters

string|integer $colName

Name or index of column.

Returns

boolean

assignFirstRow()

assignFirstRow()

assignDataType()

assignDataType()