4
0
Fork 0
api-powers/src/4a4c786d-51f4-421a-aa61-262...
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 2023-09-26 08:24:03 2023-09-26 08:24:03 +02:00
settings.json update 2024-04-06 15:05:35 2024-04-06 15:05:35 +02:00

README.md

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

final class Chapter (Details)

namespace: TrueChristianChurch\Joomla\GetBible\Data

@startuml
class Chapter << (F,LightGreen) >> #RoyalBlue {
  # Load $load
  # Config $config
  # array $chapters
  + __construct(Load $load, Config $config)
  + getNumber() : string
  + getName() : string
  + getText() : string
  + getVerses() : ?array
  - get() : ?object
  - loadChapterData(string $abbreviation, int $book, ...) : ?object
  - convertVersesToText(array $verses) : string
  - generateCacheKey(string $abbreviation, int $book, ...) : string
}

note right of Chapter::__construct
  Constructor

  since: 2.0.1
end note

note left of Chapter::getNumber
  Get the chapter number

  since: 2.0.1
  return: string
end note

note right of Chapter::getName
  Get the chapter name

  since: 2.0.1
  return: string
end note

note left of Chapter::getText
  Get the chapter text

  since: 2.0.1
  return: string
end note

note right of Chapter::getVerses
  Get the chapter verses

  since: 2.0.1
  return: ?array
end note

note left of Chapter::get
  Get the chapter

  since: 2.0.1
  return: ?object
end note

note right of Chapter::loadChapterData
  Loads the chapter data from the database and updates the cache

  since: 2.0.1
  return: ?object
  
  arguments:
    string $abbreviation
    int $book
    int $chapter
end note

note left of Chapter::convertVersesToText
  Convert verses to text

  since: 2.0.1
  return: string
end note

note right of Chapter::generateCacheKey
  Generates a cache key based on the abbreviation, book, and chapter

  since: 2.0.1
  return: string
  
  arguments:
    string $abbreviation
    int $book
    int $chapter
end note
 
@enduml

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

Build with Joomla Component Builder