Fix php doc-blocks. Closes #39.

php-slack · Mar 18, 2020 · dcb9186 · dcb9186
1 parent 55e52b2
commit dcb9186
Show file tree

Hide file tree

Showing 20 changed files with 88 additions and 85 deletions.
diff --git a/src/Block.php b/src/Block.php
@@ -44,7 +44,7 @@ public function getBlockId()
      *
      * @param string $blockId
      *
-     * @return Block
+     * @return $this
      */
     public function setBlockId($blockId)
     {

diff --git a/src/Block/ElementsBlock.php b/src/Block/ElementsBlock.php
@@ -55,7 +55,7 @@ public function getElementsAsArrays()
      *
      * @param array $elements
      *
-     * @return ElementsBlock
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -73,7 +73,7 @@ public function setElements(array $elements)
     /**
      * Remove all elements from the block.
      *
-     * @return ElementsBlock
+     * @return $this
      */
     public function clearElements()
     {
@@ -87,7 +87,7 @@ public function clearElements()
      *
      * @param array|BlockElement $element
      *
-     * @return ElementsBlock
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */

diff --git a/src/Block/Input.php b/src/Block/Input.php
@@ -70,7 +70,7 @@ public function getLabel()
      *
      * @param mixed
      *
-     * @return Input
+     * @return $this
      */
     public function setLabel($label)
     {
@@ -94,7 +94,7 @@ public function getElement()
      *
      * @param mixed
      *
-     * @return Input
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -126,7 +126,7 @@ public function getHint()
      *
      * @param mixed
      *
-     * @return Input
+     * @return $this
      */
     public function setHint($hint)
     {
@@ -150,7 +150,7 @@ public function getOptional()
      *
      * @param bool
      *
-     * @return Input
+     * @return $this
      */
     public function setOptional($optional)
     {

diff --git a/src/Block/Section.php b/src/Block/Section.php
@@ -61,7 +61,7 @@ class Section extends Block
     /**
      * Get the section text.
      *
-     * @return string
+     * @return \Maknz\Slack\BlockElement\Text
      */
     public function getText()
     {
@@ -73,7 +73,7 @@ public function getText()
      *
      * @param mixed $text
      *
-     * @return Section
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -89,7 +89,7 @@ public function setText($text)
      *
      * @param mixed $field
      *
-     * @return Section
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -117,7 +117,7 @@ public function getAccessory()
      *
      * @param mixed $accessory
      *
-     * @return Section
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */

diff --git a/src/BlockElement/AbstractSelect.php b/src/BlockElement/AbstractSelect.php
@@ -9,21 +9,21 @@ abstract class AbstractSelect extends Options
     /**
      * Select placeholder.
      *
-     * @var Maknz\Slack\BlockElement\Text
+     * @var \Maknz\Slack\BlockElement\Text
      */
     protected $placeholder;
 
     /**
      * Select option groups.
      *
-     * @var Maknz\Slack\Object\OptionGroup[]
+     * @var \Maknz\Slack\Object\OptionGroup[]
      */
     protected $option_groups = [];
 
     /**
      * Get the placeholder.
      *
-     * @return Maknz\Slack\BlockElement\Text
+     * @return \Maknz\Slack\BlockElement\Text
      */
     public function getPlaceholder()
     {
@@ -35,7 +35,7 @@ public function getPlaceholder()
      *
      * @param mixed $placeholder
      *
-     * @return AbstractSelect
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -51,7 +51,7 @@ public function setPlaceholder($placeholder)
      *
      * @param array $options
      *
-     * @return AbstractSelect
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -67,7 +67,7 @@ public function setOptions(array $options)
      *
      * @param mixed $option
      *
-     * @return AbstractSelect
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -82,7 +82,7 @@ public function addOption($option)
     /**
      * Get the option groups.
      *
-     * @return Maknz\Slack\Object\OptionGroup[]
+     * @return \Maknz\Slack\Object\OptionGroup[]
      */
     public function getOptionGroups()
     {
@@ -110,7 +110,7 @@ public function getOptionGroupsAsArrays()
      *
      * @param array $groups
      *
-     * @return AbstractSelect
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -129,7 +129,7 @@ public function setOptionGroups(array $groups)
     /**
      * Clear option groups in the block.
      *
-     * @return AbstractSelect
+     * @return $this
      */
     public function clearOptionGroups()
     {
@@ -141,7 +141,7 @@ public function clearOptionGroups()
     /**
      * Clear options and option groups.
      *
-     * @return AbstractSelect
+     * @return $this
      */
     public function clearAllOptions()
     {
@@ -156,7 +156,7 @@ public function clearAllOptions()
      *
      * @param mixed $group
      *
-     * @return AbstractSelect
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */

diff --git a/src/BlockElement/Button.php b/src/BlockElement/Button.php
@@ -17,7 +17,7 @@ class Button extends Confirmable
     /**
      * Button text.
      *
-     * @var Maknz\Slack\BlockElement\Text
+     * @var \Maknz\Slack\BlockElement\Text
      */
     protected $text;
 
@@ -66,7 +66,7 @@ class Button extends Confirmable
     /**
      * Get the button text.
      *
-     * @return Maknz\Slack\BlockElement\Text
+     * @return \Maknz\Slack\BlockElement\Text
      */
     public function getText()
     {
@@ -78,7 +78,7 @@ public function getText()
      *
      * @param mixed $text
      *
-     * @return Button
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -104,7 +104,7 @@ public function getActionId()
      *
      * @param string $actionId
      *
-     * @return Button
+     * @return $this
      */
     public function setActionId($actionId)
     {
@@ -128,7 +128,7 @@ public function getUrl()
      *
      * @param string $url
      *
-     * @return Button
+     * @return $this
      */
     public function setUrl($url)
     {
@@ -152,7 +152,7 @@ public function getValue()
      *
      * @param string $value
      *
-     * @return Button
+     * @return $this
      */
     public function setValue($value)
     {
@@ -176,7 +176,7 @@ public function getStyle()
      *
      * @param string $style
      *
-     * @return Button
+     * @return $this
      */
     public function setStyle($style)
     {

diff --git a/src/BlockElement/Checkboxes.php b/src/BlockElement/Checkboxes.php
@@ -26,7 +26,7 @@ class Checkboxes extends Options
     /**
      * Get the intially selected options.
      *
-     * @return Maknz\Slack\Object\Option[]
+     * @return \Maknz\Slack\Object\Option[]
      */
     public function getInitialOptions()
     {

diff --git a/src/BlockElement/Confirmable.php b/src/BlockElement/Confirmable.php
@@ -29,7 +29,7 @@ public function getConfirm()
      *
      * @param mixed $confirm
      *
-     * @return Confirmable
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */

diff --git a/src/BlockElement/DatePicker.php b/src/BlockElement/DatePicker.php
@@ -60,7 +60,7 @@ public function getActionId()
      *
      * @param string $actionId
      *
-     * @return DatePicker
+     * @return $this
      */
     public function setActionId($actionId)
     {
@@ -84,7 +84,7 @@ public function getPlaceholder()
      *
      * @param mixed $placeholder
      *
-     * @return DatePicker
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -110,7 +110,7 @@ public function getInitialDate()
      *
      * @param \DateTime $initialDate
      *
-     * @return DatePicker
+     * @return $this
      */
     public function setInitialDate(DateTime $initialDate)
     {

diff --git a/src/BlockElement/MultiSelect.php b/src/BlockElement/MultiSelect.php
@@ -29,7 +29,7 @@ class MultiSelect extends AbstractSelect
     /**
      * Get the intially selected options.
      *
-     * @return Maknz\Slack\Object\Option[]
+     * @return \Maknz\Slack\Object\Option[]
      */
     public function getInitialOptions()
     {

diff --git a/src/BlockElement/Options.php b/src/BlockElement/Options.php
@@ -29,7 +29,7 @@ public function getActionId()
      *
      * @param string $actionId
      *
-     * @return Options
+     * @return $this
      */
     public function setActionId($actionId)
     {

diff --git a/src/BlockElement/RadioButtons.php b/src/BlockElement/RadioButtons.php
@@ -34,7 +34,7 @@ class RadioButtons extends Options
     /**
      * Get the intially selected option.
      *
-     * @return Maknz\Slack\Object\Option
+     * @return \Maknz\Slack\Object\Option|null
      */
     public function getInitialOption()
     {
@@ -43,14 +43,16 @@ public function getInitialOption()
                 return $option;
             }
         }
+
+        return null;
     }
 
     /**
      * Add an option to the radio buttons.
      *
      * @param mixed $option
      *
-     * @return RadioButtons
+     * @return $this
      *
      * @throws \InvalidArgumentException
      */
@@ -72,7 +74,7 @@ public function addOption($option)
     /**
      * Clear options available.
      *
-     * @return RadioButtons
+     * @return $this
      */
     public function clearOptions()
     {