CampaignMonitorMemberDOD - Code Metrics - sunnysideup/silverstripe-campaignmonitor - Measure and Improve Code Quality continuously with Scrutinizer

CampaignMonitorMemberDOD C
last analyzed 2018-06-20 01:09 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	318
Duplicated Lines	9.12 %

Coupling/Cohesion

Components	2
Dependencies	13

Importance

Changes

Metric	Value
wmc	62
lcom	2
cbo	13
dl	29
loc	318
rs	5.9493
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMAPI()	0	8	2
D	getCampaignMonitorSignupField()	0	86	22
D	processCampaignMonitorSignupField()	0	35	9
A	unsubscribe()	11	11	2
A	IsCampaignMonitorSubscriber()	0	7	2
C	addCampaignMonitorList()	9	44	12
C	removeCampaignMonitorList()	9	26	8
B	CampaignMonitorSignupPageIDs()	0	14	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like CampaignMonitorMemberDOD often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use CampaignMonitorMemberDOD, and based on these observations, apply Extract Interface, too.

<?php

/**
 * @author nicolaas [at] sunnysideup.co.nz
 * TO DO: only apply the on afterwrite to people in the subscriber group.
 *
 **/

class CampaignMonitorMemberDOD extends DataExtension
namespace YourVendor;

class YourClass { }
{

    /**
     * name of the field to use for sign-ups
     * @var String
     */
    private static $campaign_monitor_signup_fieldname = "CampaignMonitorSubscriptions";


    /**
     * array of fields where the member value is set as the default for the
     * custom field ...
     * The should be like this
     *
     *     CustomFieldCode => MemberFieldOrMethod
     * @var array
     */
    private static $custom_fields_member_field_or_method_map = array();


    /**
     *
     *
     * @var null | CampaignMonitorAPIConnector
     *
     */
    private static $_api = null;

    /**
     *
     * @return CampaignMonitorAPIConnector
     */
    private function getCMAPI()
    {
        if (!self::$_api) {
            self::$_api = CampaignMonitorAPIConnector::create();

            self::$_api->init();
        }
        return self::$_api;
    }

    /**
     * returns a form field for signing up to all available lists
     * or if a list is provided, for that particular list.
     *
     * @param CampaignMonitorSignupPage | string | Null $listPage
     * @param string $fieldName
     * @param string $fieldTitle
     *
     * @return FormField
     */
    public function getCampaignMonitorSignupField($listPage = null, $fieldName = "", $fieldTitle = "")
    {
        if (!is_object($listPage)) {
            $listPage = CampaignMonitorSignupPage::get()->filter(array("ListID" => $listPage))->first();
        }
        $field = null;
        if (!$fieldName) {
            $fieldName = Config::inst()->get("CampaignMonitorMemberDOD", "campaign_monitor_signup_fieldname");
        }
        $api = $this->getCMAPI();
        $currentValues = null;
        if ($listPage) {
            if ($listPage->ReadyToReceiveSubscribtions()) {
                $currentSelection = "Subscribe";
                $optionArray = array();
                $optionArray["Subscribe"] = _t("CampaignMonitorSignupPage.SUBSCRIBE_TO", "subscribe to")." ".$listPage->getListTitle();
                $optionArray["Unsubscribe"] = _t("CampaignMonitorSignupPage.UNSUBSCRIBE_FROM", "unsubscribe from ")." ".$listPage->getListTitle();
                if ($this->owner->exists()) {
                    if ($api->getSubscriberCanReceiveEmailsForThisList($listPage->ListID, $this->owner)) {
                        $currentValues = $api->getSubscriber($listPage->ListID, $this->owner);
                        //$currentSelection = "Unsubscribe";

                    }
                }
                if (!$fieldTitle) {
                    $fieldTitle = _t("CampaignMonitorSignupPage.SIGNUP_FOR", "Sign up for ")." ".$listPage->getListTitle();
                }
                $subscribeField = OptionsetField::create($fieldName, $fieldTitle, $optionArray, $currentSelection);
                $field = CompositeField::create($subscribeField);
                $field->addExtraClass("CMFieldsCustomFieldsHolder");
                //add custom fields
                $linkedMemberFields = Config::inst()->get("CampaignMonitorMemberDOD", "custom_fields_member_field_or_method_map");
                $customFields = $listPage->CampaignMonitorCustomFields()->filter(array("Visible" => 1));
                foreach ($customFields as $customField) {
                    $valueSet = false;
                    $customFormField = $customField->getFormField("CMCustomField");
                    if ($currentValues && isset($currentValues->CustomFields)) {
                        foreach ($currentValues->CustomFields as $customFieldObject) {

                            if ($customFieldObject->Key == $customField->Title) {
                                if ($value = $customFieldObject->Value) {
                                    $valueSet = true;
                                }
                                $customFormField->setValue($value);
                            }
                        }
                    }
                    if (isset($linkedMemberFields[$customFormField->Code]) && !$valueSet) {
                        $fieldOrMethod = $linkedMemberFields[$custom->Code];

                        if ($this->owner->hasMethod($fieldOrMethod)) {
                            $value = $this->owner->$fieldOrMethod();
                        } else {
                            $value = $this->owner->$fieldOrMethod;
                        }
                        if ($value) {
                            $customFormField->setValue($value);
                        }
                    }
                    $field->push($customFormField);
                }
            }
        } else {
            if (!$fieldTitle) {
                $fieldTitle = _t("CampaignMonitorMemberDOD.NEWSLETTERSIGNUP", "Newsletter sign-up");
            }
            $lists = CampaignMonitorSignupPage::get_ready_ones();
            $array = array();
            foreach ($lists as $list) {
                $array[$list->ListID] = $list->getListTitle();
            }
            if (count($array)) {
                $field = new CheckboxSetField(
                    $fieldName,
                    $fieldTitle,
                    $array
                );
                $field->setDefaultItems($this->owner->CampaignMonitorSignupPageIDs());
            }
        }
        if (!$field) {
            $field = ReadonlyField::create(
                $fieldName,
                $fieldTitle,
                _t("CampaignMonitorMemberDOD.NO_LISTS_AVAILABLE", "No lists available right now.  Please come back soon.")
            );
        }
        return $field;
    }


