sunnysideup / silverstripe-campaignmonitor

code/CampaignMonitorSignupPage.php

<?php

/**
 * Page for Signing Up to Campaign Monitor List
 *
 * Each page relates to one CM list.
 *
 * @author nicolaas [at] sunnysideup.co.nz
 */
class CampaignMonitorSignupPage extends Page

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * standard SS variable
     * @Var String
     */
    private static $singular_name = "Newsletter sign-up page";

The property $singular_name is not used and could be removed.

    public function i18n_singular_name()
    {
        return _t("AccountPage.NEWSLETTER_PAGE", "Newsletter sign-up page");
    }

    /**
     * standard SS variable
     * @Var String
     */
    private static $plural_name = "Newsletter sign-up pages";

The property $plural_name is not used and could be removed.

    public function i18n_plural_name()
    {
        return _t("AccountPage.NEWSLETTER_PAGE", "Newsletter sign-up pages");
    }

    /**
     *
     * @inherited
     */
    private static $icon = "campaignmonitor/images/treeicons/CampaignMonitorSignupPage";

The property $icon is not used and could be removed.

    /**
     *
     * @inherited
     */
    private static $db = array(

The property $db is not used and could be removed.

        'ListID' => 'Varchar(32)',

        'ConfirmTitle' => 'Varchar(255)',
        'ConfirmMenuTitle' => 'Varchar(255)',
        'ConfirmMessage' => 'HTMLText',

        'ThankYouTitle' => 'Varchar(255)',
        'ThankYouMenuTitle' => 'Varchar(255)',
        'ThankYouMessage' => 'HTMLText',

        'SadToSeeYouGoTitle' => 'Varchar(255)',
        'SadToSeeYouGoMenuTitle' => 'Varchar(255)',
        'SadToSeeYouGoMessage' => 'HTMLText',

        'SignUpHeader' => 'Varchar(100)',
        'SignUpIntro' => 'HTMLText',
        'SignUpButtonLabel' => 'Varchar(20)',

        'ShowOldNewsletters' => 'Boolean',
        'ShowAllNewsletterForSigningUp' => 'Boolean',

    );

    /**
     *
     * @inherited
     */
    private static $has_one = array(

The property $has_one is not used and could be removed.

        "Group" => "Group"
    );

    /**
     *
     * @inherited
     */
    private static $has_many = array(

The property $has_many is not used and could be removed.

        "CampaignMonitorSegments" => "CampaignMonitorSegment",
        "CampaignMonitorCustomFields" => "CampaignMonitorCustomField"
    );

    /**
     *
     * @inherited
     */
    private static $belongs_many_many = array(

The property $belongs_many_many is not used and could be removed.

        "CampaignMonitorCampaigns" => "CampaignMonitorCampaign"
    );

    /**
     *
     * @inherited
     */
    private static $description = "Page to suscribe and review newsletter list(s)";

The property $description is not used and could be removed.

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


    /**
     * Campaign monitor pages that are ready to receive "sign-ups"
     * @return ArrayList
     */
    public static function get_ready_ones()
    {
        $listPages = CampaignMonitorSignupPage::get();
        $array = array(0 => 0);
        foreach ($listPages as $listPage) {
            if ($listPage->ReadyToReceiveSubscribtions()) {
                $array[$listPage->ID] = $listPage->ID;
            }
        }
        return CampaignMonitorSignupPage::get()->filter(array("ID" => $array));
    }

    /**
     *
     * @inherited
     */
    public function getCMSFields()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fields = parent::getCMSFields();
        if ($this->GroupID) {
            $groupLink = '<h2><a href="/admin/security/EditForm/field/Groups/item/'.$this->GroupID.'/edit">open related security group</a></h2>';
        } else {
            $groupLink = '<p>No Group has been selected yet.</p>';
        }
        $testControllerLink = Injector::inst()->get("CampaignMonitorAPIConnector_TestController")->Link();
        $campaignExample = CampaignMonitorCampaign::get()->Last();
        $campaignExampleLink = $this->Link();
        if ($campaignExample) {
            $campaignExampleLink = $this->Link("viewcampaign/".$campaignExample->CampaignID);
        }
        if ($this->ID) {
            $config = GridFieldConfig_RelationEditor::create();
            $campaignField = new GridField('CampaignList', 'Campaigns', $this->CampaignMonitorCampaigns(), $config);
        } else {
            $campaignField = new HiddenField("CampaignList");
        }
        $gridFieldTemplatesAvailable = new GridField('TemplatesAvailable', 'Templates Available', CampaignMonitorCampaignStyle::get(), GridFieldConfig_RecordEditor::create());
        $gridFieldTemplatesAvailable->setDescription("Ask your developer on how to add more templates");
        $fields->addFieldToTab(
            'Root.AlternativeContent',
            new TabSet(
                "AlternativeContentSubHeader",
                    new Tab(
                        'Confirm',
                    new TextField('ConfirmTitle', 'Title'),
                    new TextField('ConfirmMenuTitle', 'Menu Title'),
                    new HtmlEditorField('ConfirmMessage', 'Message (e.g. thank you for confirming)')
                ),
                new Tab(
                    'ThankYou',
                    new TextField('ThankYouTitle', 'Title'),
                    new TextField('ThankYouMenuTitle', 'Menu Title'),
                    new HtmlEditorField('ThankYouMessage', 'Thank you message after submitting form')
                ),
                new Tab(
                    'SadToSeeYouGo',
                    new TextField('SadToSeeYouGoTitle', 'Title'),
                    new TextField('SadToSeeYouGoMenuTitle', 'Menu Title'),
                    new HtmlEditorField('SadToSeeYouGoMessage', 'Sad to see you  go message after submitting form')
                )
            )
        );
        $fields->addFieldToTab(
            'Root.Newsletters',
            new TabSet(
                'Options',
                new Tab(
                    'MainSettings',
                    new LiteralField('CreateNewCampaign', '<p>To create a new mail out go to <a href="'. Config::inst()->get("CampaignMonitorAPIConnector", "campaign_monitor_url") .'">Campaign Monitor</a> site.</p>'),
                    new LiteralField('ListIDExplanation', '<p>Each sign-up page needs to be associated with a campaign monitor subscription list.</p>'),
                    new DropdownField('ListID', 'Related List from Campaign Monitor (*)', array(0 => "-- please select --") + $this->makeDropdownListFromLists()),
                    new CheckboxField('ShowAllNewsletterForSigningUp', 'Allow users to sign up to all lists')
                ),
                new Tab(
                    'StartForm',
                    new LiteralField('StartFormExplanation', 'A start form is a form where people are just required to enter their email address and nothing else.  After completion they go through to another page (the actual CampaignMonitorSignUpPage) to complete all the details.'),
                    new TextField('SignUpHeader', 'Sign up header (e.g. sign up now)'),
                    new HtmlEditorField('SignUpIntro', 'Sign up form intro (e.g. sign up for our monthly newsletter ...'),
                    new TextField('SignUpButtonLabel', 'Sign up button label for start form (e.g. register now)')
                ),
                new Tab(
                    'Newsletters',
                    new CheckboxField('ShowOldNewsletters', 'Show old newsletters? Set to "NO" to remove all old newsletters links to this page. Set to "YES" to retrieve all old newsletters.'),
                    new LiteralField('CampaignExplanation', '<h3>Unfortunately, newsletter lists are not automatically linked to individual newsletters, you can link them here...</h3>'),
                    new CheckboxSetField('CampaignMonitorCampaigns', 'Newsletters shown', CampaignMonitorCampaign::get()->filter("HasBeenSent", 1)->limit(10000)->map()->toArray()),

The method toArray cannot be called on \CampaignMonitorCampaign::get()->filter('HasBeenSent', 1)->limit(10000)->map() (of type array).

                    $campaignField,
                    $gridFieldTemplatesAvailable
                ),
                new Tab(
                    'Advanced',
                    new LiteralField('MyControllerTest', '<h3><a href="'.$testControllerLink.'">Test Connections</a></h3>'),
                    new LiteralField('MyStats', '<h3><a href="'.$this->Link("stats").'">Stats and Debug information</a></h3>'),
                    new LiteralField('MyCampaignReset', '<h3><a href="'.$this->Link("resetoldcampaigns").'">Delete All Campaigns from Website</a></h3>'),
                    new LiteralField('MyCampaignInfo', '<h3>You can also view individual campaigns - here is <a href="'.$campaignExampleLink.'">an example</a></h3>'),
                    $gridField = new GridField('Segments', 'Segments', $this->CampaignMonitorSegments(), GridFieldConfig_RecordViewer::create()),
                    $gridField = new GridField('CustomFields', 'Custom Fields', $this->CampaignMonitorCustomFields(), GridFieldConfig_RecordViewer::create()),
                    new LiteralField('GroupLink', $groupLink)
                )
            )
        );
        if (!Config::inst()->get("CampaignMonitorWrapper", "campaign_monitor_url")) {

This if statement is empty and can be removed.

            //$fields->removeFieldFromTab("Root.Newsletters.Options", "CreateNewCampaign");

80% of this comment could be valid code. Did you maybe forget this after debugging?

        }
        return $fields;
    }

    /**
     *
     * @return CampaignMonitorAPIConnector
     */
    public function getAPI()
    {
        if (!self::$_api) {
            self::$_api = CampaignMonitorAPIConnector::create();
            self::$_api->init();
        }
        return self::$_api;
    }

    /**
     *
     * @var Null | Array
     */
    private static $drop_down_list = array();

    /**
     * returns available list for client
     * @return array
     */
    protected function makeDropdownListFromLists()
    {
        if (!isset(self::$drop_down_list[$this->ID])) {
            $array = array();
            $api = $this->getAPI();
            $lists = $api->getLists();
            if (is_array($lists) && count($lists)) {
                foreach ($lists as $list) {
                    $array[$list->ListID] = $list->Name;
                }
            }
            //remove subscription list IDs from other pages
            $subscribePages = CampaignMonitorSignupPage::get()
                ->exclude("ID", $this->ID);
            foreach ($subscribePages as $page) {
                if (isset($array[$page->ListID])) {
                    unset($array[$page->ListID]);
                }
            }
            self::$drop_down_list[$this->ID] = $array;
        }
        return self::$drop_down_list[$this->ID];
    }

    /**
     * you can add this function to other pages to have a form
     * that starts the basic after which the client needs to complete the rest.
     *
     * Or does a basic sign up if ajax submitted.
     *
     * @param Controller $controller
     * @param String $formName
     *
     * @return Form
     */
    public function CampaignMonitorStartForm(Controller $controller, $formName = "CampaignMonitorStarterForm")
    {
        if ($email = Session::get("CampaignMonitorStartForm_AjaxResult_".$this->ID)) {
            return $this->renderWith("CampaignMonitorStartForm_AjaxResult", array("Email" => $email));
        } else {
            Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
            //Requirements::javascript(THIRDPARTY_DIR . '/jquery-form/jquery.form.js');

46% of this comment could be valid code. Did you maybe forget this after debugging?

            Requirements::javascript(SS_CAMPAIGNMONITOR_DIR . '/javascript/CampaignMonitorStartForm.js');
            if (!$this->ReadyToReceiveSubscribtions()) {
                //user_error("You first need to setup a Campaign Monitor Page for this function to work.", E_USER_NOTICE);

63% of this comment could be valid code. Did you maybe forget this after debugging?

                return false;
            }
            $fields = new FieldList(new EmailField("CampaignMonitorEmail", _t("CAMPAIGNMONITORSIGNUPPAGE.EMAIL", "Email")));
            $actions = new FieldList(new FormAction("campaignmonitorstarterformstartaction", $this->SignUpButtonLabel));
            $form = new Form(
                $controller,
                $formName,
                $fields,
                $actions
            );
            $form->setFormAction($this->Link("preloademail"));
            return $form;
        }
    }

    /**
     * adds a subcriber to the list without worrying about making it a user ...
     *
     * @param String $email
     *
     * @returns
     */
    public function addSubscriber($email)
    {
        if ($this->ReadyToReceiveSubscribtions()) {
            $listID = $this->ListID;
            $email = Convert::raw2sql($email);
            $member = Member::get()->filter(array("Email" => $email))->first();
            if ($member && $member->exists()) {

This if statement is empty and can be removed.

                //do nothing
            } else {
                $member = new Member();
                $member->Email = $email;
                $member->SetPassword = true;

The property SetPassword does not seem to exist. Did you mean Password?

                $member->Password = Member::create_new_password();

The method Member::create_new_password() has been deprecated with message: 3.6.0..4.0.0

                $member->write();
            }
            if ($group = $this->Group()) {
                $group->Members()->add($member);
            }
            $api = $this->getAPI();
            $result = $api->addSubscriber($listID, $member);

$member of type object<DataObject> is not a sub-type of object<Member>. It seems like you assume a child class of the class DataObject to be always present.

            if ($result == $email) {
                return null;
            }
            return "ERROR: could not subscribe";
        }
        return "ERROR: not ready";
    }

    /**
     * name of the list connected to.
     * @return String
     */
    public function getListTitle()
    {
        if ($this->ListID) {
            $a = $this->makeDropdownListFromLists();
            if (isset($a[$this->ListID])) {
                return $a[$this->ListID];
            }
        }
        return "";
    }

    /**
     * tells us if the page is ready to receive subscriptions
     * @return Boolean
     */
    public function ReadyToReceiveSubscribtions()
    {
        return $this->ListID && $this->GroupID;
    }

    /**
     * check list and group IDs
     *
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        //check list
        if (!$this->getListTitle()) {
            $this->ListID = 0;
        }
        $gp = null;
        //check group
        if ($this->GroupID) {
            $gp = $this->Group();
            if (!$gp || !$gp->exists()) {
                $this->GroupID = 0;
            }
        }

        //add group
        if ($this->ListID) {
            if (!$this->GroupID) {
                $gp = new Group();
                $this->GroupID = $gp->ID;
                $gp->write();
            }
            $title = _t("CampaignMonitor.NEWSLETTER", "NEWSLETTER");
            if ($myListName = $this->getListTitle()) {
                $title .= ": ".$myListName;
            }
            $gp->Title = (string)$title;
            $gp->write();
        }
        if ($gp) {
            $this->GroupID = $gp->ID;
        }
    }

    /**
     * add old campaings or remove them
     * depending on the setting
     *
     * add / remove segments ...
     *
     */
    public function onAfterWrite()
    {
        parent::onAfterWrite();
        if ($this->ShowOldNewsletters) {
            $this->AddOldCampaigns();
        } else {
            $this->CampaignMonitorCampaigns()->filter(array("HasBeenSent" => 1))->removeAll();
        }
        //add segments
        $segmentsAdded = array();
        $segments = $this->api->getSegments($this->ListID);
        if ($segments && is_array($segments) && count($segments)) {
            foreach ($segments as $segment) {
                $segmentsAdded[$segment->SegmentID] = $segment->SegmentID;
                $filterArray = array("SegmentID" => $segment->SegmentID, "ListID" => $this->ListID, "CampaignMonitorSignupPageID" => $this->ID);
                $obj = CampaignMonitorSegment::get()->filter($filterArray)->first();
                if (!$obj) {
                    $obj = CampaignMonitorSegment::create($filterArray);
                }
                $obj->Title = $segment->Title;
                $obj->write();

The method write does only exist in DataObject, but not in CampaignMonitorSignupPage.

            }
        }
        $unwantedSegments = CampaignMonitorSegment::get()->filter(array("ListID" => $this->ListID, "CampaignMonitorSignupPageID" => $this->ID))
            ->exclude(array("SegmentID" => $segmentsAdded));
        foreach ($unwantedSegments as $unwantedSegment) {
            $unwantedSegment->delete();
        }
        //add custom fields
        $customCustomFieldsAdded = array();
        $customCustomFields = $this->api->getListCustomFields($this->ListID);
        if ($customCustomFields && is_array($customCustomFields) && count($customCustomFields)) {
            foreach ($customCustomFields as $customCustomField) {
                $obj = CampaignMonitorCustomField::create_from_campaign_monitor_object($customCustomField, $this->ListID);
                $customCustomFieldsAdded[$obj->Code] = $obj->Code;

The property Code does not exist on object<CampaignMonitorCustomField>. Since you implemented __get, maybe consider adding a @property annotation.

The property Code does not exist on object<CampaignMonitorCustomField>. Since you implemented __set, maybe consider adding a @property annotation.

            }
        }
        $unwantedCustomFields = CampaignMonitorCustomField::get()->filter(array("ListID" => $this->ListID, "CampaignMonitorSignupPageID" => $this->ID))
            ->exclude(array("Code" => $customCustomFieldsAdded));
        foreach ($unwantedCustomFields as $unwantedCustomField) {
            $unwantedCustomField->delete();
        }
    }

    public function AddOldCampaigns()
    {
        $task = CampaignMonitorAddOldCampaigns::create();
        $task->setVerbose(false);
        $task->run(null);
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $update = array();
        $page = CampaignMonitorSignupPage::get()->First();

        if ($page) {
            if (!$page->SignUpHeader) {
                $page->SignUpHeader = 'Sign Up Now';
                $update[]= "created default entry for SignUpHeader";
            }
            if (strlen($page->SignUpIntro) < strlen("<p> </p>")) {
                $page->SignUpIntro = '<p>Enter your email to sign up for our newsletter</p>';
                $update[]= "created default entry for SignUpIntro";
            }
            if (!$page->SignUpButtonLabel) {
                $page->SignUpButtonLabel = 'Register Now';
                $update[]= "created default entry for SignUpButtonLabel";
            }
            if (count($update)) {
                $page->writeToStage('Stage');
                $page->publish('Stage', 'Live');
                DB::alteration_message($page->ClassName." created/updated: ".implode(" --- ", $update), 'created');
            }
        }
    }
}

