sunnysideup / silverstripe-campaignmonitor

code/api/CampaignMonitorAPIConnector.php

Doc Comments +20 added lines, -11 removed lines

@@ -80,6 +80,7 @@ 
      * turn debug on or off
      *
      * @param Boolean
+     * @param boolean $b
      */
     public function setDebug($b)
     {
@@ -160,6 +161,8 @@ 
     /**
      * returns the result or NULL in case of an error
      * @param CS_REST_Wrapper_Result
+     * @param CS_REST_Wrapper_Result $result
+     * @param string $apiCall
      * @return Mixed | Null
      */
     protected function returnResult($result, $apiCall, $description)
@@ -517,7 +520,8 @@ 
      * @param string $listID - list ID
      * @param string $type - type of custom field
      * @param string $title - field type
-     * @param array $options - options for dropdown field type
+     * @param string[] $options - options for dropdown field type
+     * @param boolean $visible
      *
      * @return CS_REST_Wrapper_Result A successful response will be the key of the newly created custom field
      */
@@ -626,7 +630,7 @@ 
      * Gets all active subscribers added since the given date
      *
      * @param Int $listID
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -679,7 +683,7 @@ 
      * Gets all unconfirmed subscribers added since the given date
      *
      * @param Int $listID
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -732,7 +736,7 @@ 
      * Gets all bounced subscribers who have bounced out since the given date
      *
      * @param Int $listID
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -786,7 +790,7 @@ 
      * Gets all unsubscribed subscribers who have unsubscribed since the given date
      *
      * @param Int $listID
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -839,7 +843,7 @@ 
      * Gets all unsubscribed subscribers who have unsubscribed since the given date
      *
      * @param Int $listID
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -898,7 +902,8 @@ 
      * @param string $confirmationSuccessPage - The page to redirect subscribers to when they confirm their subscription
      * @param string $unsubscribeSetting - Unsubscribe setting must be CS_REST_LIST_UNSUBSCRIBE_SETTING_ALL_CLIENT_LISTS or CS_REST_LIST_UNSUBSCRIBE_SETTING_ONLY_THIS_LIST.  See the documentation for details: http://www.campaignmonitor.com/api/lists/#creating_a_list
      * @param boolean $addUnsubscribesToSuppList -  When UnsubscribeSetting is CS_REST_LIST_UNSUBSCRIBE_SETTING_ALL_CLIENT_LISTS, whether unsubscribes from this list should be added to the suppression list.
-     * @param boolean $acrubActiveWithSuppList - When UnsubscribeSetting is CS_REST_LIST_UNSUBSCRIBE_SETTING_ALL_CLIENT_LISTS, whether active subscribers should be scrubbed against the suppression list.
+     * @param boolean $scrubActiveWithSuppList - When UnsubscribeSetting is CS_REST_LIST_UNSUBSCRIBE_SETTING_ALL_CLIENT_LISTS, whether active subscribers should be scrubbed against the suppression list.
+     * @param CS_REST_Wrapper_Result $listID
      *
      * @return CS_REST_Wrapper_Result A successful response will be empty
      */
@@ -1208,7 +1213,7 @@ 
      * Gets all unsubscribes recorded for a campaign since the provided date
      *
      * @param int $campaignID ID of the Campaign
-     * @param string $daysAgo The date to start getting subscribers from
+     * @param integer $daysAgo The date to start getting subscribers from
      * @param int $page The page number to get
      * @param int $pageSize The number of records per page
      * @param string $sortByField ('EMAIL', 'NAME', 'DATE')
@@ -1279,6 +1284,7 @@ 
      * email address belongs.
      *
      * @param string | Member $email Subscriber's email address (or Member)
+     * @param null|SS_Object $member
      *
      * @return CS_REST_Wrapper_Result A successful response will be an object of the form
      * array(
@@ -1314,7 +1320,7 @@ 
      * @param Array $customFields
      * @param array $customFields The subscriber details to use during creation.
      * @param boolean $resubscribe Whether we should resubscribe this subscriber if they already exist in the list
-     * @param boolean $RestartSubscriptionBasedAutoResponders Whether we should restart subscription based auto responders which are sent when the subscriber first subscribes to a list.
+     * @param boolean $restartSubscriptionBasedAutoResponders Whether we should restart subscription based auto responders which are sent when the subscriber first subscribes to a list.
      *
      * NOTE that for the custom fields they need to be formatted like this:
      *    Array(
@@ -1427,9 +1433,9 @@ 
      * given email not existing in the list.
      *
      * @param Int $listID
-     * @param ArraySet $memberSet - list of mebers
+     * @param ArraySet $membersSet - list of mebers
      * @param array $customFields The subscriber details to use during creation. Each array item needs to have the same key as the member ID - e.g. array( 123 => array( [custom fields here] ), 456 => array( [custom fields here] ) )
-     * @param $resubscribe Whether we should resubscribe any existing subscribers
+     * @param boolean $resubscribe Whether we should resubscribe any existing subscribers
      * @param $queueSubscriptionBasedAutoResponders By default, subscription based auto responders do not trigger during an import. Pass a value of true to override this behaviour
      * @param $restartSubscriptionBasedAutoResponders By default, subscription based auto responders will not be restarted
      *
@@ -1494,6 +1500,7 @@ 
     /**
      * @param Int $listID
      * @param Member | String $member - email address or Member Object
+     * @param DataObject|null $member
      *
      * @return CS_REST_Wrapper_Result A successful response will be empty
      */
@@ -1592,6 +1599,7 @@ 
      *
      * @param Int $listID
      * @param Member | String $member
+     * @param DataObject|null $member
      *
      * @return Boolean
      */
@@ -1661,6 +1669,7 @@ 
      *
      * @param Int $listID
      * @param Member | String $member
+     * @param DataObject|null $member
      *
      * @return CS_REST_Wrapper_Result A successful response will be an object of the form
      * {