Continue improving type hints

lib/Exceptions/ArtistNameRequiredException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class ArtistNameRequiredException extends AppException{
+	/** @var string $message */
 	protected $message = 'An artist name is required.';
 }

lib/Exceptions/ArtistNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class ArtistNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that artist.';
 }

lib/Exceptions/ArtworkAlreadyExistsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class ArtworkAlreadyExistsException extends AppException{
+	/** @var string $message */
 	protected $message = 'An artwork with this name already exists.';
 }

lib/Exceptions/ArtworkImageDimensionsTooSmallException.php

@@ -2,10 +2,10 @@
 namespace Exceptions;
 
 class ArtworkImageDimensionsTooSmallException extends AppException{
-	protected $message;
-
 	// This has to be initialized in a constructor because we use the number_format() function.
 	public function __construct(){
 		$this->message = 'Image dimensions are too small. The minimum image size is ' . number_format(ARTWORK_IMAGE_MINIMUM_WIDTH) . ' × ' . number_format(ARTWORK_IMAGE_MINIMUM_HEIGHT) . '.';
+
+		parent::__construct($this->message);
 	}
 }

lib/Exceptions/ArtworkNameRequiredException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class ArtworkNameRequiredException extends AppException{
+	/** @var string $message */
 	protected $message = 'An artwork name is required.';
 }

lib/Exceptions/ArtworkNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class ArtworkNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that artwork.';
 }

lib/Exceptions/DuplicateDatabaseKeyException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class DuplicateDatabaseKeyException extends AppException{
+	/** @var string $message */
 	protected $message = 'An attempted row insertion has violated the database unique index.';
 }

lib/Exceptions/InvalidArtistException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidArtistException extends ValidationException{
+	/** @var string $message */
 	protected $message = 'Artist is invalid.';
 }

lib/Exceptions/InvalidArtworkException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidArtworkException extends ValidationException{
+	/** @var string $message */
 	protected $message = 'Artwork is invalid.';
 }

lib/Exceptions/InvalidArtworkPageUrlException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidArtworkPageUrlException extends InvalidUrlException{
+	/** @var string $message */
 	protected $message = 'Invalid link to page with artwork.';
 }

lib/Exceptions/InvalidArtworkTagException.php

@@ -2,11 +2,14 @@
 namespace Exceptions;
 
 class InvalidArtworkTagException extends ValidationException{
+	/** @var string $message */
 	protected $message = 'Artwork tag is invalid.';
 
 	public function __construct(?string $tagName){
 		if($tagName !== null && trim($tagName) != ''){
 			$this->message = 'Artwork tag ' . $tagName . ' is invalid.';
 		}
+
+		parent::__construct($this->message);
 	}
 }

lib/Exceptions/InvalidArtworkTagNameException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidArtworkTagNameException extends AppException{
+	/** @var string $message */
 	protected $message = 'Artwork tags can only contain letters and numbers.';
 }

lib/Exceptions/InvalidCaptchaException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidCaptchaException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t validate your CAPTCHA response.';
 }

lib/Exceptions/InvalidCompletedYearException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidCompletedYearException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid year of completion.';
 }

lib/Exceptions/InvalidCopyrightPageUrlException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidCopyrightPageUrlException extends InvalidUrlException{
+	/** @var string $message */
 	protected $message = 'Invalid link to page with copyright details.';
 }

lib/Exceptions/InvalidCredentialsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidCredentialsException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid credentials.';
 }

lib/Exceptions/InvalidDeathYearException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidDeathYearException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid year of death.';
 }

lib/Exceptions/InvalidEmailException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidEmailException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t understand your email address.';
 }

lib/Exceptions/InvalidImageUploadException.php

@@ -3,11 +3,6 @@
 namespace Exceptions;
 
 class InvalidImageUploadException extends AppException{
-	public function __construct(?string $message = null){
-		if($message === null){
-			$message = 'Uploaded image is invalid.';
-		}
-
-		parent::__construct($message);
-	}
+	/** @var string $message */
+	protected $message = 'Uploaded image is invalid.';
 }

lib/Exceptions/InvalidLoginException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidLoginException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t validate your login information.';
 }

lib/Exceptions/InvalidMimeTypeException.php

@@ -3,5 +3,6 @@
 namespace Exceptions;
 
 class InvalidMimeTypeException extends AppException{
+	/** @var string $message */
 	protected $message = 'Uploaded image must be a JPG, BMP, PNG, or TIFF file.';
 }

lib/Exceptions/InvalidMuseumUrlException.php

@@ -4,5 +4,7 @@ namespace Exceptions;
 class InvalidMuseumUrlException extends InvalidUrlException{
 	public function __construct(string $url, string $exampleUrl){
 		$this->message = 'Invalid museum URL: <' . $url . '>. Expected a URL like: <'. $exampleUrl . '>.';
+
+		parent::__construct($this->message);
 	}
 }

lib/Exceptions/InvalidNewsletterSubscription.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidNewsletterSubscription extends ValidationException{
+	/** @var string $message */
 	protected $message = 'Newsletter subscription is invalid.';
 }

lib/Exceptions/InvalidPageScanUrlException.php

