ICanBoogie
  • Documentation
  • API Reference
  • ActiveRecord 4.0.x
Namespaces
  • ICanBoogie
    • ActiveRecord
      • ActiveRecordCache
      • Driver
      • Property
      • Validate
        • Reader
        • Validator
        • ValidatorProvider
Classes
  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • HasManyRelation
  • Model
  • ModelCollection
  • ModelProvider
  • Query
  • Relation
  • RelationCollection
  • RelationNotDefined
  • Schema
  • SchemaColumn
  • Statement
  • Table
Interfaces
  • ActiveRecordCache
  • Driver
  • Exception
Exceptions
  • ActiveRecordClassNotValid
  • ConnectionAlreadyEstablished
  • ConnectionNotDefined
  • ConnectionNotEstablished
  • DriverNotDefined
  • ModelAlreadyInstantiated
  • ModelNotDefined
  • RecordNotFound
  • RecordNotValid
  • ScopeNotDefined
  • StatementInvocationFailed
  • StatementNotValid
  • UnableToSetFetchMode

Class Statement

A database statement.

PDOStatement implements Traversable
┗ ICanBoogie\ActiveRecord\Statement uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\ActiveRecord
Located at ActiveRecord/Statement.php

Methods summary

protected get_connection( void )
protected set_connection( ICanBoogie\ActiveRecord\Connection $connection )
public __invoke( void ) : ICanBoogie\ActiveRecord\Statement

Alias of ICanBoogie\ActiveRecord\Statement::execute().

Alias of ICanBoogie\ActiveRecord\Statement::execute().

The arguments can be provided as an array or a list of arguments:

$statement(1, 2, 3);
$statement([ 1, 2, 3 ]);

Returns

ICanBoogie\ActiveRecord\Statement
$this
public __toString( void )

Return the queryString property of the statement.

Return the queryString property of the statement.

public execute( $args = [] )

Executes the statement.

Executes the statement.

The connection queries count is incremented.

Throws

ICanBoogie\ActiveRecord\StatementNotValid
when the execution of the statement fails.

Inheritdoc

Overrides

PDOStatement::execute
public mode( ... $mode ) : ICanBoogie\ActiveRecord\Statement

Set the fetch mode for the statement.

Set the fetch mode for the statement.

Parameters

$mode

Returns

ICanBoogie\ActiveRecord\Statement
Return the instance.

Throws

ICanBoogie\ActiveRecord\UnableToSetFetchMode
if the mode cannot be set.

See

http://www.php.net/manual/en/pdostatement.setfetchmode.php
public one( integer $fetch_style = \PDO::FETCH_BOTH, integer $cursor_orientation = \PDO::FETCH_ORI_NEXT, integer $cursor_offset = 0 ) : mixed

Fetches the first row of the result set and closes the cursor.

Fetches the first row of the result set and closes the cursor.

Parameters

$fetch_style
$cursor_orientation
$cursor_offset

Returns

mixed

See

PDOStatement::fetch()
protected get_one( void )

Alias for one().

Alias for one().

protected get_rc( void ) : string

Fetches the first column of the first row of the result set and closes the cursor.

Fetches the first column of the first row of the result set and closes the cursor.

Returns

string

See

PDOStatement::fetchColumn()
public all( ... $mode ) : array

Alias for \PDOStatement::fetchAll()

Alias for \PDOStatement::fetchAll()

Parameters

$mode

Returns

array
protected get_all( void )

Alias for all().

Alias for all().

protected get_pairs( void ) : array

Alias for all(\PDO::FETCH_KEY_PAIR).

Alias for all(\PDO::FETCH_KEY_PAIR).

Returns

array

An array of key/value pairs, where key is the value of the first column and value the value of the second column.

Methods inherited from PDOStatement

__sleep(), __wakeup(), bindColumn(), bindParam(), bindValue(), closeCursor(), columnCount(), debugDumpParams(), errorCode(), errorInfo(), fetch(), fetchAll(), fetchColumn(), fetchObject(), getAttribute(), getColumnMeta(), nextRowset(), rowCount(), setAttribute(), setFetchMode()

Properties summary

Properties inherited from PDOStatement

$queryString

Magic properties

public $connection : ICanBoogie\ActiveRecord\Connection

Connection associated with the statement.

public read-only $all : array

An array with the matching records.

public read-only $pairs : array

An array of key/value pairs, where key is the value of the first column and value the value of the second column.

public read-only $one : mixed

The first matching record.

public read-only $rc : string

The value of the first column of the first row.

ActiveRecord 4.0.x – Check on GitHub – API documentation generated by ApiGen