SQLRepositoryProxy extends RepositoryProxy implements ISQLRepository
A proxy/decorator base class for the ISaveableObjectFactory interface
Table of Contents
| $repo | repo | ISQLRepository |
|---|---|---|
| $repo | Repo | IRepository |
| $factory | Factory | IObjectFactory |
| __construct() | Create a new proxy instance | mixed |
| query() | Query the data source. | \buffalokiwi\magicgraph\IModel[] |
| getTable() | Retrieve the database table name backing this repository. | string |
| getDatabaseConnection() | Retrieve the database connection | IDBConnection |
| lockTable() | Lock the table via "lock tables". | void |
| unlockTable() | Unlock the tables obtained by lockTable() This also commits. | void |
| getLock() | Attempts to obtain a lock for this table via GET_LOCK(). | void |
| releaseLock() | Release the lock obtained by getLock() | void |
| isTableLocked() | If the table is locked via lock tables. | bool |
| isLocked() | If there is a lock in effect via GET_LOCK() | bool |
| getPage() | Retrieve user records by page. | array |
| getRepo() | Get the stored repo | ISQLRepository |
| __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
$repo
repo
private
ISQLRepository
$repo
$repo
Repo
private
IRepository
$repo
$factory
Factory
private
IObjectFactory
$factory
Methods
__construct()
Create a new proxy instance
public
__construct(
$repo :
IRepository
)
: mixed
Parameters
- $repo : IRepository
Return values
mixedquery()
Query the data source.
public
query(
$properties :
IBigSet
, $filter :
IFilter
[, $rows :
IRows
= null ]
)
: \buffalokiwi\magicgraph\IModel[]
Parameters
- $properties : IBigSet
Properties to return
- $filter : IFilter
Filters to use
- $rows : IRows = null
Sort order and limit
Tags
Return values
\buffalokiwi\magicgraph\IModel[] —model instances
getTable()
Retrieve the database table name backing this repository.
public
getTable(
)
: string
Return values
string —database table name
getDatabaseConnection()
Retrieve the database connection
public
getDatabaseConnection(
)
: IDBConnection
Return values
IDBConnection —database connection
lockTable()
Lock the table via "lock tables".
public
lockTable(
)
: void
Disables autocommit.
unlockTable()
Unlock the tables obtained by lockTable() This also commits.
public
unlockTable(
)
: void
getLock()
Attempts to obtain a lock for this table via GET_LOCK().
public
getLock(
)
: void
This blocks until one can be obtained.
releaseLock()
Release the lock obtained by getLock()
public
releaseLock(
)
: void
isTableLocked()
If the table is locked via lock tables.
public
isTableLocked(
)
: bool
Return values
bool —locked
isLocked()
If there is a lock in effect via GET_LOCK()
public
isLocked(
)
: bool
Return values
bool —is locked
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 —IUser[] Users
getRepo()
Get the stored repo
protected
final getRepo(
)
: ISQLRepository
Tags
Return values
ISQLRepository__construct()
public
__construct(
$factory :
IObjectFactory
)
: mixed
Parameters
- $factory : IObjectFactory
Return values
mixed__call()
public
__call(
$name :
mixed
, $arguments :
mixed
)
: mixed
Parameters
- $name : mixed
- $arguments : mixed
Return values
mixedgetSaveFunction()
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
IRunnablecreateUnitOfWork()
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
Tags
Return values
Generator —yielded results
get()
Load some record by primary key
public
get(
...$id :
string
)
: IModel
Parameters
- $id : string
id
Tags
Return values
IModel —model instance
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
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
Return values
arrayfindByProperty()
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
Return values
arraycount()
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
boolsave()
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
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
remove()
Removes a model.
public
remove(
$model :
IModel
)
: void
Parameters
- $model : IModel
Model to remove
Tags
removeById()
Remove an entry by id. This does not work for compound keys.
public
removeById(
$id :
string
)
: void
Parameters
- $id : string
id
Tags
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
Return values
IModel —model instance
createPropertyNameSet()
Retrieves a set containing the property names.
public
createPropertyNameSet(
)
: IBigSet
Return values
IBigSet —set
createPropertySet()
Clones and returns the internal property set used to construct objects.
public
createPropertySet(
)
: IPropertySet
Return values
IPropertySet —property 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