includes/class/Collection.class.php
Show:
inherited
inherited
Classes
Broker
- Package
- Broker
\Broker\Collection
Package: Broker
Collection
- Parent(s)
- \Broker\Database
- Inherited_from
- \Broker\Database
Properties
string $classnameClassname
Details
- Type
- string
\Broker\unknown $configurationConfiguration
Details
- Type
- \Broker\unknown
\PDO $databaseDatabase
Details
- Type
- \PDO
string $filenameFilename
Details
- Type
- string
Methods
__construct(string $directory, \Broker\unknown $configuration) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $directory | string | |
| $configuration | \Broker\unknown |
__construct(string $directory, \Broker\unknown $configuration, string $classname) : voidinherited
Constructor
Inherited from:Parameters
| Name | Type | Description |
|---|---|---|
| $directory | string | |
| $configuration | \Broker\unknown | |
| $classname | string |
_create(\Broker\unknown $configuration, \Broker\unknown $filter, \Broker\unknown $condition, string $field, string $collectionId) : stringCreate
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $configuration | \Broker\unknown | |
| $filter | \Broker\unknown | |
| $condition | \Broker\unknown | |
| $field | string | |
| $collectionId | string |
| Type | Description |
|---|---|
| string |
check(string $key, \Broker\number $recheckTime = 60) : arrayCheck
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $recheckTime | \Broker\number |
| Type | Description |
|---|---|
| array |
clean() : voidClean
create(\Broker\unknown $configuration, \Broker\unknown $filter, \Broker\unknown $condition, string $field) : stringCreate
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $configuration | \Broker\unknown | |
| $filter | \Broker\unknown | |
| $condition | \Broker\unknown | |
| $field | string |
| Type | Description |
|---|---|
| string |
createFromCollection(\Broker\unknown $configuration, string $collectionId) : stringCreate from collection
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $configuration | \Broker\unknown | |
| $collectionId | string |
| Type | Description |
|---|---|
| string |
createHash(\Broker\unknown $configuration, \Broker\unknown $filter, \Broker\unknown $condition, \Broker\unknown $field, \Broker\unknown $collectionId) : arraystatic
Create hash
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $configuration | \Broker\unknown | |
| $filter | \Broker\unknown | |
| $condition | \Broker\unknown | |
| $field | \Broker\unknown | |
| $collectionId | \Broker\unknown |
| Type | Description |
|---|---|
| array |
delete(string $key) : voidDelete
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string |
doCheck(string $key, boolean $dontReintialise = false) : booleanDo check
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $dontReintialise | boolean |
| Type | Description |
|---|---|
| boolean |
doInitialise(string $key) : voidDo initialise
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string |
errorCheck(string $source, \PDOStatement $query, boolean $removeDatabase) : voidinherited
Check for errors
Inherited from:Parameters
| Name | Type | Description |
|---|---|---|
| $source | string | |
| $query | \PDOStatement | |
| $removeDatabase | boolean |
generateKey(\Broker\number $length = 20) : stringGenerate key
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $length | \Broker\number |
| Type | Description |
|---|---|
| string |
get(string $key) : arrayGet
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| array |
getList(\Broker\number $start, \Broker\number $number) : arrayGet list
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $start | \Broker\number | |
| $number | \Broker\number |
| Type | Description |
|---|---|
| array |
getWithDependencies(array $keys) : arrayGet with dependencies
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $keys | array |
| Type | Description |
|---|---|
| array |
init() : voidInitialize
init() : voidabstractinherited
Init
Inherited from:number() : \Broker\numberinherited
Get number
Inherited from:Returns
| Type | Description |
|---|---|
| \Broker\number |
reset() : voidinherited
Reset
Inherited from:setChecked(string $key, string $solrCheckStatus) : voidSet checked
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $solrCheckStatus | string |
setCreated(string $key, string $solrCreateStatus) : voidSet created
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $solrCreateStatus | string |
setInitialised(string $key, \Broker\unknown $configuration, string $solrUrl, string $solrCreateRequest, string $solrCheckRequest, string $solrShards, string $collectionIds) : voidSet initialised
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $configuration | \Broker\unknown | |
| $solrUrl | string | |
| $solrCreateRequest | string | |
| $solrCheckRequest | string | |
| $solrShards | string | |
| $collectionIds | string |
setUnchecked(string $key, string $solrCheckStatus = null) : voidSet unchecked
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $solrCheckStatus | string |
setUncreated(string $key, string $solrCreateStatus) : voidSet uncreated
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $solrCreateStatus | string |
setUninitialised(string $key) : voidSet uninitialised
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string |