com web/bugs: Add type declarations to Captcha class: src/Utils/Captcha.php
| From: | Peter Kokot | Date: | Sun, 09 Dec 2018 21:01:39 +0000 |
| Subject: | com web/bugs: Add type declarations to Captcha class: src/Utils/Captcha.php | ||
| Groups: | php.webmaster | ||
| Request: | Send a blank email to php-webmaster+get-27519@lists.php.net to get a copy of this message | ||
Commit: 3f4ad27d0ebacbd2454b5107cc8017acc66ce9ce
Author: Peter Kokot <peterkokot@gmail.com> Sun, 9 Dec 2018 22:01:39 +0100
Parents: 4d51010f8c2e71a0d28a01de41f5358aec97e615
Branches: master
Link: http://git.php.net/?p=web/bugs.git;a=commitdiff;h=3f4ad27d0ebacbd2454b5107cc8017acc66ce9ce
Log:
Add type declarations to Captcha class
Changed paths:
M src/Utils/Captcha.php
Diff:
diff --git a/src/Utils/Captcha.php b/src/Utils/Captcha.php
index 01377aa..b56019a 100644
--- a/src/Utils/Captcha.php
+++ b/src/Utils/Captcha.php
@@ -10,11 +10,13 @@ class Captcha
{
/**
* First operand.
+ * @var int
*/
private $first;
/**
* Last operand.
+ * @var int
*/
private $last;
@@ -34,6 +36,7 @@ class Captcha
/**
* Current operation.
+ * @var string
*/
private $operation;
@@ -48,7 +51,7 @@ class Captcha
/**
* Set random operands values and operation.
*/
- public function randomize()
+ public function randomize(): void
{
$this->setFirst(rand(1, self::MAX));
$this->setLast(rand(1, self::MAX));
@@ -59,7 +62,7 @@ class Captcha
* First operand number setter to override default random pick. Defined as a
* separate method for convenience when unit testing.
*/
- public function setFirst($number)
+ public function setFirst(int $number): void
{
$this->first = $number;
}
@@ -68,7 +71,7 @@ class Captcha
* Last operand number setter to override default random pick. Defined as a
* separate method for convenience when unit testing.
*/
- public function setLast($number)
+ public function setLast(int $number): void
{
$this->last = $number;
}
@@ -76,7 +79,7 @@ class Captcha
/**
* Set the operation. If provided operation is invalid it falls back to addition.
*/
- public function setOperation($operation)
+ public function setOperation(string $operation): void
{
$this->operation = in_array($operation, self::OPERATIONS) ? $operation :
'addition';
}
@@ -84,7 +87,7 @@ class Captcha
/**
* Get current question equation string for displaying it to the user.
*/
- public function getQuestion()
+ public function getQuestion(): string
{
$this->sortOperands();
@@ -97,7 +100,7 @@ class Captcha
/**
* The correct current answer of the given equation question.
*/
- public function getAnswer()
+ public function getAnswer(): int
{
$this->sortOperands();
@@ -109,7 +112,7 @@ class Captcha
* operand first. With this, negative results are omitted for simplicity and
* possible better user experience.
*/
- private function sortOperands()
+ private function sortOperands(): void
{
$first = $this->first;
$last = $this->last;
@@ -123,7 +126,7 @@ class Captcha
/**
* Addition of two operands.
*/
- private function addition($first, $last)
+ private function addition(int $first, int $last): int
{
return $first + $last;
}
@@ -131,7 +134,7 @@ class Captcha
/**
* Subtraction of two operands.
*/
- private function subtraction($first, $last)
+ private function subtraction(int $first, int $last): int
{
return $first - $last;
}