    /**
     * action subscription form
     * @param CampaignMonitorSignUpPage $page
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param Array $array
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param Form $form
     *
     * return string: can be subscribe / unsubscribe / error
     */
    public function processCampaignMonitorSignupField($listPage, $data, $form)

    {
        $typeOfAction = "unsubscribe";
        //many choices
        if (isset($data["SubscribeManyChoices"])) {
            $listPages = CampaignMonitorSignupPage::get_ready_ones();
            foreach ($listPages as $listPage) {
                if (isset($data["SubscribeManyChoices"][$listPage->ListID]) && $data["SubscribeManyChoices"][$listPage->ListID]) {
                    $this->owner->addCampaignMonitorList($listPage->ListID);
                    $typeOfAction = "subscribe";
                } else {
                    $this->owner->removeCampaignMonitorList($listPage->ListID);
                }
            }
        }
        //one choice
        elseif (isset($data["SubscribeChoice"])) {
            if ($data["SubscribeChoice"] == "Subscribe") {
                $customFields = $listPage->CampaignMonitorCustomFields()->filter(array("Visible" => 1));
                $customFieldsArray = array();
                foreach ($customFields as $customField) {
                    if (isset($data["CMCustomField".$customField->Code])) {
                        $customFieldsArray[$customField->Code] = $data["CMCustomField".$customField->Code];
                    }
                }
                $this->owner->addCampaignMonitorList($listPage->ListID, $customFieldsArray);
                $typeOfAction = "subscribe";
            } else {
                $this->owner->removeCampaignMonitorList($listPage->ListID);
            }
        } else {
            user_error("Subscriber field missing", E_USER_WARNING);
        }
        return $typeOfAction;
    }

    /**
     * immediately unsubscribe if you are logged in.
     * @param HTTPRequest
     */
    public function unsubscribe($request)

