4
0
api-powers/src/a752e4b2-9b5e-4188-8d33-3799c46d5119/README.md
2023-06-02 04:47:47 +02:00

2.1 KiB

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

final class Chapters (Details)

namespace: VDM\Joomla\GetBible\Api

@startuml
class Chapters << (F,LightGreen) >> #Green {
  + get(int $book, string $translation = 'kjv') : ?object
  + list(int $book, string $translation = 'kjv') : ?object
  + checksum(int $book, string $translation = 'kjv') : ?object
  + sha(int $chapter, int $book, ...) : ?string
}

note right of Chapters::get
  Get the chapters in a book in a translation

  since: 2.0.1
  return: ?object
end note

note right of Chapters::list
  List the chapters of a book in a translation

  since: 2.0.1
  return: ?object
end note

note right of Chapters::checksum
  List the chapters checksums of a book in a translation

  since: 2.0.1
  return: ?object
end note

note right of Chapters::sha
  Get the chapter's checksums of a book in a translation

  since: 2.0.1
  return: ?string
  
  arguments:
    int $chapter
    int $book
    string $translation = 'kjv'
end note
 
@enduml

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

Build with Joomla Component Builder