@@ -4,5 +4,7 @@ namespace Exceptions;
 class InvalidPageScanUrlException extends InvalidUrlException{
 	public function __construct(string $url, string $exampleUrl){
 		$this->message = 'Invalid page scan URL: <' . $url . '>. Expected a URL like: <'. $exampleUrl . '>.';
+
+		parent::__construct($this->message);
 	}
 }

lib/Exceptions/InvalidPermissionsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidPermissionsException extends AppException{
+	/** @var string $message */
 	protected $message = 'You don’t have permission to perform that action.';
 }

lib/Exceptions/InvalidPollVoteException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidPollVoteException extends ValidationException{
+	/** @var string $message */
 	protected $message = 'Vote is invalid.';
 }

lib/Exceptions/InvalidPublicationYearException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidPublicationYearException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid year of publication.';
 }

lib/Exceptions/InvalidPublicationYearPageUrlException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidPublicationYearPageUrlException extends InvalidUrlException{
+	/** @var string $message */
 	protected $message = 'Invalid link to page with year of publication.';
 }

lib/Exceptions/InvalidRequestException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class InvalidRequestException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid HTTP request.';
 }

lib/Exceptions/InvalidUrlException.php

@@ -2,6 +2,7 @@
 namespace Exceptions;
 
 class InvalidUrlException extends AppException{
+	/** @var string $message */
 	protected $message = 'Invalid URL.';
 
 	public function __construct(?string $url = null){

lib/Exceptions/MissingEbookException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class MissingEbookException extends AppException{
+	/** @var string $message */
 	protected $message = 'Artwork marked as “in use”, but the ebook couldn’t be found in the filesystem.';
 }

lib/Exceptions/MissingPdProofException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class MissingPdProofException extends AppException{
+	/** @var string $message */
 	protected $message = 'Missing proof of U.S. public domain status.';
 }

lib/Exceptions/MuseumNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class MuseumNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that museum.';
 }

lib/Exceptions/NewsletterRequiredException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class NewsletterRequiredException extends AppException{
+	/** @var string $message */
 	protected $message = 'You must select at least one newsletter to subscribe to.';
 }

lib/Exceptions/NewsletterSubscriptionExistsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class NewsletterSubscriptionExistsException extends AppException{
+	/** @var string $message */
 	protected $message = 'You’re already subscribed to the newsletter.';
 }

lib/Exceptions/NewsletterSubscriptionNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class NewsletterSubscriptionNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t find you in our newsletter subscribers list.';
 }

lib/Exceptions/PatronNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PatronNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate you in the Patrons Circle.';
 }

lib/Exceptions/PaymentExistsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PaymentExistsException extends AppException{
+	/** @var string $message */
 	protected $message = 'This transaction ID already exists.';
 }

lib/Exceptions/PollClosedException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PollClosedException extends AppException{
+	/** @var string $message */
 	protected $message = 'This poll is not open to voting right now.';
 }

lib/Exceptions/PollItemNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PollItemNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that poll item.';
 }

lib/Exceptions/PollItemRequiredException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PollItemRequiredException extends AppException{
+	/** @var string $message */
 	protected $message = 'You must select an item to vote on.';
 }

lib/Exceptions/PollNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PollNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that poll.';
 }

lib/Exceptions/PollVoteExistsException.php

@@ -2,7 +2,8 @@
 namespace Exceptions;
 
 class PollVoteExistsException extends AppException{
-	public $Vote = null;
+	public ?\PollVote $Vote = null;
+	/** @var string $message */
 	protected $message = 'You’ve already voted in this poll.';
 
 	public function __construct(?\PollVote $vote = null){

lib/Exceptions/PollVoteNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class PollVoteNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that vote.';
 }

lib/Exceptions/TagsRequiredException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class TagsRequiredException extends AppException{
+	/** @var string $message */
 	protected $message = 'At least one tag is required.';
 }

lib/Exceptions/TooManyTagsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class TooManyTagsException extends AppException{
+	/** @var string $message */
 	protected $message = 'Too many tags; the maximum is ' . ARTWORK_MAX_TAGS . '.';
 }

lib/Exceptions/UserExistsException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class UserExistsException extends AppException{
+	/** @var string $message */
 	protected $message = 'This email already exists in the database.';
 }

lib/Exceptions/UserNotFoundException.php

@@ -2,5 +2,6 @@
 namespace Exceptions;
 
 class UserNotFoundException extends AppException{
+	/** @var string $message */
 	protected $message = 'We couldn’t locate that user.';
 }

lib/Exceptions/ValidationException.php

@@ -1,10 +1,8 @@
 <?
 namespace Exceptions;
 
-/**
-  * @property array<\Exception> $Exceptions
- */
 class ValidationException extends AppException{
+	/** @var array<\Exception> $Exceptions */
 	public $Exceptions = [];
 	public bool $HasExceptions = false;
 	public bool $IsFatal = false;

lib/Exceptions/WebhookException.php

@@ -2,7 +2,7 @@
 namespace Exceptions;
 
 class WebhookException extends AppException{
-	public $PostData;
+	public ?string $PostData;
 
 	public function __construct(string $message = '', string $data = null){
 		$this->PostData = $data;