ChimpifyRequestHandler::handleMailChimpResponse() - Code Metrics - SomarDesignStudios/silverstripe-chimpify - Measure and Improve Code Quality continuously with Scrutinizer

ChimpifyRequestHandler::handleMailChimpResponse() A
last analyzed 2017-07-21 04:51 UTC

↳ Parent: ChimpifyRequestHandler

Complexity

Conditions	4
Paths	5

Size

Total Lines	14
Code Lines	8

Duplication

Lines	7
Ratio	50 %

Code Coverage

Tests	8
CRAP Score	4.0218

Importance

Changes

Metric	Value
dl	7
loc	14
ccs	8
cts	9
cp	0.8889
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	5
nop	1
crap	4.0218

<?php

use \DrewM\MailChimp\MailChimp;

class ChimpifyAdmin extends ModelAdmin
namespace YourVendor;

class YourClass { }
{
    private static $managed_models = [

        'ChimpifyCampaign',
    ];

    private static $url_segment = 'mailchimp-campaigns';


    private static $menu_title = 'MailChimp Campaigns';


    public function getEditForm($id = null, $fields = null)
    {
        $form = parent::getEditForm($id, $fields);

        $gridFieldName = $this->sanitiseClassName($this->modelClass);
        $gridFieldConfig = $form->Fields()->fieldByName($gridFieldName)->getConfig();

        $gridFieldConfig->removeComponentsByType('GridFieldPrintButton');
        $gridFieldConfig->removeComponentsByType('GridFieldExportButton');
        $gridFieldConfig
            ->getComponentByType('GridFieldAddNewButton')
            ->setButtonName(
                _t('Chimpify.ButtonLabelAddMailChimpCampaign', 'Add MailChimp Campaign')
            );
        $gridFieldConfig
            ->getComponentByType('GridFieldDetailForm')
            ->setItemRequestClass('ChimpifyRequestHandler');

        return $form;
    }
}

class ChimpifyRequestHandler extends GridFieldDetailForm_ItemRequest
namespace YourVendor;

class YourClass { }
{
    private static $allowed_actions = [

        'edit',
        'view',
        'ItemEditForm'
    ];

    public function ItemEditForm()
    {
        $form = parent::ItemEditForm();

        if (!$this->record->ID) {
            return $form;
        }

        $formActions = $form->Actions();

        if ($actions = $this->record->getCMSActions()) {
            foreach ($actions as $action) {
                $formActions->push($action);
            }
        }

        return $form;
    }

    /**
     * Handles responses from the MailChimp API.
     *
     * @param MailChimp $mailChimp
     * @return Array
     */
    public function handleMailChimpResponse($mailChimp)
    {
        $response = $mailChimp->getLastResponse();

        if (!$mailChimp->success()) {

            $message = $response && array_key_exists($response['errors'])

                ? $response['errors'][0]['message']
                : 'Error connecting to MailChimp API';

            user_error($message, E_USER_ERROR);
        }

        return Convert::json2array($response['body']);
    }

    /**
     * Creates a MailChimp campaign via the API.
     *
     * @param MailChimp $mailChimp
     * @return Array
     */
    public function createCampaign($mailChimp)
    {
        $mailChimp->post('campaigns', [
          'type' => 'regular',
          'settings' => [
            'subject_line' => $this->record->Title,
            'from_name' => $this->record->FromName,
            'reply_to' => $this->record->ReplyTo,
          ],
        ]);

        return $this->handleMailChimpResponse($mailChimp);
    }

    /**
     * Populates a MailChimp Campaign with Blog content via the API.
     *
     * @param MailChimp $mailChimp
     * @param Int $campaignID
     * @return Array
     */
    public function populateCampaignContent($mailChimp, $campaignID)
    {
        $mailChimp->put("campaigns/{$campaignID}/content", [
            'template' => [
                'id' => $this->record->TemplateID,
                'sections' => [
                    'chimpify' => $this->record->getCampaignContent(),
                ],
            ],
        ]);

        return $this->handleMailChimpResponse($mailChimp);
    }

    /**
     * Creates and populates a MailChimp Campaign with blog content via the API.
     *
     * @param Array $data
     * @param Form $form
     */
    public function doGenerateCampaign($data, $form)

    {
        if (!$api_key = $this->record->config()->get('api_key')) {
            user_error(
                'Add a MailChimp API key to config (ChimpifyCampaign::api_key)',
                E_USER_ERROR
            );
        }

        $controller = $this->getToplevelController();

        if (!$this->record || !$this->record->canEdit()) {
            return $controller->httpError(403);
        }

        $form->validate();

        $mailChimp = new MailChimp($api_key);

        $response = $this->createCampaign($mailChimp);
        $response = $this->populateCampaignContent($mailChimp, $response['id']);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $form->sessionMessage(
            _t(
                'Chimpify.MessageGenerateCampaignSuccess',
                'Successfully created MailChimp Campaign'
            ),
            'good'
        );

        return $controller->redirectBack();
    }
}


1			<?php
2
3			use \DrewM\MailChimp\MailChimp;
4
5			class ChimpifyAdmin extends ModelAdmin
			0 ignored issues – show Coding Style Compatibility introduced 2016-07-22 23:58 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...
