Documentation

RecordHistoryList extends ModelList
in package

FinalYes
Tags
author

Ramone Burrell ramone@ramoneburrell.com

uses
ModelList
since

Version 0.1.0

Table of Contents

Properties

$hashCode  : int
$hashCounter  : int
$ids  : array<string|int, mixed>
$loaded  : string
$objects  : ArrayObject
$position  : int
$select_options  : array<string|int, mixed>
$statement  : IStatement
$total_matches  : int
$unit_class  : string
$unit_class_instance  : IModel

Methods

__call()  : mixed
__callStatic()  : mixed
__construct()  : mixed
__destruct()  : mixed
__get()  : mixed
addGroupBy()  : IQueryBuilder
addOrderBy()  : IQueryBuilder
andHaving()  : IQueryBuilder
andWhere()  : IQueryBuilder
count()  : int
{@inheritdoc}
current()  : mixed
{@inheritdoc}
delete()  : ModelList
Deletes all the objects within this list
each()  : mixed
Calls a method on each object within this list and returns a reference to this instance
extends()  : bool
filter()  : bool
Filters the objects within this list by a set of respective fields and values.
findAll()  : ModelList
first()  : mixed
getIds()  : array<string|int, mixed>
Gets an array of ids for all the objects that are within this list.
getObjects()  : ArrayObject
Gets an instance of the ArrayObject set for this instance
getReflection()  : ReflectionClass
getSelectOptions()  : array<string|int, mixed>
Creates and array from the set of objects that are within this list that represents a set of options that can be used in an HTML dropdown select field
getStatement()  : IStatement
getTotalMatches()  : int
The total number of records / rows that were matched from the underlying query used to select items for this list
getUnitClassInstance()  : IModel
Gets the instance of the unit class for this list class instance
groupBy()  : IQueryBuilder
having()  : IQueryBuilder
isUnitClassAllowedAttribute()  : bool
Determines whether or not a provded value, as an attribute, is an allowed attribute of the unit class this list class corresponds with
key()  : mixed
{@inheritdoc}
limit()  : ModelList
next()  : void
{@inheritdoc}
offsetExists()  : bool
{@inheritdoc}
offsetGet()  : mixed
{@inheritdoc}
offsetSet()  : void
{@inheritdoc}
offsetUnset()  : void
{@inheritdoc}
orderBy()  : IQueryBuilder
orHaving()  : IQueryBuilder
orWhere()  : IQueryBuilder
rewind()  : void
{@inheritdoc}
save()  : ModelList
Saves all the objects within this list
valid()  : bool
{@inheritdoc}
where()  : IQueryBuilder
init()  : mixed
append()  : void
Adds an additional object to this list
determineUnitClass()  : ModelList
getObjectsFromStatement()  : void
getUnitClass()  : string
Gets the unit class for this class / instance
setTotalMatches()  : mixed

Properties

Methods

__callStatic()

public static __callStatic(mixed $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : mixed
$arguments : array<string|int, mixed>

__get()

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

count()

{@inheritdoc}

public count() : int
Tags
see
Countable::count()
Return values
int

current()

{@inheritdoc}

public current() : mixed
Tags
see
Iterator::current()

delete()

Deletes all the objects within this list

public delete() : ModelList
Return values
ModelList —

The instance of this model list for method chaining, unless an exception is thrown within the process

each()

Calls a method on each object within this list and returns a reference to this instance

public each(callable $function) : mixed
Parameters
$function : callable

This method will always return true in the case that an exception is not thrown in the process.

extends()

public extends(ReflectionClass $reflector) : bool
Parameters
$reflector : ReflectionClass
Return values
bool

filter()

Filters the objects within this list by a set of respective fields and values.

public filter(mixed $field, mixed $value) : bool
Parameters
$field : mixed

The field or fields to filter the objects by

$value : mixed

The value or values for the specified fields / attributes to filter this objects of the list by

Return values
bool —

False if the $field or $value params are empty true otherwise

getIds()

Gets an array of ids for all the objects that are within this list.

public getIds() : array<string|int, mixed>
Tags
see
IModelList::getIds()
Return values
array<string|int, mixed> —

The ids of the objects that are within this list.

getObjects()

Gets an instance of the ArrayObject set for this instance

public getObjects() : ArrayObject
Return values
ArrayObject —

The ArrayObject set of items loaded for this instance

getReflection()

public getReflection() : ReflectionClass
Return values
ReflectionClass

getSelectOptions()

Creates and array from the set of objects that are within this list that represents a set of options that can be used in an HTML dropdown select field

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

An array of options with the ids of the objects as keys and either title title, name or label attribute of the objects as values.

getTotalMatches()

The total number of records / rows that were matched from the underlying query used to select items for this list

public getTotalMatches() : int
Tags
see
IModelList::getTotalMatches()
Return values
int —

The total number of items that were matched

getUnitClassInstance()

Gets the instance of the unit class for this list class instance

public getUnitClassInstance() : IModel
Return values
IModel —

A reference to the instance of the unit class instance for this list class

isUnitClassAllowedAttribute()

Determines whether or not a provded value, as an attribute, is an allowed attribute of the unit class this list class corresponds with

public isUnitClassAllowedAttribute(mixed $attribute) : bool
Parameters
$attribute : mixed
Return values
bool —

TRUE if the atribute is an allowed attribute of the unit class, FALSE otherwise

next()

{@inheritdoc}

public next() : void
Tags
see
Iterator::next()

offsetExists()

{@inheritdoc}

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Tags
see
ArrayAccess::offsetExists()
Return values
bool

offsetGet()

{@inheritdoc}

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Tags
see
ArrayAccess::offsetGet()

offsetSet()

{@inheritdoc}

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Tags
see
ArrayAccess::offsetSet()

offsetUnset()

{@inheritdoc}

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed
Tags
see
ArrayAccess::offsetUnset()

rewind()

{@inheritdoc}

public rewind() : void
Tags
see
Iterator::rewind()

save()

Saves all the objects within this list

public save() : ModelList
Return values
ModelList —

The instance of this model list for method chaining, unless an exception is thrown within the process

valid()

{@inheritdoc}

public valid() : bool
Tags
see
Iterator::valid()
Return values
bool

getUnitClass()

Gets the unit class for this class / instance

private getUnitClass() : string
Return values
string —

$unit_class The unit class for this class / instance

setTotalMatches()

private setTotalMatches(int $total_matches) : mixed
Parameters
$total_matches : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results