4
0
Fork 0
api-powers/src/c03b9c61-17d3-4774-a335-783...
Robot cfe9fa7ba7
update 2024-04-06 15:05:35
2024-04-06 15:05:35 +02:00
..
README.md update 2024-04-06 15:05:35 2024-04-06 15:05:35 +02:00
code.php update 2024-04-06 15:05:35 2024-04-06 15:05:35 +02:00
code.power update 2024-01-28 20:35:38 2024-01-28 20:35:38 +02:00
settings.json update 2024-04-06 15:05:35 2024-04-06 15:05:35 +02:00

README.md

██████╗  ██████╗ ██╗    ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║    ██║██╔════╝██╔══██╗
██████╔╝██║   ██║██║ █╗ ██║█████╗  ██████╔╝
██╔═══╝ ██║   ██║██║███╗██║██╔══╝  ██╔══██╗
██║     ╚██████╔╝╚███╔███╔╝███████╗██║  ██║
╚═╝      ╚═════╝  ╚══╝╚══╝ ╚══════╝╚═╝  ╚═╝

final class Load (Details)

namespace: TrueChristianChurch\Joomla\GetBible\Database

@startuml
class Load << (F,LightGreen) >> #RoyalBlue {
  # Table $table
  # Model $model
  # Database $load
  + __construct(Table $table, Model $model, ...)
  + value(array $keys, string $field, ...) : mixed
  + max(array $filter, string $field, ...) : ?int
  + count(array $filter, string $table) : ?int
  + item(array $keys, string $table) : ?object
  + items(array $keys, string $table) : ?array
  - prefix(array $keys) : array
}

note right of Load::__construct
  Constructor

  since: 2.0.1
  
  arguments:
    Table $table
    Model $model
    Database $load
end note

note right of Load::value
  Get a value from a given table
Example: $this->value(
[
'abbreviation' => 'kjv',
'book_nr' => 62,
'chapter' => 3,
'verse' => 16
], 'value_key', 'table_name'
);

  since: 2.0.1
  return: mixed
  
  arguments:
    array $keys
    string $field
    string $table
end note

note right of Load::max
  Get the max value based on a filtered result from a given table
Example: $this->max(
[
'abbreviation' => 'kjv',
'book_nr' => 62,
'chapter' => 3,
'verse' => 16
], 'value_key', 'table_name'
);

  since: 2.0.1
  return: ?int
  
  arguments:
    array $filter
    string $field
    string $table
end note

note right of Load::count
  Count the number of items based on filter result from a given table
Example: $this->count(
[
'abbreviation' => 'kjv',
'book_nr' => 62,
'chapter' => 3,
'verse' => 16
], 'table_name'
);

  since: 2.0.1
  return: ?int
end note

note right of Load::item
  Get values from a given table
Example: $this->item(
[
'abbriviation' => 'kjv',
'book_nr' => 62,
'chapter' => 3,
'verse' => 16
], 'table_name'
);

  since: 2.0.1
  return: ?object
end note

note right of Load::items
  Get values from a given table
Example: $this->items(
[
'abbriviation' => [
'operator' => 'IN',
'value' => ['kjv', 'aov']
],
'book_nr' => 62,
'chapter' => 3,
'verse' =>  [
'operator' => 'IN',
'value' => [16, 17, 18]
]
], 'table_name'
);
Example: $this->items($ids, 'table_name');

  since: 2.0.1
  return: ?array
end note

note right of Load::prefix
  Add prefix to the keys

  since: 2.0.1
  return: array
end note
 
@enduml

     ██╗ ██████╗██████╗
     ██║██╔════╝██╔══██╗
     ██║██║     ██████╔╝
██   ██║██║     ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
 ╚════╝  ╚═════╝╚═════╝

Build with Joomla Component Builder