From 9545387b4c63b4e71f036805ae5d312845339dac Mon Sep 17 00:00:00 2001 From: Chris Lloyd Date: Wed, 7 Apr 2021 18:41:48 +0100 Subject: [PATCH] WIP --- ...lat3-Lodata-Drivers-EloquentEntitySet.html | 442 ++--- ...Flat3-Lodata-Drivers-FilesystemEntity.html | 1571 ----------------- ...t3-Lodata-Drivers-FilesystemEntitySet.html | 431 +---- .../Flat3-Lodata-Drivers-RedisEntitySet.html | 401 +---- .../Flat3-Lodata-Drivers-SQLEntitySet.html | 423 ++--- .../Flat3-Lodata-Drivers-StaticEntitySet.html | 425 ++--- docs/classes/Flat3-Lodata-Entity.html | 46 +- docs/classes/Flat3-Lodata-EntitySet.html | 419 +---- ...a-Interfaces-EntitySet-CountInterface.html | 54 +- ...-Interfaces-EntitySet-ExpandInterface.html | 14 +- ...a-Interfaces-EntitySet-QueryInterface.html | 16 +- .../Flat3-Lodata-PathSegment-Count.html | 4 +- docs/classes/Flat3-Lodata-Singleton.html | 40 +- docs/files/src-drivers-filesystementity.html | 138 -- docs/js/searchIndex.js | 66 +- src/EntitySet.php | 2 + 16 files changed, 753 insertions(+), 3739 deletions(-) delete mode 100644 docs/classes/Flat3-Lodata-Drivers-FilesystemEntity.html delete mode 100644 docs/files/src-drivers-filesystementity.html diff --git a/docs/classes/Flat3-Lodata-Drivers-EloquentEntitySet.html b/docs/classes/Flat3-Lodata-Drivers-EloquentEntitySet.html index b8bc3d49a..455761ffd 100644 --- a/docs/classes/Flat3-Lodata-Drivers-EloquentEntitySet.html +++ b/docs/classes/Flat3-Lodata-Drivers-EloquentEntitySet.html @@ -95,14 +95,14 @@

implements - ReadInterface, UpdateInterface, CreateInterface, DeleteInterface, QueryInterface, FilterInterface, SearchInterface, ExpandInterface, OrderByInterface, TransactionInterface + ReadInterface, UpdateInterface, CreateInterface, DeleteInterface, QueryInterface, FilterInterface, SearchInterface, ExpandInterface, OrderByInterface, TransactionInterface, CountInterface

Eloquent Entity Set

@@ -140,6 +140,8 @@

OrderBy Interface
TransactionInterface
Transaction Interface
+
CountInterface
+
Count Interface
@@ -151,7 +153,14 @@

-
+
+ $emittedEntityCount + +  : int +
+
Running total of emitted entities
+ +
__construct()  : mixed @@ -194,11 +203,11 @@

- count() + count() -  : int|null +  : int
-
Count the number of results in the result buffer
+
Count the number of records matching the query
create() @@ -207,13 +216,6 @@

Create an Eloquent model
-
- current() - -  : null|Entity -
-
The current entity in the results buffer
-
delete() @@ -396,13 +398,6 @@

Get the OData entity type name for this Eloquent model
-
- key() - -  : PropertyValue -
-
Get the entity ID of the current entity in the results buffer
-
modelToEntity() @@ -417,13 +412,6 @@

Generate a new entity attached to this entity set instance
-
- next() - -  : void -
-
Move to the next entity in the results buffer
-
pipe() @@ -441,7 +429,7 @@

query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
Query eloquent models
@@ -466,13 +454,6 @@

-
- rewind() - -  : mixed -
-
Rewind the results buffer
-
rollback() @@ -480,13 +461,6 @@

-
- setMaxPageSize() - -  : $this -
-
Set the maximum pagination size to use with the service providing results into the buffer
-
setModel() @@ -529,14 +503,6 @@

Update an Eloquent model
-
- valid() - -  : bool -
-
Whether there is a current entity in the results buffer -Implements internal pagination
-

@@ -544,6 +510,44 @@

+
+

+ Properties + +

+
+

+ $emittedEntityCount + + + +

+ + +

Running total of emitted entities

+ + + private + int + $emittedEntityCount + = 0 + +
+ + + +
+

@@ -563,7 +567,7 @@

@@ -605,7 +609,7 @@

Add a navigation binding to this entity set

@@ -651,7 +655,7 @@

Generate trailing metadata for this entity set

@@ -712,7 +716,7 @@

Apply the filter system query option

@@ -758,7 +762,7 @@

Apply the search system query option

@@ -792,7 +796,7 @@

@@ -819,19 +823,19 @@

Return values
>

count() - +

-

Count the number of results in the result buffer

+

Count the number of records matching the query

public - count() : int|null + count() : int
@@ -839,9 +843,10 @@

Return values
- int|null + int — -
+

Count

+
@@ -858,7 +863,7 @@

Create an Eloquent model

@@ -879,41 +884,6 @@

Return values
- -
-

- current() - -

- - -

The current entity in the results buffer

- - - public - current() : null|Entity - -
- - - - -
Return values
- null|Entity - — -

Current entity

-
- -

Delete an Eloquent model

@@ -974,7 +944,7 @@

Create an entity set from the provided Eloquent model class and add it to the model

@@ -1020,7 +990,7 @@

Discover an Eloquent relationship method and add it to the model

@@ -1066,7 +1036,7 @@

Emit this item as valid JSON to the client response

@@ -1112,7 +1082,7 @@

Generate a new entity set definition

@@ -1182,7 +1152,7 @@

Read this entity set

@@ -1238,7 +1208,7 @@

EntitySet.php : - 303 + 163

Get the navigation binding for the provided navigation property on this entity set

@@ -1285,7 +1255,7 @@

Get the SQL type casts defined on this Eloquent model

@@ -1320,7 +1290,7 @@

Get the context URL for this entity set instance

@@ -1367,7 +1337,7 @@

Return the count option that applies to this entity set

@@ -1401,7 +1371,7 @@

Return the filter option that applies to this entity set

@@ -1435,7 +1405,7 @@

Get the OData kind of this resource

@@ -1470,7 +1440,7 @@

Return an instance of the Eloquent model using the provided key

@@ -1517,7 +1487,7 @@

Get the navigation bindings attached to this entity set

@@ -1551,7 +1521,7 @@

Return the orderby option that applies to this entity set

@@ -1585,7 +1555,7 @@

Get the resource URL for this entity set instance

@@ -1632,7 +1602,7 @@

Return the search option that applies to this entity set

@@ -1666,7 +1636,7 @@

Return this select option that applies to this entity set

@@ -1700,7 +1670,7 @@

Get selected properties

@@ -1735,7 +1705,7 @@

Get the OData entity set name for this Eloquent model

@@ -1782,7 +1752,7 @@

Return the skip option that applies to this entity set

@@ -1816,7 +1786,7 @@

Return the skip token option that applies to this entity set

@@ -1850,7 +1820,7 @@

Get the database table name used by the model

@@ -1885,7 +1855,7 @@

Return the top option that applies to this entity set

@@ -1919,7 +1889,7 @@

Get the entity type of this entity set

@@ -1954,7 +1924,7 @@

Get the OData entity type name for this Eloquent model

@@ -1987,41 +1957,6 @@

Return values
-
-
-

- key() - -

- - -

Get the entity ID of the current entity in the results buffer

- - - public - key() : PropertyValue - -
- - - - -
Return values
- PropertyValue - — -

Entity ID

-
- -

Convert an Eloquent model instance to an OData Entity

@@ -2083,7 +2018,7 @@

Generate a new entity attached to this entity set instance

@@ -2104,40 +2039,6 @@

Return values
-
-
-

- next() - -

- - -

Move to the next entity in the results buffer

- - - public - next() : void - -
- - - - -
Return values
- void - — -
- -

Path component handler

@@ -2226,7 +2127,7 @@

Convert an entity type property to a database field

@@ -2273,14 +2174,14 @@

Query eloquent models

public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
@@ -2288,10 +2189,9 @@

Return values
- array<string|int, mixed> + Generator|array<string|int, Entity> — -

Entity buffer

-
+
@@ -2308,7 +2208,7 @@

Read an Eloquent model

@@ -2355,7 +2255,7 @@

Get the entity ID of the entity this set was generated from using the attached expansion property value

@@ -2390,7 +2290,7 @@

@@ -2425,40 +2325,6 @@

Return values
- -
-

- rewind() - -

- - -

Rewind the results buffer

- - - public - rewind() : mixed - -
- - - - -
Return values
- mixed - — -
- -
@@ -2491,52 +2357,6 @@
Return values
-
-
-

- setMaxPageSize() - -

- - -

