Documentation

Step extends AbstractProfiler
in package

MySQL database adapter profiler step class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
6.5.0

Table of Contents

Properties

$errors  : array<string|int, mixed>
Errors
$finish  : float|null
Step finish time
$params  : array<string|int, mixed>
Statement parameters
$query  : string|null
Query SQL
$start  : float|null
Step start time

Methods

__construct()  : mixed
Constructor
__get()  : mixed
Magic method to support shorthand calls to certain values in the step
addError()  : Step
Add error
addParam()  : Step
Add param
addParams()  : Step
Add params
finish()  : AbstractProfiler
Finish profiler
getElapsed()  : string
Get elapsed time
getErrors()  : array<string|int, mixed>
Get errors
getFinish()  : float|null
Get finish
getParams()  : array<string|int, mixed>
Get params
getQuery()  : string|null
Get query
getStart()  : float|null
Get start
hasErrors()  : bool
Determine if the profiler has errors
hasParams()  : bool
Determine if the profiler has params
hasQuery()  : bool
Determine if the profiler has query
setQuery()  : Step
Set query

Properties

$errors

Errors

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

$params

Statement parameters

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

$query

Query SQL

protected string|null $query = null

Methods

__construct()

Constructor

public __construct() : mixed

Instantiate the profiler object

__get()

Magic method to support shorthand calls to certain values in the step

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

addError()

Add error

public addError(string $error[, mixed $number = null ]) : Step
Parameters
$error : string
$number : mixed = null
Return values
Step

addParam()

Add param

public addParam(string $name, mixed $value) : Step
Parameters
$name : string
$value : mixed
Return values
Step

addParams()

Add params

public addParams(array<string|int, mixed> $params) : Step
Parameters
$params : array<string|int, mixed>
Return values
Step

getElapsed()

Get elapsed time

public getElapsed() : string
Return values
string

getErrors()

Get errors

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

getFinish()

Get finish

public getFinish() : float|null
Return values
float|null

getParams()

Get params

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

getQuery()

Get query

public getQuery() : string|null
Return values
string|null

getStart()

Get start

public getStart() : float|null
Return values
float|null

hasErrors()

Determine if the profiler has errors

public hasErrors() : bool
Return values
bool

hasParams()

Determine if the profiler has params

public hasParams() : bool
Return values
bool

hasQuery()

Determine if the profiler has query

public hasQuery() : bool
Return values
bool

setQuery()

Set query

public setQuery(string $sql) : Step
Parameters
$sql : string
Return values
Step

        
On this page

Search results