A major update for PHP 7.0 type hinting

iranianpep · Nov 13, 2017 · 888c549 · 888c549
1 parent d0ab692
commit 888c549
Show file tree

Hide file tree

Showing 42 changed files with 259 additions and 255 deletions.
diff --git a/src/Botonomous/AbstractAccessList.php b/src/Botonomous/AbstractAccessList.php
@@ -45,7 +45,7 @@ protected function getSubAccessControlList($sublistKey)
      *
      * @return bool
      */
-    protected function isEmailInList(array $list)
+    protected function isEmailInList(array $list): bool
     {
         // get user info
         $userInfo = $this->getSlackUserInfo();
@@ -59,7 +59,7 @@ protected function isEmailInList(array $list)
      *
      * @return bool
      */
-    protected function checkEmail()
+    protected function checkEmail(): bool
     {
         // load the relevant list based on the class name e.g. BlackList or WhiteList
         $list = $this->getSubAccessControlList($this->getShortClassName());
@@ -74,12 +74,12 @@ protected function checkEmail()
 
     /**
      * @param string $requestKey
-     * @param $listKey
+     * @param string $listKey
      * @param string $subListKey
      *
      * @return bool|null
      */
-    protected function findInListByRequestKey($requestKey, $listKey, $subListKey)
+    protected function findInListByRequestKey(string $requestKey, string $listKey, string $subListKey)
     {
         /**
          * load the relevant list to start checking
@@ -123,7 +123,7 @@ public function setRequest($request)
     /**
      * @return Dictionary
      */
-    public function getDictionary()
+    public function getDictionary(): Dictionary
     {
         if (!isset($this->dictionary)) {
             $this->setDictionary(new Dictionary());
@@ -143,7 +143,7 @@ public function setDictionary(Dictionary $dictionary)
     /**
      * @return ApiClient
      */
-    public function getApiClient()
+    public function getApiClient(): ApiClient
     {
         if (!isset($this->apiClient)) {
             $this->setApiClient(new ApiClient());
@@ -192,7 +192,7 @@ public function getSlackUserInfo()
     /**
      * @return ClassUtility
      */
-    public function getClassUtility()
+    public function getClassUtility(): ClassUtility
     {
         if (!isset($this->classUtility)) {
             $this->setClassUtility(new ClassUtility());

diff --git a/src/Botonomous/AbstractBot.php b/src/Botonomous/AbstractBot.php
@@ -32,7 +32,7 @@ abstract class AbstractBot
     /**
      * @return Config
      */
-    public function getConfig()
+    public function getConfig(): Config
     {
         if ($this->config === null) {
             $this->config = (new Config());
@@ -52,7 +52,7 @@ public function setConfig(Config $config)
     /**
      * @return AbstractBaseListener
      */
-    public function getListener()
+    public function getListener(): AbstractBaseListener
     {
         if (!isset($this->listener)) {
             $listenerClass = __NAMESPACE__.'\\listener\\'.ucwords($this->getConfig()->get('listener')).'Listener';
@@ -70,7 +70,7 @@ public function setListener(AbstractBaseListener $listener)
     /**
      * @return MessageUtility
      */
-    public function getMessageUtility()
+    public function getMessageUtility(): MessageUtility
     {
         if (!isset($this->messageUtility)) {
             $this->setMessageUtility(new MessageUtility());
@@ -90,7 +90,7 @@ public function setMessageUtility(MessageUtility $messageUtility)
     /**
      * @return CommandContainer
      */
-    public function getCommandContainer()
+    public function getCommandContainer(): CommandContainer
     {
         if (!isset($this->commandContainer)) {
             $this->setCommandContainer(new CommandContainer());
@@ -110,7 +110,7 @@ public function setCommandContainer(CommandContainer $commandContainer)
     /**
      * @return FormattingUtility
      */
-    public function getFormattingUtility()
+    public function getFormattingUtility(): FormattingUtility
     {
         if (!isset($this->formattingUtility)) {
             $this->setFormattingUtility(new FormattingUtility());
@@ -130,7 +130,7 @@ public function setFormattingUtility(FormattingUtility $formattingUtility)
     /**
      * @return LoggerUtility
      */
-    public function getLoggerUtility()
+    public function getLoggerUtility(): LoggerUtility
     {
         if (!isset($this->loggerUtility)) {
             $this->setLoggerUtility(new LoggerUtility());
@@ -150,7 +150,7 @@ public function setLoggerUtility(LoggerUtility $loggerUtility)
     /**
      * @return OAuth
      */
-    public function getOauth()
+    public function getOauth(): OAuth
     {
         if (!isset($this->oauth)) {
             $this->setOauth(new OAuth());
@@ -170,7 +170,7 @@ public function setOauth(OAuth $oauth)
     /**
      * @return RequestUtility
      */
-    public function getRequestUtility()
+    public function getRequestUtility(): RequestUtility
     {
         return $this->getListener()->getRequestUtility();
     }
@@ -186,7 +186,7 @@ public function setRequestUtility(RequestUtility $requestUtility)
     /**
      * @return BlackList
      */
-    public function getBlackList()
+    public function getBlackList(): BlackList
     {
         if (!isset($this->blackList)) {
             $this->setBlackList(new BlackList($this->getListener()->getRequest()));
@@ -206,7 +206,7 @@ public function setBlackList(BlackList $blackList)
     /**
      * @return WhiteList
      */
-    public function getWhiteList()
+    public function getWhiteList(): WhiteList
     {
         if (!isset($this->whiteList)) {
             $this->setWhiteList(new WhiteList($this->getListener()->getRequest()));
@@ -226,7 +226,7 @@ public function setWhiteList(WhiteList $whiteList)
     /**
      * @return Sender
      */
-    public function getSender()
+    public function getSender(): Sender
     {
         if (!isset($this->sender)) {
             $this->setSender(new Sender($this));
@@ -246,7 +246,7 @@ public function setSender(Sender $sender)
     /**
      * @return Dictionary
      */
-    public function getDictionary()
+    public function getDictionary(): Dictionary
     {
         if (!isset($this->dictionary)) {
             $this->setDictionary(new Dictionary());
@@ -266,7 +266,7 @@ public function setDictionary(Dictionary $dictionary)
     /**
      * @return CommandExtractor
      */
-    public function getCommandExtractor()
+    public function getCommandExtractor(): CommandExtractor
     {
         if (!isset($this->commandExtractor)) {
             $this->setCommandExtractor(new CommandExtractor());

diff --git a/src/Botonomous/AbstractCommandContainer.php b/src/Botonomous/AbstractCommandContainer.php
@@ -43,13 +43,13 @@ public function getAll()
     }
 
     /**
-     * @param null $key
+     * @param string $key
      *
      * @throws \Exception
      *
      * @return mixed
      */
-    public function getAllAsObject($key = null)
+    public function getAllAsObject(string $key = null)
     {
         $commands = $this->getAll();
         if (!empty($commands)) {

diff --git a/src/Botonomous/AbstractConfig.php b/src/Botonomous/AbstractConfig.php
@@ -21,7 +21,7 @@ abstract class AbstractConfig
      *
      * @return mixed
      */
-    public function get($key, $replacements = [], $plugin = null)
+    public function get(string $key, array $replacements = [], $plugin = null)
     {
         $configs = static::$configs;
 
@@ -50,7 +50,7 @@ public function get($key, $replacements = [], $plugin = null)
      *
      * @return self
      */
-    private function getPluginConfigObject($plugin)
+    private function getPluginConfigObject($plugin): self
     {
         $pluginConfigClass = __NAMESPACE__.'\\plugin\\'.strtolower($plugin)
             .'\\'.ucfirst($plugin).'Config';
@@ -81,7 +81,7 @@ public function getPluginConfigs($plugin)
     /**
      * @return array
      */
-    public function getConfigs()
+    public function getConfigs(): array
     {
         return static::$configs;
     }

diff --git a/src/Botonomous/AbstractSender.php b/src/Botonomous/AbstractSender.php
@@ -19,7 +19,7 @@ abstract class AbstractSender
     /**
      * @return LoggerUtility
      */
-    public function getLoggerUtility()
+    public function getLoggerUtility(): LoggerUtility
     {
         if (!isset($this->loggerUtility)) {
             $this->setLoggerUtility(new LoggerUtility());
@@ -39,7 +39,7 @@ public function setLoggerUtility(LoggerUtility $loggerUtility)
     /**
      * @return Config
      */
-    public function getConfig()
+    public function getConfig(): Config
     {
         if (!isset($this->config)) {
             $this->config = (new Config());
@@ -59,7 +59,7 @@ public function setConfig(Config $config)
     /**
      * @return ApiClient
      */
-    public function getApiClient()
+    public function getApiClient(): ApiClient
     {
         if (!isset($this->apiClient)) {
             $this->setApiClient(new ApiClient());
@@ -79,7 +79,7 @@ public function setApiClient(ApiClient $apiClient)
     /**
      * @return Client
      */
-    public function getClient()
+    public function getClient(): Client
     {
         if (!isset($this->client)) {
             $this->setClient(new Client());
@@ -99,7 +99,7 @@ public function setClient(Client $client)
     /**
      * @return MessageUtility
      */
-    public function getMessageUtility()
+    public function getMessageUtility(): MessageUtility
     {
         if (!isset($this->messageUtility)) {
             $this->setMessageUtility(new MessageUtility());

diff --git a/src/Botonomous/AbstractSlackEntity.php b/src/Botonomous/AbstractSlackEntity.php
@@ -12,15 +12,15 @@ abstract class AbstractSlackEntity extends AbstractBaseSlack
     /**
      * @return string
      */
-    public function getSlackId()
+    public function getSlackId(): string
     {
         return $this->slackId;
     }
 
     /**
      * @param string $slackId
      */
-    public function setSlackId($slackId)
+    public function setSlackId(string $slackId)
     {
         $this->slackId = $slackId;
     }

diff --git a/src/Botonomous/Action.php b/src/Botonomous/Action.php
@@ -17,15 +17,15 @@ class Action extends AbstractBaseSlack
     /**
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * @param string $name
      */
-    public function setName($name)
+    public function setName(string $name)
     {
         $this->name = $name;
     }
@@ -41,39 +41,39 @@ public function getText()
     /**
      * @param string $text
      */
-    public function setText($text)
+    public function setText(string $text)
     {
         $this->text = $text;
     }
 
     /**
      * @return string
      */
-    public function getValue()
+    public function getValue(): string
     {
         return $this->value;
     }
 
     /**
      * @param string $value
      */
-    public function setValue($value)
+    public function setValue(string $value)
     {
         $this->value = $value;
     }
 
     /**
      * @return string
      */
-    public function getType()
+    public function getType(): string
     {
         return $this->type;
     }
 
     /**
      * @param string $type
      */
-    public function setType($type)
+    public function setType(string $type)
     {
         $this->type = $type;
     }

diff --git a/src/Botonomous/BlackList.php b/src/Botonomous/BlackList.php
@@ -17,7 +17,7 @@ public function __construct($request)
     /**
      * @return bool
      */
-    public function isBlackListed()
+    public function isBlackListed(): bool
     {
         return $this->isUsernameBlackListed()
             || $this->isUserIdBlackListed()
@@ -27,7 +27,7 @@ public function isBlackListed()
     /**
      * @return bool
      */
-    public function isUsernameBlackListed()
+    public function isUsernameBlackListed(): bool
     {
         return $this->findInListByRequestKey('user_name', $this->getShortClassName(), 'username') === true
             ? true : false;
@@ -36,7 +36,7 @@ public function isUsernameBlackListed()
     /**
      * @return bool
      */
-    public function isUserIdBlackListed()
+    public function isUserIdBlackListed(): bool
     {
         return $this->findInListByRequestKey('user_id', $this->getShortClassName(), 'userId') === true
             ? true : false;

diff --git a/src/Botonomous/Channel.php b/src/Botonomous/Channel.php
@@ -12,15 +12,15 @@ class Channel extends AbstractSlackEntity
     /**
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * @param string $name
      */
-    public function setName($name)
+    public function setName(string $name)
     {
         $this->name = $name;
     }