Set the maximum pagination size to use with the service providing results into the buffer

- - - public - setMaxPageSize(int $maxPageSize) : $this - -
- -
Parameters
-
-
- $maxPageSize - : int -
-
-

Maximum page size

-
- -
-
- - - -
Return values
- $this - — -
- -

Set the Eloquent model class name

@@ -2597,7 +2417,7 @@

Get the navigation property value that relates to this entity set instance

@@ -2643,7 +2463,7 @@

Set the context transaction this entity set instance should use

@@ -2689,7 +2509,7 @@

Set the entity type of this entity set

@@ -2735,7 +2555,7 @@

@@ -2767,7 +2587,7 @@

Update an Eloquent model

@@ -2800,42 +2620,6 @@

Return values
-
-
-

- valid() - -

- - -

Whether there is a current entity in the results buffer -Implements internal pagination

- - - public - valid() : bool - -
- - - - -
Return values
- bool - — -

Whether there is a valid entity in the current position of the buffer

-
- -
diff --git a/docs/classes/Flat3-Lodata-Drivers-FilesystemEntity.html b/docs/classes/Flat3-Lodata-Drivers-FilesystemEntity.html deleted file mode 100644 index 4fb4c7c6b..000000000 --- a/docs/classes/Flat3-Lodata-Drivers-FilesystemEntity.html +++ /dev/null @@ -1,1571 +0,0 @@ - - - - - Lodata - - - - - - - - - - - - - - - - - - -
-

Lodata

- - -
- -
- - -
- -
-
- - - - -
- - -
-

- FilesystemEntity - - - extends Entity - - - - -

- - - -

Entity

- -
- - - - - - - - -

- Table of Contents - -

- -
-
- __construct() - -  : mixed -
-
- -
- addProperty() - -  : $this -
-
Add a property value to this entity
- -
- delete() - -  : Response -
-
Delete this entity
- -
- emitJson() - -  : void -
-
Emit this item as valid JSON to the client response
- -
- fromArray() - -  : $this -
-
Generate an entity from an array of key/values
- -
- fromMetadata() - -  : self -
-
- -
- get() - -  : Response -
-
Read this entity
- -
- getContextUrl() - -  : string -
-
Get the context URL for this entity
- -
- getEntityId() - -  : PropertyValue|null -
-
Get the ID of this entity
- -
- getEntitySet() - -  : EntitySet|null -
-
Get the entity set that contains this entity
- -
- getETag() - -  : string -
-
Get the ETag for this entity
- -
- getPropertyValue() - -  : Primitive|null -
-
Get a property value attached to this entity
- -
- getPropertyValues() - -  : ObjectArray -
-
Get all property values attached to this entity
- -
- getResourceUrl() - -  : string -
-
Get the resource URL for this entity
- -
- getType() - -  : EntityType -
-
Get the entity type of this entity
- -
- newPropertyValue() - -  : PropertyValue -
-
Generate a new property value attached to this entity
- -
- offsetExists() - -  : bool -
-
Whether the provided property value exists on this entity
- -
- offsetGet() - -  : PropertyValue -
-
Get a property value from this entity
- -
- offsetSet() - -  : mixed -
-
Create a new property value on this entity
- -
- offsetUnset() - -  : mixed -
-
Remove a property value from this entity
- -
- patch() - -  : Response -
-
Update this entity
- -
- pipe() - -  : PipeInterface|null -
-
Path component handler
- -
- response() - -  : Response -
-
- -
- setEntityId() - -  : $this -
-
Set the ID of this entity
- -
- setEntitySet() - -  : $this -
-
Set the entity set that contains this entity
- -
- setType() - -  : $this -
-
Set the entity type of this entity
- -
- toArray() - -  : array<string|int, mixed> -
-
Convert this entity to a PHP array of key/value pairs
- -
- - - - - - - -
-

- Methods - -

-
-

- __construct() - -

- - - - - public - __construct() : mixed - - - - - -
Return values
- mixed - — -
- - -
-
-

- addProperty() - -

- - -

Add a property value to this entity

- - - public - addProperty(PropertyValue $propertyValue) : $this - -
- -
Parameters
-
-
- $propertyValue - : PropertyValue -
-
-

Property value

-
- -
-
- - - -
Return values
- $this - — -
- - -
- -
-

- emitJson() - -

- - -

Emit this item as valid JSON to the client response

- - - public - emitJson(Transaction $transaction) : void - -
- -
Parameters
-
-
- $transaction - : Transaction -
-
-

Transaction

-
- -
-
- - - -
Return values
- void - — -
- - -
-
-

- fromArray() - -

- - -

Generate an entity from an array of key/values

- - - public - fromArray(array<string|int, mixed> $object) : $this - -
- -
Parameters
-
-
- $object - : array<string|int, mixed> -
-
-

Key/value array

-
- -
-
- - - -
Return values
- $this - — -
- - -
-
-

- fromMetadata() - -

- - - - - public - fromMetadata(array<string|int, mixed> $metadata) : self - - -
Parameters
-
-
- $metadata - : array<string|int, mixed> -
-
- -
-
- - - -
Return values
- self - — -
- - -
- -
-

- getContextUrl() - -

- - -

Get the context URL for this entity

- - - public - getContextUrl(Transaction $transaction) : string - -
- -
Parameters
-
-
- $transaction - : Transaction -
-
-

Related transaction

-
- -
-
- - - -
Return values
- string - — -

Context URL

-
- - -
-
-

- getEntityId() - -

- - -

Get the ID of this entity

- - - public - getEntityId() : PropertyValue|null - -
- - - - -
Return values
- PropertyValue|null - — -

PropertyValue representing the entity ID

-
- - -
-
-

- getEntitySet() - -

- - -

Get the entity set that contains this entity

- - - public - getEntitySet() : EntitySet|null - -
- - - - -
Return values
- EntitySet|null - — -
- - -
-
-

- getETag() - -

- - -

Get the ETag for this entity

- - - public - getETag() : string - -
- - - - -
Return values
- string - — -

ETag

-
- - -
-
-

- getPropertyValue() - -

- - -

Get a property value attached to this entity

- - - public - getPropertyValue(Property $property) : Primitive|null - -
- -
Parameters
-
-
- $property - : Property -
-
-

Property

-
- -
-
- - - -
Return values
- Primitive|null - — -

Property value

-
- - -
-
-

- getPropertyValues() - -

- - -

Get all property values attached to this entity

- - - public - getPropertyValues() : ObjectArray - -
- - - - -
Return values
- ObjectArray - — -

Property values

-
- - -
-
-

- getResourceUrl() - -

- - -

Get the resource URL for this entity

- - - public - getResourceUrl(Transaction $transaction) : string - -
- -
Parameters
-
-
- $transaction - : Transaction -
-
-

Related transaction

-
- -
-
- - - -
Return values
- string - — -

Resource URL

-
- - -
-
-

- getType() - -

- - -

Get the entity type of this entity

- - - public - getType() : EntityType - -
- - - - -
Return values
- EntityType - — -

Entity type

-
- - -
-
-

- newPropertyValue() - -

- - -

Generate a new property value attached to this entity

- - - public - newPropertyValue() : PropertyValue - -
- - - - -
Return values
- PropertyValue - — -

Property value

-
- - -
-
-

- offsetExists() - -

- - -

Whether the provided property value exists on this entity

- - - public - offsetExists(mixed $offset) : bool - -
- -
Parameters
-
-
- $offset - : mixed -
-
-

Property name

-
- -
-
- - - -
Return values
- bool - — -
- - -
-
-

- offsetGet() - -

- - -

Get a property value from this entity

- - - public - offsetGet(mixed $offset) : PropertyValue - -
- -
Parameters
-
-
- $offset - : mixed -
-
-

Property name

-
- -
-
- - - -
Return values
- PropertyValue - — -

Property value

-
- - -
-
-

- offsetSet() - -

- - -

Create a new property value on this entity

- - - public - offsetSet(mixed $offset, mixed $value) : mixed - -
- -
Parameters
-
-
- $offset - : mixed -
-
-

Property name

-
- -
-
- $value - : mixed -
-
-

Property value

-
- -
-
- - - -
Return values
- mixed - — -
- - -
-
-

- offsetUnset() - -

- - -

Remove a property value from this entity

- - - public - offsetUnset(mixed $offset) : mixed - -
- -
Parameters
-
-
- $offset - : mixed -
-
-

Property name

-
- -
-
- - - -
Return values
- mixed - — -
- - -
- -
-

- pipe() - -

- - -

Path component handler

- - - public - static pipe(Transaction $transaction, string $currentSegment, string|null $nextSegment, PipeInterface|null $argument) : PipeInterface|null - -
- -
Parameters
-
-
- $transaction - : Transaction -
-
-

Related transaction

-
- -
-
- $currentSegment - : string -
-
-

The current path segment

-
- -
-
- $nextSegment - : string|null -
-
-

The next path segment

-
- -
-
- $argument - : PipeInterface|null -
-
-

The previous path segment

-
- -
-
- - - -
Return values
- PipeInterface|null - — -

The processed path segment if handled by this implementation

-
- - -
- -
-

- setEntityId() - -

- - -

Set the ID of this entity

- - - public - setEntityId(mixed $id) : $this - -
- -
Parameters
-
-
- $id - : mixed -
-
-

ID

-
- -
-
- - - -
Return values
- $this - — -
- - -
-
-

- setEntitySet() - -

- - -

Set the entity set that contains this entity

- - - public - setEntitySet(EntitySet $entitySet) : $this - -
- -
Parameters
-
-
- $entitySet - : EntitySet -
-
-

Entity set

-
- -
-
- - - -
Return values
- $this - — -
- - -
-
-

- setType() - -

- - -

Set the entity type of this entity

- - - public - setType(EntityType $type) : $this - -
- -
Parameters
-
-
- $type - : EntityType -
-
-

Entity type

-
- -
-
- - - -
Return values
- $this - — -
- - -
-
-

- toArray() - -

- - -

Convert this entity to a PHP array of key/value pairs

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

Record

-
- - -
-
- -
-
-
-
-

Search results

