ICanBoogie
  • Documentation
  • API Reference
  • ActiveRecord v2.2.0
Namespaces
  • ICanBoogie
    • ActiveRecord
Classes
  • ActiveRecordCacheBase
  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • DateTimePropertySupport
  • HasManyRelation
  • Helpers
  • Model
  • ModelCollection
  • Query
  • Relation
  • RelationCollection
  • RelationNotDefined
  • RunTimeActiveRecordCache
  • Statement
  • Table
Interfaces
  • ActiveRecordCache
  • Exception
Traits
  • CreatedAtProperty
  • DateTimeProperty
  • UpdatedAtProperty
Exceptions
  • ActiveRecordClassNotValid
  • ConnectionAlreadyEstablished
  • ConnectionNotDefined
  • ConnectionNotEstablished
  • ModelAlreadyInstantiated
  • ModelNotDefined
  • RecordNotFound
  • ScopeNotDefined
  • StatementNotValid
  • UnableToSetFetchMode

Class Statement

A database statement.

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

Methods summary

public __invoke( void )

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 ]);
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( mixed $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 fetchAndClose( 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 fetchAndClose().

Alias for fetchAndClose().

public fetchColumnAndClose( integer $column_number = 0 ) : string

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

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

Parameters

$column_number

Returns

string

See

PDOStatement::fetchColumn()
protected get_rc( void )

Alias for fetchColumnAndClose().

Alias for fetchColumnAndClose().

public all( $fetch_style = null, $column_index = null, array $ctor_args = null )

Alias for \PDOStatement::fetchAll()

Alias for \PDOStatement::fetchAll()

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

public $connection : ICanBoogie\ActiveRecord\Connection

The database connection that created this statement.

The database connection that created this statement.


		

		


		
Properties inherited from PDOStatement

		

			$queryString
		



		
Magic properties

		

		

			
			
				
				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 v2.2.0
        – Check on GitHub
        – API documentation generated by ApiGen