6			{
7			private static $managed_models = [
			0 ignored issues – show Comprehensibility introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The property `$managed_models` 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...
8			'ChimpifyCampaign',
9			];
10
11			private static $url_segment = 'mailchimp-campaigns';
			0 ignored issues – show Comprehensibility introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The property `$url_segment` 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...
12
13			private static $menu_title = 'MailChimp Campaigns';
			0 ignored issues – show Comprehensibility introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The property `$menu_title` 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...
14
15			public function getEditForm($id = null, $fields = null)
16			{
17			$form = parent::getEditForm($id, $fields);
18
19			$gridFieldName = $this->sanitiseClassName($this->modelClass);
20			$gridFieldConfig = $form->Fields()->fieldByName($gridFieldName)->getConfig();
21
22			$gridFieldConfig->removeComponentsByType('GridFieldPrintButton');
23			$gridFieldConfig->removeComponentsByType('GridFieldExportButton');
24			$gridFieldConfig
25			->getComponentByType('GridFieldAddNewButton')
26			->setButtonName(
27			_t('Chimpify.ButtonLabelAddMailChimpCampaign', 'Add MailChimp Campaign')
28			);
29			$gridFieldConfig
30			->getComponentByType('GridFieldDetailForm')
31			->setItemRequestClass('ChimpifyRequestHandler');
32
33			return $form;
34			}
35			}
36
37			class ChimpifyRequestHandler extends GridFieldDetailForm_ItemRequest
			0 ignored issues – show Coding Style Compatibility introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2016-07-22 23:58 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...
38			{
39			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The property `$allowed_actions` 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...
40			'edit',
41			'view',
42			'ItemEditForm'
43			];
44
45			public function ItemEditForm()
46			{
47			$form = parent::ItemEditForm();
48
49			if (!$this->record->ID) {
50			return $form;
51			}
52
53			$formActions = $form->Actions();
54
55			if ($actions = $this->record->getCMSActions()) {
56			foreach ($actions as $action) {
57			$formActions->push($action);
58			}
59			}
60
61			return $form;
62			}
63
64			/**
65			* Handles responses from the MailChimp API.
66			*
67			* @param MailChimp $mailChimp
68			* @return Array
69			*/
70	1		public function handleMailChimpResponse($mailChimp)
71			{
72	1		$response = $mailChimp->getLastResponse();
73
74	1	View Code Duplication	if (!$mailChimp->success()) {
			0 ignored issues – show Duplication introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
75	1		$message = $response && array_key_exists($response['errors'])
			0 ignored issues – show Bug Best Practice introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The expression `$response` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
76	1		? $response['errors'][0]['message']
77	1		: 'Error connecting to MailChimp API';
78
79	1		user_error($message, E_USER_ERROR);
80			}
81
82	1		return Convert::json2array($response['body']);
83			}
84
85			/**
86			* Creates a MailChimp campaign via the API.
87			*
88			* @param MailChimp $mailChimp
89			* @return Array
90			*/
91			public function createCampaign($mailChimp)
92			{
93			$mailChimp->post('campaigns', [
94			'type' => 'regular',
95			'settings' => [
96			'subject_line' => $this->record->Title,
97			'from_name' => $this->record->FromName,
98			'reply_to' => $this->record->ReplyTo,
99			],
100			]);
101
102			return $this->handleMailChimpResponse($mailChimp);
103			}
104
105			/**
106			* Populates a MailChimp Campaign with Blog content via the API.
107			*
108			* @param MailChimp $mailChimp
109			* @param Int $campaignID
110			* @return Array
111			*/
112			public function populateCampaignContent($mailChimp, $campaignID)
113			{
114			$mailChimp->put("campaigns/{$campaignID}/content", [
115			'template' => [
116			'id' => $this->record->TemplateID,
117			'sections' => [
118			'chimpify' => $this->record->getCampaignContent(),
119			],
120			],
121			]);
122
123			return $this->handleMailChimpResponse($mailChimp);
124			}
125
126			/**
127			* Creates and populates a MailChimp Campaign with blog content via the API.
128			*
129			* @param Array $data
130			* @param Form $form
131			*/
132			public function doGenerateCampaign($data, $form)
			0 ignored issues – show Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
133			{
134			if (!$api_key = $this->record->config()->get('api_key')) {
135			user_error(
136			'Add a MailChimp API key to config (ChimpifyCampaign::api_key)',
137			E_USER_ERROR
138			);
139			}
140
141			$controller = $this->getToplevelController();
142
143			if (!$this->record \|\| !$this->record->canEdit()) {
144			return $controller->httpError(403);
145			}
146
147			$form->validate();
148
149			$mailChimp = new MailChimp($api_key);
150
151			$response = $this->createCampaign($mailChimp);
152			$response = $this->populateCampaignContent($mailChimp, $response['id']);
			0 ignored issues – show Unused Code introduced 2016-07-22 23:58 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
153
154			$form->sessionMessage(
155			_t(
156			'Chimpify.MessageGenerateCampaignSuccess',
157			'Successfully created MailChimp Campaign'
158			),
159			'good'
160			);
161
162			return $controller->redirectBack();
163			}
164			}
165

SomarDesignStudios / silverstripe-chimpify

ChimpifyRequestHandler::handleMailChimpResponse() A last analyzed 2017-07-21 04:51 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ChimpifyRequestHandler::handleMailChimpResponse() A
last analyzed 2017-07-21 04:51 UTC