- -
-
-
    -
    -
    -
    -
    -
    - - -
    - - - - - - - diff --git a/docs/classes/Flat3-Lodata-Drivers-FilesystemEntitySet.html b/docs/classes/Flat3-Lodata-Drivers-FilesystemEntitySet.html index 57cf29ea1..45cc8506a 100644 --- a/docs/classes/Flat3-Lodata-Drivers-FilesystemEntitySet.html +++ b/docs/classes/Flat3-Lodata-Drivers-FilesystemEntitySet.html @@ -102,7 +102,7 @@

    Class FilesystemEntitySet

    @@ -148,6 +148,13 @@

    +
    + $emittedEntityCount + +  : int +
    +
    Running total of emitted entities
    +
    __construct() @@ -183,13 +190,6 @@

    Apply the search system query option
    -
    - count() - -  : int|null -
    -
    Count the number of results in the result buffer
    -
    create() @@ -197,13 +197,6 @@

    Create a filesystem entity
    -
    - current() - -  : null|Entity -
    -
    The current entity in the results buffer
    -
    delete() @@ -358,13 +351,6 @@

    Get the entity type of this entity set
    -
    - key() - -  : PropertyValue -
    -
    Get the entity ID of the current entity in the results buffer
    -
    newEntity() @@ -372,13 +358,6 @@

    Generate a new entity attached to this entity set instance
    -
    - next() - -  : void -
    -
    Move to the next entity in the results buffer
    -
    pipe() @@ -389,7 +368,7 @@

    query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
    Query
    @@ -414,13 +393,6 @@

    -
    - rewind() - -  : mixed -
    -
    Rewind the results buffer
    -
    setDisk() @@ -435,13 +407,6 @@

    Set the disk by name
    -
    - setMaxPageSize() - -  : $this -
    -
    Set the maximum pagination size to use with the service providing results into the buffer
    -
    setNavigationPropertyValue() @@ -470,14 +435,6 @@

    Update a filesystem entity
    -
    - valid() - -  : bool -
    -
    Whether there is a current entity in the results buffer -Implements internal pagination
    - @@ -506,7 +463,7 @@

    @@ -520,6 +477,38 @@

    + +
    +

    + $emittedEntityCount + + + +

    + + +

    Running total of emitted entities

    + + + private + int + $emittedEntityCount + = 0 + +
    + + +
    @@ -541,7 +530,7 @@

    @@ -590,7 +579,7 @@

    Add a navigation binding to this entity set

    @@ -636,7 +625,7 @@

    Generate trailing metadata for this entity set

    @@ -697,7 +686,7 @@

    Apply the filter system query option

    @@ -743,7 +732,7 @@

    Apply the search system query option

    @@ -763,40 +752,6 @@

    Return values
    - -
    -

    - count() - -

    - - -

    Count the number of results in the result buffer

    - - - public - count() : int|null - -
    - - - - -
    Return values
    - int|null - — -
    - -

    Create a filesystem entity

    @@ -832,41 +787,6 @@
    Return values
    -
    -
    -

    - current() - -

    - - -

    The current entity in the results buffer

    - - - public - current() : null|Entity - -
    - - - - -
    Return values
    - null|Entity - — -

    Current entity

    -
    - -

    Delete a filesystem entity

    @@ -927,7 +847,7 @@

    Emit this item as valid JSON to the client response

    @@ -973,7 +893,7 @@

    Generate a new entity set definition

    @@ -1043,7 +963,7 @@

    Create an entity from filesystem metadata

    @@ -1089,7 +1009,7 @@

    Read this entity set

    @@ -1145,7 +1065,7 @@

    EntitySet.php : - 303 + 163

    Get the navigation binding for the provided navigation property on this entity set

    @@ -1192,7 +1112,7 @@

    Get the context URL for this entity set instance

    @@ -1239,7 +1159,7 @@

    Return the count option that applies to this entity set

    @@ -1273,7 +1193,7 @@

    Get the attached disk

    @@ -1308,7 +1228,7 @@

    Get a disk path from the entity id

    @@ -1355,7 +1275,7 @@

    Return the filter option that applies to this entity set

    @@ -1389,7 +1309,7 @@

    Get the OData kind of this resource

    @@ -1424,7 +1344,7 @@

    Get the navigation bindings attached to this entity set

    @@ -1458,7 +1378,7 @@

    Return the orderby option that applies to this entity set

    @@ -1492,7 +1412,7 @@

    Get the resource URL for this entity set instance

    @@ -1539,7 +1459,7 @@

    Return the search option that applies to this entity set

    @@ -1573,7 +1493,7 @@

    Return this select option that applies to this entity set

    @@ -1607,7 +1527,7 @@

    Get selected properties

    @@ -1642,7 +1562,7 @@

    Return the skip option that applies to this entity set

    @@ -1676,7 +1596,7 @@

    Return the skip token option that applies to this entity set

    @@ -1710,7 +1630,7 @@

    Return the top option that applies to this entity set

    @@ -1744,7 +1664,7 @@

    Get the entity type of this entity set

    @@ -1765,41 +1685,6 @@

    Return values
    -
    -
    -

    - key() - -

    - - -

    Get the entity ID of the current entity in the results buffer

    - - - public - key() : PropertyValue - -
    - - - - -
    Return values
    - PropertyValue - — -

    Entity ID

    -
    - -

    Generate a new entity attached to this entity set instance

    @@ -1835,40 +1720,6 @@
    Return values
    -
    -
    -

    - next() - -

    - - -

    Move to the next entity in the results buffer

    - - - public - next() : void - -
    - - - - -
    Return values
    - void - — -
    - -

    Path component handler

    @@ -1964,7 +1815,7 @@

    public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
    @@ -1972,7 +1823,7 @@

    Return values
    - array<string|int, mixed> + Generator|array<string|int, Entity> —
    @@ -1991,7 +1842,7 @@

    Read a filesystem entity

    @@ -2037,7 +1888,7 @@

    Get the entity ID of the entity this set was generated from using the attached expansion property value

    @@ -2072,7 +1923,7 @@

    @@ -2107,40 +1958,6 @@

    Return values
    -
    -
    -

    - rewind() - -

    - - -

    Rewind the results buffer

    - - - public - rewind() : mixed - -
    - - - - -
    Return values
    - mixed - — -
    - -

    Set the disk by filesystem adaptor

    @@ -2201,7 +2018,7 @@

    Set the disk by name

    @@ -2233,52 +2050,6 @@

    Return values
    -
    -
    -

    - setMaxPageSize() - -

    - - -

    Set the maximum pagination size to use with the service providing results into the buffer

    - - - public - setMaxPageSize(int $maxPageSize) : $this - -
    - -
    Parameters
    -
    -
    - $maxPageSize - : int -
    -
    -

    Maximum page size

    -
    - -
    -
    - - - -
    Return values
    - $this - — -
    - -

    Get the navigation property value that relates to this entity set instance

    @@ -2339,7 +2110,7 @@

    Set the context transaction this entity set instance should use

    @@ -2385,7 +2156,7 @@

    Set the entity type of this entity set

    @@ -2431,7 +2202,7 @@

    Update a filesystem entity

    @@ -2464,42 +2235,6 @@

    Return values
    -
    -
    -

    - valid() - -

    - - -

    Whether there is a current entity in the results buffer -Implements internal pagination

    - - - public - valid() : bool - -
    - - - - -
    Return values
    - bool - — -

    Whether there is a valid entity in the current position of the buffer

    -
    - -
    diff --git a/docs/classes/Flat3-Lodata-Drivers-RedisEntitySet.html b/docs/classes/Flat3-Lodata-Drivers-RedisEntitySet.html index 0416263b0..fd101e6e5 100644 --- a/docs/classes/Flat3-Lodata-Drivers-RedisEntitySet.html +++ b/docs/classes/Flat3-Lodata-Drivers-RedisEntitySet.html @@ -95,14 +95,14 @@

    implements - CreateInterface, UpdateInterface, DeleteInterface, ReadInterface, QueryInterface, PaginationInterface + CreateInterface, UpdateInterface, DeleteInterface, ReadInterface, QueryInterface, PaginationInterface, CountInterface

    Class RedisEntitySet

    @@ -132,6 +132,8 @@

    Query Interface
    PaginationInterface
    Pagination Interface
    +
    CountInterface
    +
    Count Interface
    @@ -150,6 +152,13 @@

    +
    + $emittedEntityCount + +  : int +
    +
    Running total of emitted entities
    +
    __construct() @@ -199,13 +208,6 @@

    Create a new record
    -
    - current() - -  : null|Entity -
    -
    The current entity in the results buffer
    -
    delete() @@ -346,13 +348,6 @@

    Get the entity type of this entity set
    -
    - key() - -  : PropertyValue -
    -
    Get the entity ID of the current entity in the results buffer
    -
    newEntity() @@ -360,13 +355,6 @@

    Generate a new entity attached to this entity set instance
    -
    - next() - -  : void -
    -
    Move to the next entity in the results buffer
    -
    pipe() @@ -377,7 +365,7 @@

    query() -  : array<string|int, Entity> +  : Generator|array<string|int, Entity>
    Query the redis database
    @@ -402,13 +390,6 @@

    -
    - rewind() - -  : mixed -
    -
    Rewind the results buffer
    -
    serialize() @@ -430,13 +411,6 @@

    Set the name of the Redis database to use
    -
    - setMaxPageSize() - -  : $this -
    -
    Set the maximum pagination size to use with the service providing results into the buffer
    -
    setNavigationPropertyValue() @@ -472,14 +446,6 @@

    Update a record in the database
    -
    - valid() - -  : bool -
    -
    Whether there is a current entity in the results buffer -Implements internal pagination
    - @@ -508,7 +474,7 @@

    @@ -522,6 +488,38 @@

    + +
    +

    + $emittedEntityCount + + + +

    + + +

    Running total of emitted entities

    + + + private + int + $emittedEntityCount + = 0 + +
    + + +
    @@ -543,7 +541,7 @@

    @@ -592,7 +590,7 @@

    Add a navigation binding to this entity set

    @@ -638,7 +636,7 @@

    Generate trailing metadata for this entity set

    @@ -699,7 +697,7 @@

    Apply the filter system query option

    @@ -745,7 +743,7 @@

    Apply the search system query option

    @@ -779,7 +777,7 @@

    Count records in the database

    @@ -813,7 +811,7 @@

    Create a new record

    @@ -833,41 +831,6 @@

    Return values
    - -
    -

    - current() - -

    - - -

    The current entity in the results buffer

    - - - public - current() : null|Entity - -
    - - - - -
    Return values
    - null|Entity - — -

    Current entity

    -
    - -

    Delete a record from the database

    @@ -928,7 +891,7 @@

    Emit this item as valid JSON to the client response

    @@ -974,7 +937,7 @@

    Generate a new entity set definition

    @@ -1044,7 +1007,7 @@

    Read this entity set

    @@ -1100,7 +1063,7 @@

    EntitySet.php : - 303 + 163

    Get the navigation binding for the provided navigation property on this entity set

    @@ -1147,7 +1110,7 @@

    Get the Redis connection configured for this entity set

    @@ -1181,7 +1144,7 @@

    Get the context URL for this entity set instance

    @@ -1228,7 +1191,7 @@

    Return the count option that applies to this entity set

    @@ -1262,7 +1225,7 @@

    Return the filter option that applies to this entity set

    @@ -1296,7 +1259,7 @@

    Get the OData kind of this resource

    @@ -1331,7 +1294,7 @@

    Get the navigation bindings attached to this entity set

    @@ -1365,7 +1328,7 @@

    Return the orderby option that applies to this entity set

    @@ -1399,7 +1362,7 @@

    Get the resource URL for this entity set instance

    @@ -1446,7 +1409,7 @@

    Return the search option that applies to this entity set

    @@ -1480,7 +1443,7 @@

    Return this select option that applies to this entity set

    @@ -1514,7 +1477,7 @@

    Get selected properties

    @@ -1549,7 +1512,7 @@

    Return the skip option that applies to this entity set

    @@ -1583,7 +1546,7 @@

    Return the skip token option that applies to this entity set

    @@ -1617,7 +1580,7 @@

    Return the top option that applies to this entity set

    @@ -1651,7 +1614,7 @@

    Get the entity type of this entity set

    @@ -1672,41 +1635,6 @@

    Return values
    -
    -
    -

    - key() - -

    - - -

    Get the entity ID of the current entity in the results buffer

    - - - public - key() : PropertyValue - -
    - - - - -
    Return values
    - PropertyValue - — -

    Entity ID

    -
    - -

    Generate a new entity attached to this entity set instance

    @@ -1742,40 +1670,6 @@
    Return values
    -
    -
    -

    - next() - -

    - - -

    Move to the next entity in the results buffer

    - - - public - next() : void - -
    - - - - -
    Return values
    - void - — -
    - -

    Path component handler

    @@ -1864,14 +1758,14 @@

    Query the redis database

    public - query() : array<string|int, Entity> + query() : Generator|array<string|int, Entity>
    @@ -1879,10 +1773,9 @@

    Return values
    - array<string|int, Entity> + Generator|array<string|int, Entity> — -

    Results

    -
    +
    @@ -1899,7 +1792,7 @@

    Read a record from the database

    @@ -1946,7 +1839,7 @@

    Get the entity ID of the entity this set was generated from using the attached expansion property value

    @@ -1981,7 +1874,7 @@

    @@ -2016,40 +1909,6 @@

    Return values
    - -
    -

    - rewind() - -

    - - -

    Rewind the results buffer

    - - - public - rewind() : mixed - -
    - - - - -
    Return values
    - mixed - — -
    - -

    Serialize an Entity into a string for insertion into Redis

    @@ -2111,7 +1970,7 @@

    Set the Redis connection to use

    @@ -2156,7 +2015,7 @@

    Set the name of the Redis database to use

    @@ -2187,52 +2046,6 @@

    Return values
    -
    -
    -

    - setMaxPageSize() - -

    - - -

    Set the maximum pagination size to use with the service providing results into the buffer

    - - - public - setMaxPageSize(int $maxPageSize) : $this - -
    - -
    Parameters
    -
    -
    - $maxPageSize - : int -
    -
    -

    Maximum page size

    -
    - -
    -
    - - - -
    Return values
    - $this - — -
    - -

    Get the navigation property value that relates to this entity set instance

    @@ -2293,7 +2106,7 @@

    Set the context transaction this entity set instance should use

    @@ -2339,7 +2152,7 @@

    Set the entity type of this entity set

    @@ -2385,7 +2198,7 @@

    Deserialize a string Redis value into an Entity

    @@ -2431,7 +2244,7 @@

    Update a record in the database

    @@ -2464,42 +2277,6 @@

    Return values
    -
    -
    -

    - valid() - -

    - - -

    Whether there is a current entity in the results buffer -Implements internal pagination

    - - - public - valid() : bool - -
    - - - - -
    Return values
    - bool - — -

    Whether there is a valid entity in the current position of the buffer

    -
    - -
    diff --git a/docs/classes/Flat3-Lodata-Drivers-SQLEntitySet.html b/docs/classes/Flat3-Lodata-Drivers-SQLEntitySet.html index cb969325d..5fb2315ea 100644 --- a/docs/classes/Flat3-Lodata-Drivers-SQLEntitySet.html +++ b/docs/classes/Flat3-Lodata-Drivers-SQLEntitySet.html @@ -102,7 +102,7 @@

    SQL Entity Set

    @@ -155,7 +155,14 @@

    -
    +
    + $emittedEntityCount + +  : int +
    +
    Running total of emitted entities
    + +
    __construct()  : mixed @@ -211,13 +218,6 @@

    Create a new record
    -
    - current() - -  : null|Entity -
    -
    The current entity in the results buffer
    -
    delete() @@ -386,13 +386,6 @@

    Get the entity type of this entity set
    -
    - key() - -  : PropertyValue -
    -
    Get the entity ID of the current entity in the results buffer
    -
    newEntity() @@ -400,13 +393,6 @@

    Generate a new entity attached to this entity set instance
    -
    - next() - -  : void -
    -
    Move to the next entity in the results buffer
    -
    pipe() @@ -417,7 +403,7 @@

    query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
    Run a PDO query and return the results
    @@ -442,13 +428,6 @@

    -
    - rewind() - -  : mixed -
    -
    Rewind the results buffer
    -
    rollback() @@ -456,13 +435,6 @@

    -
    - setMaxPageSize() - -  : $this -
    -
    Set the maximum pagination size to use with the service providing results into the buffer
    -
    setNavigationPropertyValue() @@ -505,14 +477,6 @@

    Update an existing record
    -
    - valid() - -  : bool -
    -
    Whether there is a current entity in the results buffer -Implements internal pagination
    -
    bindParameters() @@ -569,6 +533,44 @@

    +
    +

    + Properties + +

    +
    +

    + $emittedEntityCount + + + +

    + + +

    Running total of emitted entities

    + + + private + int + $emittedEntityCount + = 0 + +
    + + + +
    +

    @@ -588,7 +590,7 @@

    @@ -637,7 +639,7 @@

    Add a navigation binding to this entity set

    @@ -683,7 +685,7 @@

    Generate trailing metadata for this entity set

    @@ -744,7 +746,7 @@

    Apply the filter system query option

    @@ -790,7 +792,7 @@

    Apply the search system query option

    @@ -824,7 +826,7 @@

    @@ -856,7 +858,7 @@

    Count the number of records matching the query

    @@ -891,7 +893,7 @@

    Create a new record

    @@ -912,41 +914,6 @@

    Return values
    - -
    -

    - current() - -

    - - -

    The current entity in the results buffer

    - - - public - current() : null|Entity - -
    - - - - -
    Return values
    - null|Entity - — -

    Current entity

    -
    - -

    Delete a record

    @@ -1007,7 +974,7 @@

    Emit this item as valid JSON to the client response

    @@ -1053,7 +1020,7 @@

    Generate a new entity set definition

    @@ -1123,7 +1090,7 @@

    Generate the where clause for this query

    @@ -1157,7 +1124,7 @@

    Read this entity set

    @@ -1213,7 +1180,7 @@

    EntitySet.php : - 303 + 163

    Get the navigation binding for the provided navigation property on this entity set

    @@ -1260,7 +1227,7 @@

    Get the context URL for this entity set instance

    @@ -1307,7 +1274,7 @@

    Return the count option that applies to this entity set

    @@ -1341,7 +1308,7 @@

    Return the filter option that applies to this entity set

    @@ -1375,7 +1342,7 @@

    Get the OData kind of this resource

    @@ -1410,7 +1377,7 @@

    Get the navigation bindings attached to this entity set

    @@ -1444,7 +1411,7 @@

    Return the orderby option that applies to this entity set

    @@ -1478,7 +1445,7 @@

    Get the underlying database field name for the given entity type property

    @@ -1525,7 +1492,7 @@

    Get the resource URL for this entity set instance

    @@ -1572,7 +1539,7 @@

    Get a version of the query string that counts the total number of rows in the collection

    @@ -1607,7 +1574,7 @@

    Return the search option that applies to this entity set

    @@ -1641,7 +1608,7 @@

    Return this select option that applies to this entity set

    @@ -1675,7 +1642,7 @@

    Get selected properties

    @@ -1710,7 +1677,7 @@

    Get the query string representing the query result

    @@ -1745,7 +1712,7 @@

    Return the skip option that applies to this entity set

    @@ -1779,7 +1746,7 @@

    Return the skip token option that applies to this entity set

    @@ -1813,7 +1780,7 @@

    Get the table name used by this entity set

    @@ -1848,7 +1815,7 @@

    Return the top option that applies to this entity set

    @@ -1882,7 +1849,7 @@

    Get the entity type of this entity set

    @@ -1903,41 +1870,6 @@

    Return values
    -
    -
    -

    - key() - -

    - - -

    Get the entity ID of the current entity in the results buffer

    - - - public - key() : PropertyValue - -
    - - - - -
    Return values
    - PropertyValue - — -

    Entity ID

    -
    - -

    Generate a new entity attached to this entity set instance

    @@ -1973,40 +1905,6 @@
    Return values
    -
    -
    -

    - next() - -

    - - -

    Move to the next entity in the results buffer

    - - - public - next() : void - -
    - - - - -
    Return values
    - void - — -
    - -

    Path component handler

    @@ -2102,7 +2000,7 @@

    public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
    @@ -2110,10 +2008,9 @@

    Return values
    - array<string|int, mixed> + Generator|array<string|int, Entity> — -

    Result buffer

    -
    +
    @@ -2130,7 +2027,7 @@

    Read an SQL record

    @@ -2177,7 +2074,7 @@

    Get the entity ID of the entity this set was generated from using the attached expansion property value

    @@ -2212,7 +2109,7 @@

    @@ -2247,40 +2144,6 @@

    Return values
    - -
    -

    - rewind() - -

    - - -

    Rewind the results buffer

    - - - public - rewind() : mixed - -
    - - - - -
    Return values
    - mixed - — -
    - -
    -
    -

    - setMaxPageSize() - -

    - - -

    Set the maximum pagination size to use with the service providing results into the buffer

    - - - public - setMaxPageSize(int $maxPageSize) : $this - -
    - -
    Parameters
    -
    -
    - $maxPageSize - : int -
    -
    -

    Maximum page size

    -
    - -
    -
    - - - -
    Return values
    - $this - — -
    - -

    Get the navigation property value that relates to this entity set instance

    @@ -2419,7 +2236,7 @@

    Set the table name used by this entity set

    @@ -2465,7 +2282,7 @@

    Set the transaction that applies to this entity set instance, and validate the transaction request

    @@ -2511,7 +2328,7 @@

    Set the entity type of this entity set

    @@ -2557,7 +2374,7 @@

    @@ -2589,7 +2406,7 @@

    Update an existing record

    @@ -2622,42 +2439,6 @@

    Return values
    -
    -
    -

    - valid() - -

    - - -

    Whether there is a current entity in the results buffer -Implements internal pagination

    - - - public - valid() : bool - -
    - - - - -
    Return values
    - bool - — -

    Whether there is a valid entity in the current position of the buffer

    -
    - -

    Apply the generated bind parameters to the provided PDO statement

    @@ -2718,7 +2499,7 @@

    Determine the list of columns to include in the query result

    @@ -2753,7 +2534,7 @@

    Convert the provided entity type property list to a list of SQL fields

    @@ -2800,7 +2581,7 @@

    Apply an SQL cast based on the provided property type

    @@ -2847,7 +2628,7 @@

    Convert the provided entity type property to a qualified database field

    @@ -2894,7 +2675,7 @@

    Generate a PDO-compatible SQL query that modifies the database

    @@ -2941,7 +2722,7 @@

    Generate a PDO-compatible SQL query that selects from the database

    diff --git a/docs/classes/Flat3-Lodata-Drivers-StaticEntitySet.html b/docs/classes/Flat3-Lodata-Drivers-StaticEntitySet.html index b968781be..46af0b113 100644 --- a/docs/classes/Flat3-Lodata-Drivers-StaticEntitySet.html +++ b/docs/classes/Flat3-Lodata-Drivers-StaticEntitySet.html @@ -95,14 +95,14 @@

    implements - QueryInterface, ArrayAccess + QueryInterface, ArrayAccess, CountInterface

    Class StaticEntitySet @@ -125,6 +125,8 @@

    Query Interface
    ArrayAccess
    +
    CountInterface
    +
    Count Interface

    @@ -136,7 +138,21 @@

    -
    +
    + $results + +  : array<string|int, Entity> +
    +
    + +
    + $emittedEntityCount + +  : int +
    +
    Running total of emitted entities
    + +
    __construct()  : mixed @@ -172,18 +188,11 @@

    Apply the search system query option
    - count() + count() -  : int|null +  : int
    -
    Count the number of results in the result buffer
    - -
    - current() - -  : null|Entity -
    -
    The current entity in the results buffer
    +
    Count the objects in the array
    emitJson() @@ -318,13 +327,6 @@

    Get the entity type of this entity set
    -
    - key() - -  : PropertyValue -
    -
    Get the entity ID of the current entity in the results buffer
    -
    newEntity() @@ -332,13 +334,6 @@

    Generate a new entity attached to this entity set instance
    -
    - next() - -  : void -
    -
    Move to the next entity in the results buffer
    -
    offsetExists() @@ -377,9 +372,9 @@

    query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
    -
    Return no more results
    +
    Return all results
    resolveExpansionKey() @@ -400,14 +395,7 @@

     : mixed

    -
    Rewind the results buffer
    - -
    - setMaxPageSize() - -  : $this -
    -
    Set the maximum pagination size to use with the service providing results into the buffer
    +
    setNavigationPropertyValue() @@ -437,14 +425,6 @@

    Sort the objects in the array
    -
    - valid() - -  : bool -
    -
    Whether there is a current entity in the results buffer -Implements internal pagination
    -

    @@ -452,6 +432,75 @@

    +
    +

    + Properties + +

    +
    +

    + $results + + + +

    + + + + + protected + array<string|int, Entity> + $results + = [] + +
    + + + +
    +
    +

    + $emittedEntityCount + + + +

    + + +

    Running total of emitted entities

    + + + private + int + $emittedEntityCount + = 0 + +
    + + + +
    +

    @@ -471,7 +520,7 @@

    @@ -513,7 +562,7 @@

    Add a navigation binding to this entity set

    @@ -559,7 +608,7 @@

    Generate trailing metadata for this entity set

    @@ -620,7 +669,7 @@

    Apply the filter system query option

    @@ -666,7 +715,7 @@

    Apply the search system query option

    @@ -695,19 +744,19 @@

    Return values
    >

    count() - +

    -

    Count the number of results in the result buffer

    +

    Count the objects in the array

    public - count() : int|null + count() : int
    @@ -715,46 +764,11 @@

    Return values
    - int|null + int —
    - -
    -

    - current() - -

    - - -

    The current entity in the results buffer

    - - - public - current() : null|Entity - -
    - - - - -
    Return values
    - null|Entity - — -

    Current entity

    -
    - -

    Emit this item as valid JSON to the client response

    @@ -815,7 +829,7 @@

    Generate a new entity set definition

    @@ -885,7 +899,7 @@

    Filter the objects in the array

    @@ -930,7 +944,7 @@

    Read this entity set

    @@ -986,7 +1000,7 @@

    EntitySet.php : - 303 + 163

    Get the navigation binding for the provided navigation property on this entity set

    @@ -1033,7 +1047,7 @@

    Get the context URL for this entity set instance

    @@ -1080,7 +1094,7 @@

    Return the count option that applies to this entity set

    @@ -1114,7 +1128,7 @@

    Return the filter option that applies to this entity set

    @@ -1148,7 +1162,7 @@

    Get the OData kind of this resource

    @@ -1183,7 +1197,7 @@

    Get the navigation bindings attached to this entity set

    @@ -1217,7 +1231,7 @@

    Return the orderby option that applies to this entity set

    @@ -1251,7 +1265,7 @@

    Get the resource URL for this entity set instance

    @@ -1298,7 +1312,7 @@

    Return the search option that applies to this entity set

    @@ -1332,7 +1346,7 @@

    Return this select option that applies to this entity set

    @@ -1366,7 +1380,7 @@

    Get selected properties

    @@ -1401,7 +1415,7 @@

    Return the skip option that applies to this entity set

    @@ -1435,7 +1449,7 @@

    Return the skip token option that applies to this entity set

    @@ -1469,7 +1483,7 @@

    Return the top option that applies to this entity set

    @@ -1503,7 +1517,7 @@

    Get the entity type of this entity set

    @@ -1524,41 +1538,6 @@

    Return values
    - -
    -

    - key() - -

    - - -

    Get the entity ID of the current entity in the results buffer

    - - - public - key() : PropertyValue - -
    - - - - -
    Return values
    - PropertyValue - — -

    Entity ID

    -
    - -

    Generate a new entity attached to this entity set instance

    @@ -1594,40 +1573,6 @@
    Return values
    -
    -
    -

    - next() - -

    - - -

    Move to the next entity in the results buffer

    - - - public - next() : void - -
    - - - - -
    Return values
    - void - — -
    - -
    @@ -1684,7 +1629,7 @@

    @@ -1726,7 +1671,7 @@

    @@ -1775,7 +1720,7 @@

    @@ -1817,7 +1762,7 @@

    Path component handler

    @@ -1891,14 +1836,14 @@

    -

    Return no more results

    +

    Return all results

    public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
    @@ -1906,7 +1851,7 @@

    Return values
    - array<string|int, mixed> + Generator|array<string|int, Entity> —
    @@ -1925,7 +1870,7 @@

    Get the entity ID of the entity this set was generated from using the attached expansion property value

    @@ -1960,7 +1905,7 @@

    @@ -2009,68 +1954,20 @@

    -

    Rewind the results buffer

    - + public rewind() : mixed -
    - - -

    Return values
    - mixed - — -
    - - -
    -
    -

    - setMaxPageSize() - -

    - - -

    Set the maximum pagination size to use with the service providing results into the buffer

    - - - public - setMaxPageSize(int $maxPageSize) : $this - -
    - -
    Parameters
    -
    -
    - $maxPageSize - : int -
    -
    -

    Maximum page size

    -
    - -
    -
    -
    Return values
    - $this + mixed —
    @@ -2089,7 +1986,7 @@

    Get the navigation property value that relates to this entity set instance

    @@ -2135,7 +2032,7 @@

    Set the context transaction this entity set instance should use

    @@ -2181,7 +2078,7 @@

    Set the entity type of this entity set

    @@ -2227,7 +2124,7 @@

    Sort the objects in the array

    @@ -2258,42 +2155,6 @@

    Return values
    -
    -
    -

    - valid() - -

    - - -

    Whether there is a current entity in the results buffer -Implements internal pagination

    - - - public - valid() : bool - -
    - - - - -
    Return values
    - bool - — -

    Whether there is a valid entity in the current position of the buffer

    -
    - -
    diff --git a/docs/classes/Flat3-Lodata-Entity.html b/docs/classes/Flat3-Lodata-Entity.html index da42efc81..135913fdd 100644 --- a/docs/classes/Flat3-Lodata-Entity.html +++ b/docs/classes/Flat3-Lodata-Entity.html @@ -398,7 +398,7 @@

    Add a property value to this entity

    @@ -444,7 +444,7 @@

    Delete this entity

    @@ -546,7 +546,7 @@

    Generate an entity from an array of key/values

    @@ -592,7 +592,7 @@

    Read this entity

    @@ -648,7 +648,7 @@

    Get the context URL for this entity

    @@ -695,7 +695,7 @@

    Get the ID of this entity

    @@ -730,7 +730,7 @@

    Get the entity set that contains this entity

    @@ -764,7 +764,7 @@

    Get the ETag for this entity

    @@ -799,7 +799,7 @@

    Get a property value attached to this entity

    @@ -846,7 +846,7 @@

    Get all property values attached to this entity

    @@ -881,7 +881,7 @@

    Get the resource URL for this entity

    @@ -928,7 +928,7 @@

    Get the entity type of this entity

    @@ -963,7 +963,7 @@

    Generate a new property value attached to this entity

    @@ -998,7 +998,7 @@

    Whether the provided property value exists on this entity

    @@ -1044,7 +1044,7 @@

    Get a property value from this entity

    @@ -1091,7 +1091,7 @@

    Create a new property value on this entity

    @@ -1146,7 +1146,7 @@

    Remove a property value from this entity

    @@ -1192,7 +1192,7 @@

    Update this entity

    @@ -1248,7 +1248,7 @@

    Path component handler

    @@ -1322,7 +1322,7 @@

    @@ -1371,7 +1371,7 @@

    Set the ID of this entity

    @@ -1463,7 +1463,7 @@

    Set the entity type of this entity

    @@ -1509,7 +1509,7 @@

    Convert this entity to a PHP array of key/value pairs

    diff --git a/docs/classes/Flat3-Lodata-EntitySet.html b/docs/classes/Flat3-Lodata-EntitySet.html index ec519fbb6..00f54b440 100644 --- a/docs/classes/Flat3-Lodata-EntitySet.html +++ b/docs/classes/Flat3-Lodata-EntitySet.html @@ -91,14 +91,14 @@

    implements - EntityTypeInterface, ReferenceInterface, IdentifierInterface, ResourceInterface, ServiceInterface, ContextInterface, Iterator, Countable, JsonInterface, PipeInterface, ArgumentInterface, AnnotationInterface + EntityTypeInterface, ReferenceInterface, IdentifierInterface, ResourceInterface, ServiceInterface, ContextInterface, JsonInterface, PipeInterface, ArgumentInterface, AnnotationInterface

    Entity Set

    @@ -141,10 +141,6 @@

    Service Interface
    ContextInterface
    Context Interface
    -
    Iterator
    -
    -
    Countable
    -
    JsonInterface
    Response Interface
    PipeInterface
    @@ -164,7 +160,14 @@

    -
    +
    + $emittedEntityCount + +  : int +
    +
    Running total of emitted entities
    + +
    __construct()  : mixed @@ -199,20 +202,6 @@

    Apply the search system query option
    -
    - count() - -  : int|null -
    -
    Count the number of results in the result buffer
    - -
    - current() - -  : null|Entity -
    -
    The current entity in the results buffer
    -
    emitJson() @@ -339,13 +328,6 @@

    Get the entity type of this entity set
    -
    - key() - -  : PropertyValue -
    -
    Get the entity ID of the current entity in the results buffer
    -
    newEntity() @@ -353,13 +335,6 @@

    Generate a new entity attached to this entity set instance
    -
    - next() - -  : void -
    -
    Move to the next entity in the results buffer
    -
    pipe() @@ -381,20 +356,6 @@

    -
    - rewind() - -  : mixed -
    -
    Rewind the results buffer
    - -
    - setMaxPageSize() - -  : $this -
    -
    Set the maximum pagination size to use with the service providing results into the buffer
    -
    setNavigationPropertyValue() @@ -416,14 +377,6 @@

    Set the entity type of this entity set
    -
    - valid() - -  : bool -
    -
    Whether there is a current entity in the results buffer -Implements internal pagination
    -
    @@ -431,6 +384,44 @@

    +
    +

    + Properties + +

    +
    +

    + $emittedEntityCount + + + +

    + + +

    Running total of emitted entities

    + + + private + int + $emittedEntityCount + = 0 + +
    + + + +
    +

    @@ -450,7 +441,7 @@

    @@ -499,7 +490,7 @@

    Add a navigation binding to this entity set

    @@ -545,7 +536,7 @@

    Generate trailing metadata for this entity set

    @@ -606,7 +597,7 @@

    Apply the filter system query option

    @@ -652,7 +643,7 @@

    Apply the search system query option

    @@ -672,75 +663,6 @@

    Return values
    - -
    -

    - count() - -

    - - -

    Count the number of results in the result buffer

    - - - public - count() : int|null - -
    - - - - -
    Return values
    - int|null - — -
    - - -
    -
    -

    - current() - -

    - - -

    The current entity in the results buffer

    - - - public - current() : null|Entity - -
    - - - - -
    Return values
    - null|Entity - — -

    Current entity

    -
    - -

    Emit this item as valid JSON to the client response

    @@ -801,7 +723,7 @@

    Generate a new entity set definition

    @@ -871,7 +793,7 @@

    Read this entity set

    @@ -927,7 +849,7 @@

    EntitySet.php : - 303 + 163

    Get the navigation binding for the provided navigation property on this entity set

    @@ -974,7 +896,7 @@

    Get the context URL for this entity set instance

    @@ -1021,7 +943,7 @@

    Return the count option that applies to this entity set

    @@ -1055,7 +977,7 @@

    Return the filter option that applies to this entity set

    @@ -1089,7 +1011,7 @@

    Get the OData kind of this resource

    @@ -1124,7 +1046,7 @@

    Get the navigation bindings attached to this entity set

    @@ -1158,7 +1080,7 @@

    Return the orderby option that applies to this entity set

    @@ -1192,7 +1114,7 @@

    Get the resource URL for this entity set instance

    @@ -1239,7 +1161,7 @@

    Return the search option that applies to this entity set

    @@ -1273,7 +1195,7 @@

    Return this select option that applies to this entity set

    @@ -1307,7 +1229,7 @@

    Get selected properties

    @@ -1342,7 +1264,7 @@

    Return the skip option that applies to this entity set

    @@ -1376,7 +1298,7 @@

    Return the skip token option that applies to this entity set

    @@ -1410,7 +1332,7 @@

    Return the top option that applies to this entity set

    @@ -1444,7 +1366,7 @@

    Get the entity type of this entity set

    @@ -1465,41 +1387,6 @@

    Return values
    - -
    -

    - key() - -

    - - -

    Get the entity ID of the current entity in the results buffer

    - - - public - key() : PropertyValue - -
    - - - - -
    Return values
    - PropertyValue - — -

    Entity ID

    -
    - -

    Generate a new entity attached to this entity set instance

    @@ -1535,40 +1422,6 @@
    Return values
    -
    -
    -

    - next() - -

    - - -

    Move to the next entity in the results buffer

    - - - public - next() : void - -
    - - - - -
    Return values
    - void - — -
    - -

    Path component handler

    @@ -1657,7 +1510,7 @@

    Get the entity ID of the entity this set was generated from using the attached expansion property value

    @@ -1692,7 +1545,7 @@

    @@ -1727,86 +1580,6 @@

    Return values
    -
    -
    -

    - rewind() - -

    - - -

    Rewind the results buffer

    - - - public - rewind() : mixed - -
    - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - setMaxPageSize() - -

    - - -

    Set the maximum pagination size to use with the service providing results into the buffer

    - - - public - setMaxPageSize(int $maxPageSize) : $this - -
    - -
    Parameters
    -
    -
    - $maxPageSize - : int -
    -
    -

    Maximum page size

    -
    - -
    -
    - - - -
    Return values
    - $this - — -
    - -

    Get the navigation property value that relates to this entity set instance

    @@ -1867,7 +1640,7 @@

    Set the context transaction this entity set instance should use

    @@ -1913,7 +1686,7 @@

    Set the entity type of this entity set

    @@ -1945,42 +1718,6 @@

    Return values
    -
    -
    -

    - valid() - -

    - - -

    Whether there is a current entity in the results buffer -Implements internal pagination

    - - - public - valid() : bool - -
    - - - - -
    Return values
    - bool - — -

    Whether there is a valid entity in the current position of the buffer

    -
    - -
    diff --git a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html index 12c284d52..84365b496 100644 --- a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html +++ b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html @@ -107,12 +107,64 @@

    +

    + Table of Contents + +

    +
    +
    + count() + +  : int +
    +
    + +
    - + +
    +

    + Methods + +

    +
    +

    + count() + +

    + + + + + public + count() : int + + + + + +
    Return values
    + int + — +
    + + +
    +
    +
    diff --git a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-ExpandInterface.html b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-ExpandInterface.html index 78f12a4c2..27d48239a 100644 --- a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-ExpandInterface.html +++ b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-ExpandInterface.html @@ -119,9 +119,10 @@

    query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
    -
    Generate a single page of results, using $this->top and $this->skip, loading the results as Entity objects into $this->result_set
    +
    Generate a single Entity result +Must observe the $skip system query option if implementing pagination
    @@ -147,14 +148,15 @@

    -

    Generate a single page of results, using $this->top and $this->skip, loading the results as Entity objects into $this->result_set

    +

    Generate a single Entity result +Must observe the $skip system query option if implementing pagination

    public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
    @@ -162,7 +164,7 @@

    Return values
    - array<string|int, mixed> + Generator|array<string|int, Entity> —
    diff --git a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-QueryInterface.html b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-QueryInterface.html index 97822938d..e4f5b552c 100644 --- a/docs/classes/Flat3-Lodata-Interfaces-EntitySet-QueryInterface.html +++ b/docs/classes/Flat3-Lodata-Interfaces-EntitySet-QueryInterface.html @@ -93,7 +93,7 @@

    Query Interface

    @@ -116,9 +116,10 @@

    query() -  : array<string|int, mixed> +  : Generator|array<string|int, Entity>
    -
    Generate a single page of results, using $this->top and $this->skip, loading the results as Entity objects into $this->result_set
    +
    Generate a single Entity result +Must observe the $skip system query option if implementing pagination
    @@ -144,14 +145,15 @@

    -

    Generate a single page of results, using $this->top and $this->skip, loading the results as Entity objects into $this->result_set

    +

    Generate a single Entity result +Must observe the $skip system query option if implementing pagination

    public - query() : array<string|int, mixed> + query() : Generator|array<string|int, Entity>
    @@ -159,7 +161,7 @@

    Return values
    - array<string|int, mixed> + Generator|array<string|int, Entity> —
    diff --git a/docs/classes/Flat3-Lodata-PathSegment-Count.html b/docs/classes/Flat3-Lodata-PathSegment-Count.html index 67772a69e..ada489d43 100644 --- a/docs/classes/Flat3-Lodata-PathSegment-Count.html +++ b/docs/classes/Flat3-Lodata-PathSegment-Count.html @@ -192,14 +192,14 @@

    public - __construct(Countable $countable) : mixed + __construct(CountInterface $countable) : mixed

    Parameters
    $countable - : Countable + : CountInterface
    diff --git a/docs/classes/Flat3-Lodata-Singleton.html b/docs/classes/Flat3-Lodata-Singleton.html index 84aeada5a..1501c104f 100644 --- a/docs/classes/Flat3-Lodata-Singleton.html +++ b/docs/classes/Flat3-Lodata-Singleton.html @@ -411,7 +411,7 @@

    Add a property value to this entity

    @@ -457,7 +457,7 @@

    Delete this entity

    @@ -559,7 +559,7 @@

    Generate an entity from an array of key/values

    @@ -605,7 +605,7 @@

    Read this entity

    @@ -708,7 +708,7 @@

    Get the ID of this entity

    @@ -743,7 +743,7 @@

    Get the entity set that contains this entity

    @@ -777,7 +777,7 @@

    Get the ETag for this entity

    @@ -847,7 +847,7 @@

    Get a property value attached to this entity

    @@ -894,7 +894,7 @@

    Get all property values attached to this entity

    @@ -976,7 +976,7 @@

    Get the entity type of this entity

    @@ -1011,7 +1011,7 @@

    Generate a new property value attached to this entity

    @@ -1046,7 +1046,7 @@

    Whether the provided property value exists on this entity

    @@ -1092,7 +1092,7 @@

    Get a property value from this entity

    @@ -1139,7 +1139,7 @@

    Create a new property value on this entity

    @@ -1194,7 +1194,7 @@

    Remove a property value from this entity

    @@ -1240,7 +1240,7 @@

    Update this entity

    @@ -1370,7 +1370,7 @@

    @@ -1419,7 +1419,7 @@

    Set the ID of this entity

    @@ -1511,7 +1511,7 @@

    Set the entity type of this entity

    @@ -1557,7 +1557,7 @@

    Convert this entity to a PHP array of key/value pairs

    diff --git a/docs/files/src-drivers-filesystementity.html b/docs/files/src-drivers-filesystementity.html deleted file mode 100644 index 02138dac7..000000000 --- a/docs/files/src-drivers-filesystementity.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Lodata - - - - - - - - - - - - - - - - - - -
    -

    Lodata

    - - -
    - -
    - - -
    - -
    -
    - - - - -
    -
      -
    - -
    -

    FilesystemEntity.php

    - - - - - - - - -

    - Interfaces, Classes and Traits - -

    - -
    - -
    FilesystemEntity
    -
    Entity
    - -
    - - - - - - - - -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      -
      - - -
      - - - - - - - diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index b1467a068..061942827 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1060,6 +1060,11 @@ Search.appendIndex( "name": "commit", "summary": "", "url": "classes/Flat3-Lodata-Drivers-EloquentEntitySet.html#method_commit" + }, { + "fqsen": "\\Flat3\\Lodata\\Drivers\\EloquentEntitySet\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "Count\u0020the\u0020number\u0020of\u0020records\u0020matching\u0020the\u0020query", + "url": "classes/Flat3-Lodata-Drivers-EloquentEntitySet.html#method_count" }, { "fqsen": "\\Flat3\\Lodata\\Drivers\\FilesystemEntitySet", "name": "FilesystemEntitySet", @@ -1523,7 +1528,7 @@ Search.appendIndex( }, { "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003Aquery\u0028\u0029", "name": "query", - "summary": "Return\u0020no\u0020more\u0020results", + "summary": "Return\u0020all\u0020results", "url": "classes/Flat3-Lodata-Drivers-StaticEntitySet.html#method_query" }, { "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003AoffsetExists\u0028\u0029", @@ -1548,7 +1553,7 @@ Search.appendIndex( }, { "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003Arewind\u0028\u0029", "name": "rewind", - "summary": "Rewind\u0020the\u0020results\u0020buffer", + "summary": "", "url": "classes/Flat3-Lodata-Drivers-StaticEntitySet.html#method_rewind" }, { "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003Afilter\u0028\u0029", @@ -1560,6 +1565,16 @@ Search.appendIndex( "name": "sort", "summary": "Sort\u0020the\u0020objects\u0020in\u0020the\u0020array", "url": "classes/Flat3-Lodata-Drivers-StaticEntitySet.html#method_sort" + }, { + "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "Count\u0020the\u0020objects\u0020in\u0020the\u0020array", + "url": "classes/Flat3-Lodata-Drivers-StaticEntitySet.html#method_count" + }, { + "fqsen": "\\Flat3\\Lodata\\Drivers\\StaticEntitySet\u003A\u003A\u0024results", + "name": "results", + "summary": "", + "url": "classes/Flat3-Lodata-Drivers-StaticEntitySet.html#property_results" }, { "fqsen": "\\Flat3\\Lodata\\DynamicProperty", "name": "DynamicProperty", @@ -1725,41 +1740,6 @@ Search.appendIndex( "name": "getKind", "summary": "Get\u0020the\u0020OData\u0020kind\u0020of\u0020this\u0020resource", "url": "classes/Flat3-Lodata-EntitySet.html#method_getKind" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Acurrent\u0028\u0029", - "name": "current", - "summary": "The\u0020current\u0020entity\u0020in\u0020the\u0020results\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_current" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Anext\u0028\u0029", - "name": "next", - "summary": "Move\u0020to\u0020the\u0020next\u0020entity\u0020in\u0020the\u0020results\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_next" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Akey\u0028\u0029", - "name": "key", - "summary": "Get\u0020the\u0020entity\u0020ID\u0020of\u0020the\u0020current\u0020entity\u0020in\u0020the\u0020results\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_key" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Arewind\u0028\u0029", - "name": "rewind", - "summary": "Rewind\u0020the\u0020results\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_rewind" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Acount\u0028\u0029", - "name": "count", - "summary": "Count\u0020the\u0020number\u0020of\u0020results\u0020in\u0020the\u0020result\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_count" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003Avalid\u0028\u0029", - "name": "valid", - "summary": "Whether\u0020there\u0020is\u0020a\u0020current\u0020entity\u0020in\u0020the\u0020results\u0020buffer\nImplements\u0020internal\u0020pagination", - "url": "classes/Flat3-Lodata-EntitySet.html#method_valid" - }, { - "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003AsetMaxPageSize\u0028\u0029", - "name": "setMaxPageSize", - "summary": "Set\u0020the\u0020maximum\u0020pagination\u0020size\u0020to\u0020use\u0020with\u0020the\u0020service\u0020providing\u0020results\u0020into\u0020the\u0020buffer", - "url": "classes/Flat3-Lodata-EntitySet.html#method_setMaxPageSize" }, { "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003AaddNavigationBinding\u0028\u0029", "name": "addNavigationBinding", @@ -1895,6 +1875,11 @@ Search.appendIndex( "name": "applySearchQueryOption", "summary": "Apply\u0020the\u0020search\u0020system\u0020query\u0020option", "url": "classes/Flat3-Lodata-EntitySet.html#method_applySearchQueryOption" + }, { + "fqsen": "\\Flat3\\Lodata\\EntitySet\u003A\u003A\u0024emittedEntityCount", + "name": "emittedEntityCount", + "summary": "Running\u0020total\u0020of\u0020emitted\u0020entities", + "url": "classes/Flat3-Lodata-EntitySet.html#property_emittedEntityCount" }, { "fqsen": "\\Flat3\\Lodata\\EntityType", "name": "EntityType", @@ -4510,6 +4495,11 @@ Search.appendIndex( "name": "CountInterface", "summary": "Count\u0020Interface", "url": "classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html" + }, { + "fqsen": "\\Flat3\\Lodata\\Interfaces\\EntitySet\\CountInterface\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "", + "url": "classes/Flat3-Lodata-Interfaces-EntitySet-CountInterface.html#method_count" }, { "fqsen": "\\Flat3\\Lodata\\Interfaces\\EntitySet\\CreateInterface", "name": "CreateInterface", @@ -4563,7 +4553,7 @@ Search.appendIndex( }, { "fqsen": "\\Flat3\\Lodata\\Interfaces\\EntitySet\\QueryInterface\u003A\u003Aquery\u0028\u0029", "name": "query", - "summary": "Generate\u0020a\u0020single\u0020page\u0020of\u0020results,\u0020using\u0020\u0024this\u002D\u003Etop\u0020and\u0020\u0024this\u002D\u003Eskip,\u0020loading\u0020the\u0020results\u0020as\u0020Entity\u0020objects\u0020into\u0020\u0024this\u002D\u003Eresult_set", + "summary": "Generate\u0020a\u0020single\u0020Entity\u0020result\nMust\u0020observe\u0020the\u0020\u0024skip\u0020system\u0020query\u0020option\u0020if\u0020implementing\u0020pagination", "url": "classes/Flat3-Lodata-Interfaces-EntitySet-QueryInterface.html#method_query" }, { "fqsen": "\\Flat3\\Lodata\\Interfaces\\EntitySet\\ReadInterface", diff --git a/src/EntitySet.php b/src/EntitySet.php index 89cf55123..1e0aae2e8 100644 --- a/src/EntitySet.php +++ b/src/EntitySet.php @@ -174,6 +174,8 @@ public function getBindingByNavigationProperty(NavigationProperty $property): ?N public function emitJson(Transaction $transaction): void { + assert($this instanceof QueryInterface); + $transaction = $this->transaction ?: $transaction; // Validate $orderby