2023-07-04 06:26:08 +00:00
|
|
|
```
|
|
|
|
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
|
|
|
|
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
|
|
|
|
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
|
|
|
|
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
|
|
|
|
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
|
|
|
|
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
|
|
|
|
```
|
|
|
|
# final class Load (Details)
|
2024-06-21 12:01:19 +00:00
|
|
|
> namespace: **VDM\Joomla\Database**
|
2023-10-04 18:23:30 +00:00
|
|
|
> extends: **Database**
|
2023-07-04 06:26:08 +00:00
|
|
|
```uml
|
|
|
|
@startuml
|
2023-10-04 18:23:30 +00:00
|
|
|
class Load << (F,LightGreen) >> #RoyalBlue {
|
2023-07-04 06:26:08 +00:00
|
|
|
+ rows(array $select, array $tables, ...) : ?array
|
|
|
|
+ items(array $select, array $tables, ...) : ?array
|
|
|
|
+ row(array $select, array $tables, ...) : ?array
|
|
|
|
+ item(array $select, array $tables, ...) : ?object
|
2023-07-24 16:13:52 +00:00
|
|
|
+ max(string $field, array $tables, ...) : ?int
|
|
|
|
+ count(array $tables, array $filter) : ?int
|
2023-07-04 06:26:08 +00:00
|
|
|
+ value(array $select, array $tables, ...) : mixed
|
2024-06-23 20:34:48 +00:00
|
|
|
+ values(array $select, array $tables, ...) : ?array
|
2023-07-04 06:26:08 +00:00
|
|
|
# many(array $select, array $tables, ...) : bool
|
|
|
|
# one(array $select, array $tables, ...) : bool
|
|
|
|
# query(array $select, array $tables, ...) : ?object
|
2024-06-21 12:01:19 +00:00
|
|
|
# getKey(array $select) : ?string
|
2023-07-04 06:26:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
note right of Load::rows
|
|
|
|
Load data rows as an array of associated arrays
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?array
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
?int $limit = null
|
|
|
|
end note
|
|
|
|
|
|
|
|
note left of Load::items
|
|
|
|
Load data rows as an array of objects
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?array
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
?int $limit = null
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Load::row
|
|
|
|
Load data row as an associated array
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?array
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
end note
|
|
|
|
|
|
|
|
note left of Load::item
|
|
|
|
Load data row as an object
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?object
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
end note
|
|
|
|
|
2023-07-24 16:13:52 +00:00
|
|
|
note right of Load::max
|
|
|
|
Get the max value based on a filtered result from a given table
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?int
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
string $field
|
|
|
|
array $tables
|
|
|
|
array $filter
|
|
|
|
end note
|
|
|
|
|
|
|
|
note left of Load::count
|
|
|
|
Count the number of items based on filter result from a given table
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?int
|
|
|
|
end note
|
|
|
|
|
2023-07-04 06:26:08 +00:00
|
|
|
note right of Load::value
|
|
|
|
Load one value from a row
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: mixed
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
end note
|
|
|
|
|
2024-06-23 20:34:48 +00:00
|
|
|
note left of Load::values
|
|
|
|
Load values from multiple rows
|
|
|
|
|
|
|
|
since: 3.2.2
|
|
|
|
return: ?array
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
?int $limit = null
|
|
|
|
end note
|
|
|
|
|
|
|
|
note right of Load::many
|
2023-07-04 06:26:08 +00:00
|
|
|
Load many
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: bool
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
?int $limit = null
|
|
|
|
end note
|
|
|
|
|
2024-06-23 20:34:48 +00:00
|
|
|
note left of Load::one
|
2023-07-04 06:26:08 +00:00
|
|
|
Load one
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: bool
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
end note
|
|
|
|
|
2024-06-23 20:34:48 +00:00
|
|
|
note right of Load::query
|
2023-07-04 06:26:08 +00:00
|
|
|
Get the query object
|
|
|
|
|
|
|
|
since: 3.2.0
|
|
|
|
return: ?object
|
|
|
|
|
|
|
|
arguments:
|
|
|
|
array $select
|
|
|
|
array $tables
|
|
|
|
?array $where = null
|
|
|
|
?array $order = null
|
|
|
|
?int $limit = null
|
|
|
|
end note
|
2024-06-21 12:01:19 +00:00
|
|
|
|
2024-06-23 20:34:48 +00:00
|
|
|
note left of Load::getKey
|
2024-06-21 12:01:19 +00:00
|
|
|
Get the key from the selection array.
|
|
|
|
This function retrieves a key from the provided selection array.
|
|
|
|
The key is removed from the array after being retrieved.
|
|
|
|
|
|
|
|
since: 3.2.2
|
|
|
|
return: ?string
|
|
|
|
end note
|
2023-07-04 06:26:08 +00:00
|
|
|
|
|
|
|
@enduml
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
```
|
|
|
|
██╗ ██████╗██████╗
|
|
|
|
██║██╔════╝██╔══██╗
|
|
|
|
██║██║ ██████╔╝
|
|
|
|
██ ██║██║ ██╔══██╗
|
|
|
|
╚█████╔╝╚██████╗██████╔╝
|
|
|
|
╚════╝ ╚═════╝╚═════╝
|
|
|
|
```
|
|
|
|
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)
|
|
|
|
|