class CampaignMonitorSignupPage_Controller extends Page_Controller

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * retains email for processing
     * @var boolean
     */
    protected $isThankYou = false;

    /**
     * retains email for processing
     * @var boolean
     */
    protected $isUnsubscribe = false;

    /**
     * retains email for processing
     * @var boolean
     */
    protected $isConfirm = false;

    /**
     * retains email for processing
     * @var String
     */
    protected $email = '';

    /**
     * holder for selected campaign
     *
     * @var Null | CampaignMonitorCampaign
     */
    protected $campaign = '';

    private static $allowed_actions = array(

The property $allowed_actions is not used and could be removed.

        "SignupForm" => true,
        "subscribe" => true,
        "unsubscribe" => true,
        "thankyou" => true,
        "confirm" => true,
        "sadtoseeyougo" => true,
        "preloademail" => true,
        "viewcampaign" => true,
        "viewcampaigntextonly" => true,
        "previewcampaign" => true,
        "previewcampaigntextonly" => true,
        "stats" => true,
        "resetoldcampaigns" => true,
        "resetsignup" => true
    );

    public function init()
    {
        parent::init();
        Requirements::themedCSS("CampaignMonitorSignupPage", "campaignmonitor");
    }

    /**
     * creates a subscription form...
     * @return Form
     */
    public function SignupForm()
    {
        if ($this->ReadyToReceiveSubscribtions()) {
            // Create fields
            $member = Member::currentUser();
            $emailField = null;
            $emailRequired = true;
            if (!$member) {
                $member = new Member();
            } else {
                $this->email = $member->Email;
                if ($this->email) {
                    $emailRequired = false;
                    $emailField = new ReadonlyField('CampaignMonitorEmail', _t("CAMPAIGNMONITORSIGNUPPAGE.EMAIL", 'Email'), $this->email);
                }
            }
            if (!$emailField) {
                $emailField = new EmailField('CampaignMonitorEmail', _t("CAMPAIGNMONITORSIGNUPPAGE.EMAIL", 'Email'), $this->email);
            }
            if ($this->ShowAllNewsletterForSigningUp) {
                $signupField = $member->getCampaignMonitorSignupField(null, "SubscribeManyChoices");
            } else {
                $signupField = $member->getCampaignMonitorSignupField($this->ListID, "SubscribeChoice");
            }
            $fields = new FieldList(
                $emailField,
                $signupField
            );
            // Create action
            $actions = new FieldList(
                new FormAction('subscribe', _t("CAMPAIGNMONITORSIGNUPPAGE.UPDATE_SUBSCRIPTIONS", "Update Subscriptions"))
            );
            // Create Validators
            if ($emailRequired) {
                $validator = new RequiredFields('CampaignMonitorEmail');
            } else {
                $validator = new RequiredFields();
            }
            $form = new Form($this, 'SignupForm', $fields, $actions, $validator);
            if ($member->exists()) {
                $form->loadDataFrom($member);
            } else {
                $form->Fields()->fieldByName("CampaignMonitorEmail")->setValue($this->email);
            }
            return $form;
        } else {
            return _t("CampaignMonitorSignupPage.NOTREADY", "You can not suscribe to this newsletter at present.");
        }
    }

    /**
     * action subscription form
     * @param Array $array

There is no parameter named $array. Was it maybe removed?

     * @param Form $form
     *
     * return redirect
     */
    public function subscribe($data, $form)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($this->ReadyToReceiveSubscribtions()) {
            //true until proven otherwise.
            $newlyCreatedMember = false;
            $api = $this->getAPI();

$api is not used, you could remove the assignment.

            $member = Member::currentUser();

            //subscribe or unsubscribe?
            if (isset($data["SubscribeManyChoices"])) {
                $isSubscribe = true;
            } else {
                $isSubscribe = isset($data["SubscribeChoice"]) && $data["SubscribeChoice"] == "Subscribe";
            }

            //no member logged in: if the member already exists then you can't sign up.
            if (!$member) {
                $memberAlreadyLoggedIn = false;

$memberAlreadyLoggedIn is not used, you could remove the assignment.

                $filter = array("Email" => Convert::raw2sql($data["CampaignMonitorEmail"]));
                $existingMember = Member::get()->filter($filter)->First();
                //if($isSubscribe && $existingMember){

78% of this comment could be valid code. Did you maybe forget this after debugging?

                //$form->addErrorMessage('Email', _t("CAMPAIGNMONITORSIGNUPPAGE.EMAIL_EXISTS", "This email is already in use. Please log in for this email or try another email address."), 'warning');

74% of this comment could be valid code. Did you maybe forget this after debugging?

                //$this->redirectBack();

84% of this comment could be valid code. Did you maybe forget this after debugging?

                //return;
                //}
                $member = $existingMember;
                if (!$member) {
                    $newlyCreatedMember = true;
                    $member = Member::create($filter);
                }
            }

            //logged in: if the member already as someone else then you can't sign up.
            else {
                $memberAlreadyLoggedIn = true;

$memberAlreadyLoggedIn is not used, you could remove the assignment.

                //$existingMember = Member::get()

45% of this comment could be valid code. Did you maybe forget this after debugging?

                //	->filter(array("Email" => Convert::raw2sql($data["CampaignMonitorEmail"])))

72% of this comment could be valid code. Did you maybe forget this after debugging?

                //	->exclude(array("ID" => $member->ID))

67% of this comment could be valid code. Did you maybe forget this after debugging?

                //	->First();

67% of this comment could be valid code. Did you maybe forget this after debugging?

                //if($isSubscribe && $existingMember) {

70% of this comment could be valid code. Did you maybe forget this after debugging?

                    //$form->addErrorMessage('CampaignMonitorEmail', _t("CAMPAIGNMONITORSIGNUPPAGE.EMAIL_EXISTS", "This email is already in use by someone else. Please log in for this email or try another email address."), 'warning');

74% of this comment could be valid code. Did you maybe forget this after debugging?

                    //$this->redirectBack();

84% of this comment could be valid code. Did you maybe forget this after debugging?

                    //return;
                //}
            }

            //are any choices being made
            if (!isset($data["SubscribeChoice"]) && !isset($data["SubscribeManyChoices"])) {
                $form->addErrorMessage('SubscribeChoice', _t("CAMPAIGNMONITORSIGNUPPAGE.NO_NAME", "Please choose your subscription."), 'warning');
                $this->redirectBack();
                return;
            }

            //if this is a new member then we save the member
            if ($isSubscribe) {
                if ($newlyCreatedMember) {
                    $form->saveInto($member);
                    $member->Email = Convert::raw2sql($data["CampaignMonitorEmail"]);
                    $member->SetPassword = true;
                    $member->Password = Member::create_new_password();

The method Member::create_new_password() has been deprecated with message: 3.6.0..4.0.0

                    $member->write();

The method write does only exist in DataObject, but not in CampaignMonitorSignupPage_Controller.

                    $member->logIn($keepMeLoggedIn = false);
                }
            }
            $outcome = $member->processCampaignMonitorSignupField($this->dataRecord, $data, $form);
            if ($outcome == "subscribe") {
                return $this->redirect($this->link("thankyou"));
            } else {
                return $this->redirect($this->link("sadtoseeyougo"));
            }
        } else {
            user_error("No list to subscribe to", E_USER_WARNING);
        }
    }

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

