4
0
api-powers/src/2315a1c5-bcf6-401a-8d11-60f4d6d12dbb/README.md

126 lines
3.0 KiB
Markdown
Raw Normal View History

2023-09-26 06:24:03 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# final class Tagged (Details)
2024-04-06 13:05:35 +00:00
> namespace: **TrueChristianChurch\Joomla\GetBible**
2023-09-26 06:24:03 +00:00
```uml
@startuml
2023-10-07 12:23:18 +00:00
class Tagged << (F,LightGreen) >> #RoyalBlue {
2023-09-26 06:24:03 +00:00
# Load $load
# Insert $insert
# Update $update
# Linker $linker
# Registry $params
# CMSApplication $app
+ __construct(Load $load, Insert $insert, ...)
+ set(string $translation, int $book, ...) : ?array
+ delete(string $tagged) : ?array
- getByGuid(string $guid) : ?object
- get(string $linker, int $book, ...) : ?object
- create(string $linker, string $translation, ...) : bool
- createForLinker(string $linker, object $tagged, ...) : bool
}
note right of Tagged::__construct
Constructor
since: 2.0.1
arguments:
Load $load
Insert $insert
Update $update
Linker $linker
?Registry $params = null
?CMSApplication $app = null
end note
note right of Tagged::set
Set a tagged verse
since: 2.0.1
return: ?array
arguments:
string $translation
int $book
int $chapter
int $verse
string $tag
end note
note right of Tagged::delete
Delete a tagged verse
since: 2.0.1
return: ?array
end note
note right of Tagged::getByGuid
Get a tagged verse
since: 2.0.1
return: ?object
end note
note right of Tagged::get
Get a tagged verse
since: 2.0.1
return: ?object
arguments:
string $linker
int $book
int $chapter
int $verse
string $tag
end note
note right of Tagged::create
Create a Tagged verse
since: 2.0.1
return: bool
arguments:
string $linker
string $translation
int $book
int $chapter
int $verse
string $tag
end note
note right of Tagged::createForLinker
Create a Tagged verse for a linker using a system tagged verse
since: 2.0.1
return: bool
arguments:
string $linker
object $tagged
int $published = -2
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)