    {
        $member = Member::currentUser();
        if ($member) {
            $member->removeCampaignMonitorList($this->ListID);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->Content = $member->Email." has been removed from this list: ".$this->getListTitle();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        } else {
            Security::permissionFailure($this, _t("CAMPAIGNMONITORSIGNUPPAGE.LOGINFIRST", "Please login first."));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        return array();
    }

    /**
     * is this user currently signed up to one or more newsletters
     *
     * @return Boolean

     */
    public function IsCampaignMonitorSubscriber()
    {
        CampaignMonitorSignupPage::get_ready_ones()
            ->where("MemberID = ".$this->owner->ID)

            ->innerJoin("Group_Members", "CampaignMonitorSignupPage ON CampaignMonitorSignupPage.GroupID = Group_Members.GroupID")
            ->count() ? true : false;
    }

    /**
     * add to Group
     * add to CM database...
     * @param CampaignMonitorSignupPage | Int $listPage
     * @param array $customFields
     * @return Boolean - returns true on success
     */
    public function addCampaignMonitorList($listPage, $customFields = array())
    {
        $api = $this->getCMAPI();
        $outcome = 0;
        if (is_string($listPage)) {
            $listPage = CampaignMonitorSignupPage::get()->filter(array("ListID" => $listPage))->first();
        }
        //internal database
        if ($listPage && $listPage->GroupID) {

            if ($gp = Group::get()->byID($listPage->GroupID)) {
                $groups = $this->owner->Groups();
                if ($groups) {
                    $this->owner->Groups()->add($gp);
                    $outcome++;
                }
            }
        }
        if ($listPage && $listPage->ListID) {
            if ($api->getSubscriber($listPage->ListID, $this->owner)) {
                if ($api->updateSubscriber(
                    $listPage->ListID,
                    $oldEmailAddress = "",
                    $this->owner,

                    $customFields,
                    $resubscribe = true,
                    $restartSubscriptionBasedAutoResponders = false
                )) {
                    $outcome++;
                }
            } elseif (!$api->addSubscriber(
                $listPage->ListID,
                $this->owner,

                $customFields,
                true,
                false
            )) {
                $outcome++;
            }
        }
        if ($outcome > 1) {

            return true;
        }
        return false;
    }

    /**
     *
     * remove from Group
     * remove from CM database...
     * @param CampaignMonitorSignupPage | Int $listPage
     * @return boolean returns true if successful.
     */
    public function removeCampaignMonitorList($listPage)
    {
        $api = $this->getCMAPI();
        $outcome = 0;
        if (is_string($listPage)) {
            $listPage = CampaignMonitorSignupPage::get()->filter(array("ListID" => $listPage))->first();
        }
        if ($listPage->GroupID) {

            if ($gp = Group::get()->byID($listPage->GroupID)) {
                $groups = $this->owner->Groups();
                if ($groups) {
                    $this->owner->Groups()->remove($gp);
                    $outcome++;
                }
            }
        }
        if ($listPage->ListID) {
            if (!$api->unsubscribeSubscriber($listPage->ListID, $this->owner)) {
                $outcome++;
            }
        }
        if ($outcome > 1) {

            return true;
        }
        return false;
    }

    /**
     * returns a list of list IDs
     * that the user is currently subscribed to.
     *
     * @return Array
     */
    public function CampaignMonitorSignupPageIDs()
    {
        $api = $this->getCMAPI();
        $lists = $api->getListsForEmail($this->owner);
        $array = array();
        if ($lists && count($lists)) {
            foreach ($lists as $listArray) {

                if (in_array($listArray["SubscriberState"], array("Active", "Bounced"))) {
                    $array[$listArray["ListID"]] = $listArray["ListID"];
                }
            }
        }
        return $array;
    }
}


1			<?php
2
3			/**
4			* @author nicolaas [at] sunnysideup.co.nz
5			* TO DO: only apply the on afterwrite to people in the subscriber group.
6			*
7			**/
8
9			class CampaignMonitorMemberDOD extends DataExtension
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10			{
11
12			/**
13			* name of the field to use for sign-ups
14			* @var String
15			*/
16			private static $campaign_monitor_signup_fieldname = "CampaignMonitorSubscriptions";
			0 ignored issues – show Unused Code introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report The property `$campaign_monitor_signup_fieldname` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
17
18			/**
19			* array of fields where the member value is set as the default for the
20			* custom field ...
21			* The should be like this
22			*
23			* CustomFieldCode => MemberFieldOrMethod
24			* @var array
25			*/
26			private static $custom_fields_member_field_or_method_map = array();
			0 ignored issues – show Unused Code introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report The property `$custom_fields_member_field_or_method_map` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
27
28			/**
29			*
30			*
31			* @var null \| CampaignMonitorAPIConnector
32			*
33			*/
34			private static $_api = null;
35
36			/**
37			*

sunnysideup / silverstripe-campaignmonitor

CampaignMonitorMemberDOD C last analyzed 2018-06-20 01:09 UTC