This method seems to be duplicated in your project.

    {
        $member = Member::currentUser();
        if ($member) {
            $member->removeCampaignMonitorList($this->ListID);
            $this->Content = $member->Email." has been removed from this list: ".$this->getListTitle();
        } else {
            Security::permissionFailure($this, _t("CAMPAIGNMONITORSIGNUPPAGE.LOGINFIRST", "Please login first."));
        }
        return array();
    }

    /**
     * action
     * @param HTTPRequest
     */
    public function confirm($request)
    {
        $this->Title = $this->ConfirmTitle;
        $this->MenuTitle = $this->ConfirmMenuTitle;
        $this->Content = $this->ConfirmMessage;
        $this->isConfirm = true;
        return array();
    }

    /**
     * action
     * @param HTTPRequest
     */
    public function thankyou($request)
    {
        $this->Title = $this->ThankYouTitle;
        $this->MenuTitle = $this->ThankYouMenuTitle;
        $this->Content = $this->ThankYouMessage;
        $this->isThankYou = true;
        return array();
    }

    /**
     * action
     * @param HTTPRequest
     */
    public function sadtoseeyougo($request)
    {
        $this->Title = $this->SadToSeeYouGoTitle;
        $this->MenuTitle = $this->SadToSeeYouGoMenuTitle;
        $this->Content = $this->SadToSeeYouGoMessage;
        $this->isUnsubscribe = true;
        return array();
    }

    /**
     * action
     * @param HTTPRequest
     */
    public function preloademail(SS_HTTPRequest $request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $data = $request->requestVars();
        if (isset($data["CampaignMonitorEmail"])) {
            $email = Convert::raw2sql($data["CampaignMonitorEmail"]);
            if ($email) {
                $this->email = $email;

It seems like $email can also be of type array. However, the property $email is declared as type string. Maybe add an additional type check?

                if (Director::is_ajax()) {
                    if (!$this->addSubscriber($email)) {
                        Session::set("CampaignMonitorStartForm_AjaxResult_".$this->ID, $data["CampaignMonitorEmail"]);
                        return $this->renderWith("CampaignMonitorStartForm_AjaxResult");
                    } else {
                        return "ERROR";
                    }
                }
            }
        } else {
            if ($m = Member::currentUser()) {
                $this->email = $m->Email;
            }
        }
        return array();
    }

    /**
     *
     * action to show one campaign...
     */
    public function viewcampaign($request)

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        $id = intval($request->param("ID"));
        $this->campaign = CampaignMonitorCampaign::get()->byID($id);

