Documentation

ServiceableRepository extends RepositoryProxy

A proxy/decorator base class for the ISaveableObjectFactory interface

Table of Contents

$tfact Transaction factory ITransactionFactory
$providers Property providers \buffalokiwi\magicgraph\IModelPropertyProvider[]
$repo Repo IRepository
$repo Repo IRepository
$factory Factory IObjectFactory
__construct() Create a new proxy instance mixed
getSaveFunction() Retrieve an IRunnable instance to be used with some ITransaction instance. IRunnable
save() Save some record. void
saveAll() Saves a batch of records. void
__construct() mixed
__call() mixed
getSaveFunction() Retrieve an IRunnable instance to be used with some ITransaction instance. IRunnable
createUnitOfWork() Create a unit of work against the repo. IRunnable
stream() Stream the data one record at a time from the data source. This may not always be implemented. Generator
get() Load some record by primary key IModel
getAll() Retrieve a list of models by a list of primary key values. \buffalokiwi\magicgraph\IModel[]
getPage() Retrieve user records by page. array
getIdsForProperty() Retrieve a list of id's for some property. array
getForProperty() Retrieve a list of models where some property name matches some value. array
findByProperty() Perform a simple search by property name. array
count() Retrieve the estimated record count. int
exists() Tests to see if some value exists by primary key bool
save() Save some record. void
saveAll() Saves a batch of records. void
remove() Removes a model. void
removeById() Remove an entry by id. This does not work for compound keys. void
create() Create a new Model instance using the internal data mapper. IModel
createPropertyNameSet() Retrieves a set containing the property names. IBigSet
createPropertySet() Clones and returns the internal property set used to construct objects. IPropertySet
addPropertyConfig() Adds an additional property config to this repo. mixed

Properties

Methods

getSaveFunction()

Retrieve an IRunnable instance to be used with some ITransaction instance.

public getSaveFunction( $beforeSave : Closure , $afterSave : Closure , ...$models : IModel ) : IRunnable

This runnable will execute the supplied function prior to saving the model.

Parameters
$beforeSave : Closure

What to run prior to saving f( IRepository, ...IModel )

$afterSave : Closure

What to run after saving f( IRepository, ...IModel )

$models : IModel

One or more models to save

Return values
IRunnable

save()

Save some record.

public save( $model : IModel [, $validate : bool = true ] ) : void

If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.

Parameters
$model : IModel

Model to save

$validate : bool = true

Validate the model prior to save.

Tags
throws
DBException

For DB errors

throws
ValidationException

if the model fails to validate

saveAll()

Saves a batch of records.

public saveAll( ...$model : IModel ) : void

All records are first validated, then saved sequentially. Validation exceptions will be thrown prior to any saves happening.

If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.

Parameters
$model : IModel

Model to save

Tags
throws
DBException

For DB errors

throws
ValidationException

if the model fails to validate

__call()

public __call( $name : mixed , $arguments : mixed ) : mixed
Parameters
$name : mixed
$arguments : mixed
Return values
mixed

getSaveFunction()

Retrieve an IRunnable instance to be used with some ITransaction instance.

public getSaveFunction( $beforeSave : Closure , $afterSave : Closure , ...$models : IModel ) : IRunnable

This runnable will execute the supplied function prior to saving the model.

Parameters
$beforeSave : Closure

What to run prior to saving f( IRepository, ...IModel )

$afterSave : Closure

What to run after saving f( IRepository, ...IModel )

$models : IModel

One or more models to save

Return values
IRunnable

createUnitOfWork()

Create a unit of work against the repo.

public createUnitOfWork( $action : Closure ) : IRunnable
Parameters
$action : Closure

f( IRepository $repo ) : void - What to do

Return values
IRunnable —

Runnable

stream()

Stream the data one record at a time from the data source. This may not always be implemented.

public stream( $properties : IBigSet , $filter : IFilter [, $rows : IRows = null ] ) : Generator
Parameters
$properties : IBigSet
$filter : IFilter

Filters to use

$rows : IRows = null

Sort order and limit

Tags
throws
DBException

For db errors

Return values
Generator —

yielded results

getAll()

Retrieve a list of models by a list of primary key values.

public getAll( $idList : array ) : \buffalokiwi\magicgraph\IModel[]
Parameters
$idList : array

id list

Tags
throws
DBException

For DB Errors

Return values
\buffalokiwi\magicgraph\IModel[] —

found models

getPage()

Retrieve user records by page.

public getPage( $page : int [, $size : int = 25 ] [, $orderBy : string = '' ] ) : array
Parameters
$page : int

Page number

$size : int = 25

page size

$orderBy : string = ''
Return values
array —

IModel[] Model

getIdsForProperty()

Retrieve a list of id's for some property.

public getIdsForProperty( $propertyName : string , $value : string ) : array

If primary key is compound, then each returned element will be an array (map) listing each key.

Parameters
$propertyName : string

Property Name

$value : string

value

Return values
array —

ids

getForProperty()

Retrieve a list of models where some property name matches some value.

public getForProperty( $propertyName : string , $value : mixed ) : array
Parameters
$propertyName : string

Property name

$value : mixed

value

Tags
throws
Exception
Return values
array

findByProperty()

Perform a simple search by property name.

public findByProperty( $propertyName : string , $value : string [, $limit : int = 100 ] ) : array

If the engine supports simple searching, this can be used for that. For example: With SQL databases, this can simply be a wildcard search. Also possible to use full text indexes or whatever else the engine supports.

Depending on the repo, this could connect to any number of things for searching.

Parameters
$propertyName : string

Property name

$value : string

Search value. What this is depends on the engine.

$limit : int = 100
Tags
throws
InvalidArgumentException
Return values
array

count()

Retrieve the estimated record count.

public count( [ $full : bool = false ] ) : int
Parameters
$full : bool = false

Set to true to retrieve count(*), set to false for max(primary key)

Return values
int —

estimated number of records

exists()

Tests to see if some value exists by primary key

public exists( ...$id : string ) : bool
Parameters
$id : string
Return values
bool

save()

Save some record.

public save( $model : IModel [, $validate : bool = true ] ) : void

If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.

Parameters
$model : IModel

Model to save

$validate : bool = true

Validate the model prior to save

Tags
throws
DBException

For DB errors

throws
ValidationException

if the model fails to validate

saveAll()

Saves a batch of records.

public saveAll( ...$model : IModel ) : void

All records are first validated, then saved sequentially. Validation exceptions will be thrown prior to any saves happening.

If the primary key value is specified, this is considered to be an update. Otherwise, this is considered to be an insert.

Parameters
$model : IModel

Model to save

Tags
throws
DBException

For DB errors

throws
ValidationException

if the model fails to validate

create()

Create a new Model instance using the internal data mapper.

public create( $data : array [, $readOnly : bool = false ] ) : IModel
Parameters
$data : array

Raw data to use

$readOnly : bool = false

Set the produced model to read only

Tags
throws
DBException

For db errors

Return values
IModel —

model instance

createPropertyNameSet()

Retrieves a set containing the property names.

public createPropertyNameSet( ) : IBigSet
Return values
IBigSet —

set

addPropertyConfig()

Adds an additional property config to this repo.

public addPropertyConfig( ...$config : type ) : mixed

When models reference themselves, sometimes it's necessary for a property config to reference the repository (circular).

Feels a bit like cheating to me...

Parameters
$config : type
Return values
mixed

Search results