class.CollectionCore.md

Class CollectionCore

Create a collection of ObjectModel objects

• Class name: CollectionCore
• Source: classes/Collection.php line 33
• This class implements: Iterator, ArrayAccess, Countable

Contents

Properties

• $alias
• $alias_iterator
• $classname
• $definition
• $fields
• $id_lang
• $is_hydrated
• $iterator
• $query
• $results
• $total

Methods

• __construct
• count
• current
• formatValue
• generateAlias
• getAll
• getFieldInfo
• getResults
• groupBy
• key
• next
• offsetExists
• offsetGet
• offsetSet
• offsetUnset
• orderBy
• parseField
• parseFields
• rewind
• sqlWhere
• valid
• where

Properties

$alias

protected mixed $alias = array()

• Visibility: protected
• Source: classes/Collection.php line 76.

$alias_iterator

protected mixed $alias_iterator

• Visibility: protected
• Source: classes/Collection.php line 77.

$classname

protected string $classname

• Visibility: protected
• Source: classes/Collection.php line 38.

$definition

protected array $definition = array()

• Visibility: protected
• Source: classes/Collection.php line 48.

$fields

protected mixed $fields = array()

• Visibility: protected
• Source: classes/Collection.php line 75.

$id_lang

protected integer $id_lang

• Visibility: protected
• Source: classes/Collection.php line 43.

$is_hydrated

protected boolean $is_hydrated = false

• Visibility: protected
• Source: classes/Collection.php line 63.

$iterator

protected integer $iterator

• Visibility: protected
• Source: classes/Collection.php line 68.

$query

protected \DbQuery $query

• Visibility: protected
• Source: classes/Collection.php line 53.

$results

protected array $results = array()

• Visibility: protected
• Source: classes/Collection.php line 58.

$total

protected integer $total

• Visibility: protected
• Source: classes/Collection.php line 73.

Methods

__construct

mixed CollectionCore::__construct(string $classname, integer $id_lang)

• Visibility: public
• Source: classes/Collection.php line 83

Arguments

• $classname string
• $id_lang integer

count

integer CollectionCore::count()

Get total of results

• Visibility: public
• Source: classes/Collection.php line 307

current

\ObjectModel CollectionCore::current()

Get current result

• Visibility: public
• Source: classes/Collection.php line 264

formatValue

mixed CollectionCore::formatValue(mixed $value, string $field)

Format a value with the type of the given field

• Visibility: protected
• Source: classes/Collection.php line 404

Arguments

• $value mixed
• $field string - Field name

generateAlias

string CollectionCore::generateAlias(string $association)

Generate uniq alias from association name

• Visibility: protected
• Source: classes/Collection.php line 455

Arguments

• $association string - Use empty association for alias on current table

getAll

\Collection CollectionCore::getAll(boolean $display_query)

Launch sql query to create collection of objects

• Visibility: public
• Source: classes/Collection.php line 219

Arguments

• $display_query boolean - If true, query will be displayed (for debug purpose)

getFieldInfo

array CollectionCore::getFieldInfo(string $field)

Obtain some informations on a field (alias, name, type, etc.)

• Visibility: protected
• Source: classes/Collection.php line 423

Arguments

• $field string - Field name

getResults

array CollectionCore::getResults()

Get results array

• Visibility: public
• Source: classes/Collection.php line 239

groupBy

\Collection CollectionCore::groupBy(string $field)

Add GROUP BY restriction on query

• Visibility: public
• Source: classes/Collection.php line 207

Arguments

• $field string - Field name

key

integer CollectionCore::key()

Get current result index

• Visibility: public
• Source: classes/Collection.php line 286

next

mixed CollectionCore::next()

Go to next result

• Visibility: public
• Source: classes/Collection.php line 296

offsetExists

boolean CollectionCore::offsetExists($offset)

Check if a result exist

• Visibility: public
• Source: classes/Collection.php line 320

Arguments

• $offset mixed

offsetGet

\ObjectModel CollectionCore::offsetGet($offset)

Get a result by offset

• Visibility: public
• Source: classes/Collection.php line 333

Arguments

• $offset mixed

offsetSet

mixed CollectionCore::offsetSet($offset, $value)

Add an element in the collection

• Visibility: public
• Source: classes/Collection.php line 348

Arguments

• $offset mixed
• $value mixed

offsetUnset

mixed CollectionCore::offsetUnset($offset)

Delete an element from the collection

• Visibility: public
• Source: classes/Collection.php line 366

Arguments

• $offset mixed

orderBy

\Collection CollectionCore::orderBy(string $field, string $order)

Add ORDER BY restriction on query

• Visibility: public
• Source: classes/Collection.php line 192

Arguments

• $field string - Field name
• $order string - asc|desc

parseField

string CollectionCore::parseField(string $field)

Replace a field with its SQL version (E.g. manufacturer.name with a2.name)

• Visibility: protected
• Source: classes/Collection.php line 392

Arguments

• $field string - Field name

parseFields

string CollectionCore::parseFields(string $str)

Parse all fields with {field} syntax in a string

• Visibility: protected
• Source: classes/Collection.php line 378

Arguments

• $str string

rewind

mixed CollectionCore::rewind()

This method is called when a foreach begin

• Visibility: public
• Source: classes/Collection.php line 250

sqlWhere

mixed CollectionCore::sqlWhere(string $sql)

Add WHERE restriction on query using real SQL syntax

• Visibility: public
• Source: classes/Collection.php line 179

Arguments

• $sql string

valid

boolean CollectionCore::valid()

Check if there is a current result

• Visibility: public
• Source: classes/Collection.php line 275

where

\Collection CollectionCore::where(string $field, string $operator, mixed $value)

Add WHERE restriction on query

• Visibility: public
• Source: classes/Collection.php line 119

Arguments

• $field string - Field name
• $operator string - List of operators : =, !=, , =, like, notlike, regexp, notregexp
• $value mixed