It seems like \CampaignMonitorCampaign::get()->byID($id) can also be of type object<DataObject>. However, the property $campaign is declared as type null. Maybe add an additional type check?

        if (!$this->campaign) {
            return $this->httpError(404, _t("CAMPAIGNMONITORSIGNUPPAGE.CAMPAIGN_NOT_FOUND", "Message not found."));
        }
        return array();
    }

    /**
     *
     * action to show one campaign TEXT ONLY...
     */
    public function viewcampaigntextonly($request)

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        $id = intval($request->param("ID"));
        $this->campaign = CampaignMonitorCampaign::get()->byID($id);

It seems like \CampaignMonitorCampaign::get()->byID($id) can also be of type object<DataObject>. However, the property $campaign is declared as type null. Maybe add an additional type check?

        if (!$this->campaign) {
            return $this->httpError(404, _t("CAMPAIGNMONITORSIGNUPPAGE.CAMPAIGN_NOT_FOUND", "Message not found."));
        }
        return array();
    }

    /**
     *
     * action to preview one campaign...
     */
    public function previewcampaign($request)

The return type could not be reliably inferred; please add a @return annotation.

previewcampaign uses the super-global variable $_GET which is generally not recommended.

    {
        $id = intval($request->param("ID"));
        $this->campaign = CampaignMonitorCampaign::get()->byID($id);

It seems like \CampaignMonitorCampaign::get()->byID($id) can also be of type object<DataObject>. However, the property $campaign is declared as type null. Maybe add an additional type check?

        if ($this->campaign) {
            if (isset($_GET["hash"]) && strlen($_GET["hash"]) == 7 &&  $_GET["hash"] == $this->campaign->Hash) {
                return HTTP::absoluteURLs($this->campaign->getNewsletterContent());
            }
        }
        return $this->httpError(404, _t("CAMPAIGNMONITORSIGNUPPAGE.CAMPAIGN_NOT_FOUND", "No preview available."));
    }

    /**
     *
     * action to preview one campaign TEXT ONLY...
     */
    public function previewcampaigntextonly($request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $id = intval($request->param("ID"));
        $this->campaign = CampaignMonitorCampaign::get()->byID($id);

It seems like \CampaignMonitorCampaign::get()->byID($id) can also be of type object<DataObject>. However, the property $campaign is declared as type null. Maybe add an additional type check?

        if ($this->campaign) {
            return HTTP::absoluteURLs(strip_tags($this->campaign->getNewsletterContent()));
        }
        return $this->httpError(404, _t("CAMPAIGNMONITORSIGNUPPAGE.CAMPAIGN_NOT_FOUND", "No preview available."));
    }


    /**
     *
     * @return String
     */
    public function Email()
    {
        return $this->email;
    }

    /**
     *
     * @return Boolean
     */
    public function IsThankYou()
    {
        return $this->isThankYou;
    }

    /**
     *
     * @return Boolean
     */
    public function IsConfirm()
    {
        return $this->isConfirm;
    }

    /**
     *
     * @return Boolean
     */
    public function IsUnsubscribe()
    {
        return $this->isUnsubscribe;
    }

    /**
     *
     * @return Boolean
     */
    public function HasCampaign()
    {
        return $this->campaign ? true : false;
    }

    /**
     *
     * @return Null | CampaignMonitorCampaign
     */
    public function Campaign()
    {
        return $this->campaign;
    }


    /**
     * same as $this->CampaignMonitorCampaigns()
     * but sorted correctly.
     *
     * @return DataSet of CampaignMonitorCampaigns

Should the return type not be DataList|null?

     */
    public function PreviousCampaignMonitorCampaigns()
    {
        if ($this->ShowOldNewsletters) {
            $campaigns = $this->CampaignMonitorCampaigns();
            return CampaignMonitorCampaign::get()
                ->filter(
                    array(
                        "ID" => $campaigns->map("ID", "ID")->toArray(),
                        "Hide" => 0,
                        "HasBeenSent" => 1
                    )
                );
        }
    }

    /**
     * action for admins only to see a whole bunch of
     * stats
     */
    public function stats()
    {
        if (Permission::check("Admin")) {
            //run tests here
            $api = $this->getAPI();
            $html = "<div id=\"CampaignMonitorStats\">";
            $html .= "<h1>Debug Response</h1>";
            $html .= "<h2>Main Client Stuff</h2>";
            $html .= "<h3>Link to confirm page</h3>".Director::absoluteUrl($this->Link("confirm"))."";
            $html .= "<h3>Link to thank-you-page</h3>".Director::absoluteUrl($this->Link("thankyou"))."";
            $html .= "<h3>Link to sad-to-see-you-go page</h3>".Director::absoluteUrl($this->Link("sadtoseeyougo"))."";
            $html .= "<h3><a href=\"#\">All Campaigns</a></a></h3><pre>".print_r($api->getCampaigns(), 1)."</pre>";
            $html .= "<h3><a href=\"#\">All Lists</a></h3><pre>".print_r($api->getLists(), 1)."</pre>";
            if ($this->ListID) {
                $html .= "<h2>List</h2";
                $html .= "<h3><a href=\"#\" id=\"MyListStatsAreHere\">List Stats</a></h3><pre>".print_r($api->getListStats($this->ListID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">List Details</a></h3><pre>".print_r($api->getList($this->ListID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Active Subscribers (latest ones)</a></h3><pre>".print_r($api->getActiveSubscribers($this->ListID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Unconfirmed Subscribers (latest ones)</a></h3><pre>".print_r($api->getUnconfirmedSubscribers($this->ListID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Bounced Subscribers (latest ones)</a></h3><pre>".print_r($api->getBouncedSubscribers($this->ListID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Unsubscribed Subscribers (latest ones)</a></h3><pre>".print_r($api->getUnsubscribedSubscribers($this->ListID), 1)."</pre>";
            } else {
                $html .= "<h2 style=\"color: red;\">ERROR: No Lists selected</h2";
            }
            Requirements::customScript($this->JSHackForPreSections(), "CampaignMonitorStats");
            $html .= "</div>";
            $this->Content = $html;
        } else {
            Security::permissionFailure($this, _t("CAMPAIGNMONITORSIGNUPPAGE.TESTFAILURE", "This function is only available for administrators"), 1);

The call to Security::permissionFailure() has too many arguments starting with 1.

        }
        return array();
    }

    /**
     * returns a bunch of stats about a campaign
     * IF the user is an admin AND a campaign is selected
     * @return String (html) | false

Should the return type not be null|false?

     */
    public function CampaignStats()
    {
        if (Permission::check("CMS_ACCESS_CMSMain")) {
            if ($this->campaign) {
                //run tests here
                $api = $this->getAPI();
                $html = "<div id=\"CampaignMonitorStats\">";
                $html .= "<h2>Campaign Stats</h2>";
                $html .= "<h3><a href=\"#\">Campaign: ".$this->campaign->Subject."</a></h3>";
                $html .= "<h3><a href=\"#\">Summary</a></h3><pre>".print_r($api->getSummary($this->campaign->CampaignID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Email Client Usage</a></h3><pre>".print_r($api->getEmailClientUsage($this->campaign->CampaignID), 1)."</pre>";
                $html .= "<h3><a href=\"#\">Unsubscribes</a></h3><pre>".print_r($api->getUnsubscribes($this->campaign->CampaignID), 1)."</pre>";
                Requirements::customScript($this->JSHackForPreSections(), "CampaignMonitorStats");
                $html .= "</div>";
                $this->Content = $html;
            }
        } else {
            return false;
        }
    }

    /**
     * action
     * @param HTTPRequest
     */
    public function resetsignup($request)
    {
        Session::clear("CampaignMonitorStartForm_AjaxResult_".$this->ID);
        return array();
    }

    /**
     * removes all campaigns
     * so that they can be re-imported.
     */
    public function resetoldcampaigns()
    {
        if (!Permission::check("CMS_ACCESS_CMSMain")) {
            Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need CMS rights to access it. Enter your credentials below and we will send you right along.'));
        } else {
            DB::query("DELETE FROM \"CampaignMonitorCampaign\";");
            DB::query("DELETE FROM \"CampaignMonitorCampaign_Pages\";");
            die("old campaigns have been deleted");

The method resetoldcampaigns() contains an exit expression.

        }
    }


    /**
     * @return String
     */
    private function JSHackForPreSections()
    {
        $js = <<<javascript
            jQuery(document).ready(
                function(){
                    jQuery('pre').hide();
                    jQuery('#CampaignMonitorStats').on(
                        'click',
                        'a',
                        function(event){
                            event.preventDefault();
                            jQuery(this).parent().next('pre').slideToggle();
                        }
                    );
                    jQuery("#MyListStatsAreHere").click();
                }
            );

javascript;
        return $js;
    }
}