+ $emittedEntityCount + + + +
+ + +Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
+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 @@
Eloquent Entity Set
@@ -140,6 +140,8 @@Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
+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 @@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 @@ Count
+Create an Eloquent model
@@ -879,41 +884,6 @@The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : 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 @@Move to the next entity in the results buffer
- -
- public
- next() : 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 @@ Entity buffer
-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 @@Rewind the results buffer
- -
- public
- rewind() : mixed
-
-
-
-
-
-
- Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Update an Eloquent model
@@ -2800,42 +2620,6 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : bool
-
-
-
-
-
-
- Whether there is a valid entity in the current position of the buffer
-Entity
- - - - - - - - - - -
- public
- __construct() : mixed
-
-
-
-
-
- Add a property value to this entity
- -
- public
- addProperty(PropertyValue $propertyValue) : $this
-
-
-
- Property value
-Delete this entity
- -
- public
- delete(Transaction $transaction[, ContextInterface|null $context = null ]) : Response
-
-
-
- Related transaction
-Current context
-Client response
-Emit this item as valid JSON to the client response
- -
- public
- emitJson(Transaction $transaction) : void
-
-
-
- Transaction
-Generate an entity from an array of key/values
- -
- public
- fromArray(array<string|int, mixed> $object) : $this
-
-
-
- Key/value array
-
- public
- fromMetadata(array<string|int, mixed> $metadata) : self
-
-
- Read this entity
- -
- public
- get(Transaction $transaction[, ContextInterface|null $context = null ]) : Response
-
-
-
- Related transaction
-Current context
-Client response
-Get the context URL for this entity
- -
- public
- getContextUrl(Transaction $transaction) : string
-
-
-
- Related transaction
-Context URL
-Get the ID of this entity
- -
- public
- getEntityId() : PropertyValue|null
-
-
-
-
-
-
- PropertyValue representing the entity ID
-Get the entity set that contains this entity
- -
- public
- getEntitySet() : EntitySet|null
-
-
-
-
-
-
- Get the ETag for this entity
- -
- public
- getETag() : string
-
-
-
-
-
-
- ETag
-Get a property value attached to this entity
- -
- public
- getPropertyValue(Property $property) : Primitive|null
-
-
-
- Property
-Property value
-Get all property values attached to this entity
- -
- public
- getPropertyValues() : ObjectArray
-
-
-
-
-
-
- Property values
-Get the resource URL for this entity
- -
- public
- getResourceUrl(Transaction $transaction) : string
-
-
-
- Related transaction
-Resource URL
-Get the entity type of this entity
- -
- public
- getType() : EntityType
-
-
-
-
-
-
- Entity type
-Generate a new property value attached to this entity
- -
- public
- newPropertyValue() : PropertyValue
-
-
-
-
-
-
- Property value
-Whether the provided property value exists on this entity
- -
- public
- offsetExists(mixed $offset) : bool
-
-
-
- Property name
-Get a property value from this entity
- -
- public
- offsetGet(mixed $offset) : PropertyValue
-
-
-
- Property name
-Property value
-Create a new property value on this entity
- -
- public
- offsetSet(mixed $offset, mixed $value) : mixed
-
-
-
- Property name
-Property value
-Remove a property value from this entity
- -
- public
- offsetUnset(mixed $offset) : mixed
-
-
-
- Property name
-Update this entity
- -
- public
- patch(Transaction $transaction[, ContextInterface|null $context = null ]) : Response
-
-
-
- Related transaction
-Current context
-Client response
-Path component handler
- -
- public
- static pipe(Transaction $transaction, string $currentSegment, string|null $nextSegment, PipeInterface|null $argument) : PipeInterface|null
-
-
-
- Related transaction
-The current path segment
-The next path segment
-The previous path segment
-The processed path segment if handled by this implementation
-
- public
- response(Transaction $transaction[, ContextInterface|null $context = null ]) : Response
-
-
- Set the ID of this entity
- -
- public
- setEntityId(mixed $id) : $this
-
-
-
- ID
-Set the entity set that contains this entity
- -
- public
- setEntitySet(EntitySet $entitySet) : $this
-
-
-
- Entity set
-Set the entity type of this entity
- -
- public
- setType(EntityType $type) : $this
-
-
-
- Entity type
-Convert this entity to a PHP array of key/value pairs
- -
- public
- toArray() : array<string|int, mixed>
-
-
-
-
-
-
- Record
-Class FilesystemEntitySet
@@ -148,6 +148,13 @@Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
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 @@Count the number of results in the result buffer
- -
- public
- count() : int|null
-
-
-
-
-
-
- Create a filesystem entity
@@ -832,41 +787,6 @@The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : PropertyValue
-
-
-
-
-
-
- Entity ID
-Generate a new entity attached to this entity set instance
@@ -1835,40 +1720,6 @@Move to the next entity in the results buffer
- -
- public
- next() : void
-
-
-
-
-
-
- Path component handler
@@ -1964,7 +1815,7 @@
public
- query() : array<string|int, mixed>
+ query() : Generator|array<string|int, Entity>
@@ -1972,7 +1823,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 @@Rewind the results buffer
- -
- public
- rewind() : mixed
-
-
-
-
-
-
- Set the disk by filesystem adaptor
@@ -2201,7 +2018,7 @@Set the disk by name
@@ -2233,52 +2050,6 @@Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : bool
-
-
-
-
-
-
- Whether there is a valid entity in the current position of the buffer
-Class RedisEntitySet
@@ -132,6 +132,8 @@Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
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 @@The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : PropertyValue
-
-
-
-
-
-
- Entity ID
-Generate a new entity attached to this entity set instance
@@ -1742,40 +1670,6 @@Move to the next entity in the results buffer
- -
- public
- next() : 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 @@ Results
-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 @@Rewind the results buffer
- -
- public
- rewind() : 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 @@Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : bool
-
-
-
-
-
-
- Whether there is a valid entity in the current position of the buffer
-SQL Entity Set
@@ -155,7 +155,14 @@Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
+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 @@Count the number of records matching the query
@@ -891,7 +893,7 @@Create a new record
@@ -912,41 +914,6 @@The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : PropertyValue
-
-
-
-
-
-
- Entity ID
-Generate a new entity attached to this entity set instance
@@ -1973,40 +1905,6 @@Move to the next entity in the results buffer
- -
- public
- next() : void
-
-
-
-
-
-
- Path component handler
@@ -2102,7 +2000,7 @@
public
- query() : array<string|int, mixed>
+ query() : Generator|array<string|int, Entity>
@@ -2110,10 +2008,9 @@ Result buffer
-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 @@Rewind the results buffer
- -
- public
- rewind() : mixed
-
-
-
-
-
-
- Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Update an existing record
@@ -2622,42 +2439,6 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : 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 @@Class StaticEntitySet @@ -125,6 +125,8 @@
+ protected
+ array<string|int, Entity>
+ $results
+ = []
+
+
+
+
+
+Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
+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 @@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 @@ The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : PropertyValue
-
-
-
-
-
-
- Entity ID
-Generate a new entity attached to this entity set instance
@@ -1594,40 +1573,6 @@Move to the next entity in the results buffer
- -
- public
- next() : void
-
-
-
-
-
-
- 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 @@ Get the entity ID of the entity this set was generated from using the attached expansion property value
@@ -1960,7 +1905,7 @@Rewind the results buffer
- +
public
rewind() : mixed
-
-
-
- Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : bool
-
-
-
-
-
-
- Whether there is a valid entity in the current position of the buffer
-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 @@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 @@Entity Set
@@ -141,10 +141,6 @@Running total of emitted entities
+ +
+ private
+ int
+ $emittedEntityCount
+ = 0
+
+
+
+
+
+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 @@Count the number of results in the result buffer
- -
- public
- count() : int|null
-
-
-
-
-
-
- The current entity in the results buffer
- -
- public
- current() : 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 @@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 @@Get the entity ID of the current entity in the results buffer
- -
- public
- key() : PropertyValue
-
-
-
-
-
-
- Entity ID
-Generate a new entity attached to this entity set instance
@@ -1535,40 +1422,6 @@Move to the next entity in the results buffer
- -
- public
- next() : 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 @@Rewind the results buffer
- -
- public
- rewind() : mixed
-
-
-
-
-
-
- Set the maximum pagination size to use with the service providing results into the buffer
- -
- public
- setMaxPageSize(int $maxPageSize) : $this
-
-
-
- Maximum page size
-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 @@Whether there is a current entity in the results buffer -Implements internal pagination
- -
- public
- valid() : bool
-
-
-
-
-
-
- Whether there is a valid entity in the current position of the buffer
-
+ public
+ count() : int
+
+
+
+
+
+ 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 @@ Query Interface
@@ -116,9 +116,10 @@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 @@
public
- __construct(Countable $countable) : mixed
+ __construct(CountInterface $countable) : mixed
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 @@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 @@ - - - - -