Fix docblock type definitions

civicrm · Jan 19, 2018 · daa78a8 · daa78a8
1 parent 8fd2683
commit daa78a8
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 10 deletions.
diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php
@@ -76,7 +76,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php
@@ -78,7 +78,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php
@@ -80,7 +80,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php
@@ -92,7 +92,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Contribute/StateMachine/Search.php b/CRM/Contribute/StateMachine/Search.php
@@ -78,7 +78,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array [ 'class' => task classname, 'result' => TRUE ]
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php
@@ -45,7 +45,7 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine {
    * Class constructor.
    *
    * @param object $controller
-   * @param \const|int $action
+   * @param int $action
    */
   public function __construct($controller, $action = CRM_Core_Action::NONE) {
     parent::__construct($controller, $action);
@@ -82,7 +82,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php
@@ -82,7 +82,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php
@@ -80,7 +80,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {

diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php
@@ -80,7 +80,7 @@ public function __construct($controller, $action = CRM_Core_Action::NONE) {
    *
    * @param string $formName
    *
-   * @return string
+   * @return array
    *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {