standardebooks/web
1
0
Fork 0
mirror of https://github.com/standardebooks/web.git synced 2025-07-14 10:31:59 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify comments

Browse source
This commit is contained in:
Alex Cabal 2024-12-05 11:22:37 -06:00
parent ad980bd1d3
commit 77540dacbb
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/Ebook.php
View file

@ -19,7 +19,7 @@ use function Safe\shell_exec;
* @property array<Contributor> $Illustrators * @property array<Contributor> $Illustrators
* @property array<Contributor> $Translators * @property array<Contributor> $Translators
* @property array<Contributor> $Contributors * @property array<Contributor> $Contributors
* @property ?array<string> $TocEntries * @property ?array<string> $TocEntries A list of non-Roman ToC entries *only if* the work has the `se:is-a-collection` metadata element; `null` otherwise.
* @property string $Url * @property string $Url
* @property bool $HasDownloads * @property bool $HasDownloads
* @property string $UrlSafeIdentifier * @property string $UrlSafeIdentifier
@ -34,7 +34,7 @@ use function Safe\shell_exec;
* @property string $ReadingEaseDescription * @property string $ReadingEaseDescription
* @property string $ReadingTime * @property string $ReadingTime
* @property string $AuthorsHtml * @property string $AuthorsHtml
* @property string $AuthorsUrl * @property string $AuthorsUrl This is a single URL even if there are multiple authors; for example, `/ebooks/karl-marx_friedrich-engels/`.
* @property string $ContributorsHtml * @property string $ContributorsHtml
* @property string $TitleWithCreditsHtml * @property string $TitleWithCreditsHtml
* @property string $TextUrl * @property string $TextUrl
@ -65,9 +65,13 @@ class Ebook{
public float $ReadingEase; public float $ReadingEase;
public ?string $GitHubUrl = null; public ?string $GitHubUrl = null;
public ?string $WikipediaUrl = null; public ?string $WikipediaUrl = null;
/** When the ebook was published. */
public DateTimeImmutable $EbookCreated; public DateTimeImmutable $EbookCreated;
/** When the ebook was updated. */
public DateTimeImmutable $EbookUpdated; public DateTimeImmutable $EbookUpdated;
/** When the database row was created. */
public DateTimeImmutable $Created; public DateTimeImmutable $Created;
/** When the database row was updated. */
public DateTimeImmutable $Updated; public DateTimeImmutable $Updated;
public ?int $TextSinglePageByteCount = null; public ?int $TextSinglePageByteCount = null;
@ -90,7 +94,7 @@ class Ebook{
/** @var array<Contributor> $_Contributors */ /** @var array<Contributor> $_Contributors */
protected array $_Contributors; protected array $_Contributors;
/** @var ?array<string> $_TocEntries */ /** @var ?array<string> $_TocEntries */
protected ?array $_TocEntries = null; // A list of non-Roman ToC entries *only if* the work has the `se:is-a-collection` metadata element; `null` otherwise. protected ?array $_TocEntries = null;
protected string $_Url; protected string $_Url;
protected bool $_HasDownloads; protected bool $_HasDownloads;
protected string $_UrlSafeIdentifier; protected string $_UrlSafeIdentifier;
@ -105,7 +109,7 @@ class Ebook{
protected string $_ReadingEaseDescription; protected string $_ReadingEaseDescription;
protected string $_ReadingTime; protected string $_ReadingTime;
protected string $_AuthorsHtml; protected string $_AuthorsHtml;
protected string $_AuthorsUrl; // This is a single URL even if there are multiple authors; for example, `/ebooks/karl-marx_friedrich-engels/`. protected string $_AuthorsUrl;
protected string $_ContributorsHtml; protected string $_ContributorsHtml;
protected string $_TitleWithCreditsHtml; protected string $_TitleWithCreditsHtml;
protected string $_TextUrl; protected string $_TextUrl;

2
scripts/update-ebook-database
View file

@ -15,7 +15,7 @@ if(isset($options['v']) || isset($options['verbose'])){
} }
if($ebookWwwFilesystemPath === null){ if($ebookWwwFilesystemPath === null){
print("Expected usage: update-ebook-database [-v,--verbose] --ebook-www-filesystem-path <path>\n"); print("Usage: update-ebook-database [-v,--verbose] --ebook-www-filesystem-path PATH\n");
exit(1); exit(1);
} }