ProvidersController::actionEditProvider() - Code Metrics - enupal/socializer - Measure and Improve Code Quality continuously with Scrutinizer

ProvidersController::actionEditProvider() B
last analyzed 2024-04-01 14:56 UTC

↳ Parent: ProvidersController

Complexity

Conditions	8
Paths	10

Size

Total Lines	54
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	8
eloc	36
c	1
b	0
f	0
nc	10
nop	2
dl	0
loc	54
rs	8.0995

How to fix Long Method

<?php
/**
 * Socializer plugin for Craft CMS 3.x
 *
 * @link      https://enupal.com/
 * @copyright Copyright (c) 2019 Enupal LLC
 */


namespace enupal\socializer\controllers;

use Craft;
use craft\elements\Asset;
use craft\helpers\UrlHelper;
use craft\web\Controller as BaseController;
use enupal\socializer\elements\Provider as ProviderElement;
use enupal\socializer\Socializer;
use Hybridauth\Provider\Apple;
use Hybridauth\Provider\Telegram;
use yii\web\NotFoundHttpException;

class ProvidersController extends BaseController
{
    /**
     * Save a Provider
     *
     * @return null|\yii\web\Response
     * @throws \Exception
     * @throws \Throwable
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSaveProvider()
    {
        $this->requirePostRequest();

        $request = Craft::$app->getRequest();
        $provider = new ProviderElement;

        $providerId = $request->getBodyParam('providerId');

        if ($providerId) {
            $provider = Socializer::$app->providers->getProviderById($providerId);
        }

        $provider = Socializer::$app->providers->populateProviderFromPost($provider);

        // Save it
        if (!Socializer::$app->providers->saveProvider($provider)) {
            Craft::$app->getSession()->setError(Craft::t('enupal-socializer','Couldn’t save provider'));

            Craft::$app->getUrlManager()->setRouteParams([
                    'provider' => $provider
                ]
            );

            return null;
        }

        Craft::$app->getSession()->setNotice(Craft::t('enupal-socializer','Provider saved.'));

        return $this->redirectToPostedUrl($provider);
    }

    /**
     * Edit a Provider
     *
     * @param int|null $providerId The button's ID, if editing an existing button.
     * @param ProviderElement|null $provider   The provider send back by setRouteParams if any errors on saveProvider
     *
     * @return \yii\web\Response
     * @throws NotFoundHttpException
     * @throws \Exception
     * @throws \Throwable
     */
    public function actionEditProvider(int $providerId = null, ProviderElement $provider = null)
    {
        // Immediately create a new Provider
        if ($providerId === null) {
            $request = Craft::$app->getRequest();
            $providerType = $request->getRequiredBodyParam("providerType");
            $provider = Socializer::$app->providers->getProviderByType($providerType);
            if ($provider){
                throw new \Exception(Craft::t('enupal-socializer','Provider '.$provider->name.' already exists'));
            }
            $providerName = Socializer::$app->providers->getClassNameFromNamespace($providerType);
            $providerHandle = lcfirst($providerName);
            $provider = Socializer::$app->providers->createNewProvider($providerName, $providerHandle, $providerType);

            if ($provider->id) {
                $url = UrlHelper::cpUrl('enupal-socializer/providers/edit/'.$provider->id);
                return $this->redirect($url);
            } else {
                $errors = $provider->getErrors();
                throw new \Exception(Craft::t('enupal-socializer','Error creating the Provider'.json_encode($errors)));
            }
        } else {
            if ($providerId !== null) {

                if ($provider === null) {
                    // Get the provider
                    $provider = Socializer::$app->providers->getProviderById($providerId);

                    if (!$provider) {

                        throw new NotFoundHttpException(Craft::t('enupal-socializer','Provider not found'));
                    }
                }
            }
        }

        if (is_string($provider->fieldMapping)){

            $provider->fieldMapping = json_decode($provider->fieldMapping, true);
        }

        $variables['providerId'] = $providerId;

        $variables['provider'] = $provider;

        // Set the "Continue Editing" URL
        $variables['continueEditingUrl'] = 'enupal-socializer/providers/edit/{id}';
        $settings = Socializer::$app->settings->getSettings();
        $variables['settings'] = $settings;
        $variables['apiDocumentation'] = $this->getApiDocumentation($provider->type);
        $variables['callbackUrl'] = Socializer::$app->settings->getCallbackUrl();
        $variables['supportedUserFields'] = Socializer::$app->providers->getUserFieldsAsOptions();
        $variables['userProfileFields'] = Socializer::$app->providers->getUserProfileFieldsAsOptions();
        $variables['fieldMapping'] = $provider->fieldMapping ?? $settings->fieldMapping ?? Socializer::$app->providers->getDefaultFieldMapping();
        $userProfileFields = Socializer::$app->providers->getUserProfileFieldsAsOptions();
        $variables['userProfileFields'] = $userProfileFields;

        return $this->renderTemplate('enupal-socializer/providers/_edit', $variables);
    }

    /**
     * Delete a Provider.
     *
     * @return \yii\web\Response
     * @throws \Throwable
     * @throws \craft\errors\MissingComponentException
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionDeleteProvider()
    {
        $this->requirePostRequest();

        $request = Craft::$app->getRequest();

        $providerId = $request->getRequiredBodyParam('providerId');
        $provider = Socializer::$app->providers->getProviderById($providerId);

        // @TODO - handle errors
        Socializer::$app->providers->deleteProvider($provider);

        Craft::$app->getSession()->setNotice(Craft::t('enupal-socializer','Provider deleted.'));

        return $this->redirectToPostedUrl($provider);
    }

    /**
     * @param $providerType
     * @return mixed
     * @throws \ReflectionException
     */
    private function getApiDocumentation($providerType)
    {
        if ($providerType === Apple::class) {
            return 'https://developer.apple.com/documentation/sign_in_with_apple';
        }

        if ($providerType === Telegram::class) {
            return 'https://core.telegram.org/bots';
        }

        try {
            $reflection = new \ReflectionClass($providerType);
            $property = $reflection->getProperty('apiDocumentation');
            $property->setAccessible(true);
            $obj = new $providerType(['callback' => 'https://example.com/path/to/script.php',"keys"=>["key" => "ads", "secret"=>"test"]]);

            return $property->getValue($obj);
        } catch (\Exception $e) {
            Craft::error("Error trying to get api documentation: ".$e->getMessage() , __METHOD__);
        }

        return "No Docs available for {$providerType}";
    }
}


1			<?php
2			/**
3			* Socializer plugin for Craft CMS 3.x
4			*
5			* @link https://enupal.com/
6			* @copyright Copyright (c) 2019 Enupal LLC
7			*/
8
9
10			namespace enupal\socializer\controllers;
11
12			use Craft;
13			use craft\elements\Asset;
14			use craft\helpers\UrlHelper;
15			use craft\web\Controller as BaseController;
16			use enupal\socializer\elements\Provider as ProviderElement;
17			use enupal\socializer\Socializer;
18			use Hybridauth\Provider\Apple;
19			use Hybridauth\Provider\Telegram;
20			use yii\web\NotFoundHttpException;
21
22			class ProvidersController extends BaseController
23			{
24			/**
25			* Save a Provider
26			*
27			* @return null\|\yii\web\Response
28			* @throws \Exception
29			* @throws \Throwable
30			* @throws \yii\web\BadRequestHttpException
31			*/
32			public function actionSaveProvider()
33			{
34			$this->requirePostRequest();
35
36			$request = Craft::$app->getRequest();
37			$provider = new ProviderElement;
38
39			$providerId = $request->getBodyParam('providerId');
40
41			if ($providerId) {
42			$provider = Socializer::$app->providers->getProviderById($providerId);
43			}
44
45			$provider = Socializer::$app->providers->populateProviderFromPost($provider);
46
47			// Save it
48			if (!Socializer::$app->providers->saveProvider($provider)) {
49			Craft::$app->getSession()->setError(Craft::t('enupal-socializer','Couldn’t save provider'));
50
51			Craft::$app->getUrlManager()->setRouteParams([
52			'provider' => $provider
53			]
54			);
55
56			return null;
57			}
58
59			Craft::$app->getSession()->setNotice(Craft::t('enupal-socializer','Provider saved.'));
60
61			return $this->redirectToPostedUrl($provider);
62			}
63
64			/**
65			* Edit a Provider
66			*
67			* @param int\|null $providerId The button's ID, if editing an existing button.
68			* @param ProviderElement\|null $provider The provider send back by setRouteParams if any errors on saveProvider
69			*
70			* @return \yii\web\Response
71			* @throws NotFoundHttpException
72			* @throws \Exception
73			* @throws \Throwable
74			*/
75			public function actionEditProvider(int $providerId = null, ProviderElement $provider = null)
76			{
77			// Immediately create a new Provider
78			if ($providerId === null) {
79			$request = Craft::$app->getRequest();
80			$providerType = $request->getRequiredBodyParam("providerType");
81			$provider = Socializer::$app->providers->getProviderByType($providerType);
82			if ($provider){
83			throw new \Exception(Craft::t('enupal-socializer','Provider '.$provider->name.' already exists'));
84			}
85			$providerName = Socializer::$app->providers->getClassNameFromNamespace($providerType);
86			$providerHandle = lcfirst($providerName);
87			$provider = Socializer::$app->providers->createNewProvider($providerName, $providerHandle, $providerType);
88
89			if ($provider->id) {
90			$url = UrlHelper::cpUrl('enupal-socializer/providers/edit/'.$provider->id);
91			return $this->redirect($url);
92			} else {
93			$errors = $provider->getErrors();
94			throw new \Exception(Craft::t('enupal-socializer','Error creating the Provider'.json_encode($errors)));
95			}
96			} else {
97			if ($providerId !== null) {
			0 ignored issues – show introduced 2020-05-19 07:29 UTC by Report Bug Copy Issue Report The condition `$providerId !== null` is always `true`. Loading history...
98			if ($provider === null) {
99			// Get the provider
100			$provider = Socializer::$app->providers->getProviderById($providerId);
101
102			if (!$provider) {
			0 ignored issues – show introduced 2020-05-19 07:29 UTC by Report Bug Copy Issue Report `$provider` is of type `enupal\socializer\elements\Provider`, thus it always evaluated to `true`. Loading history...
103			throw new NotFoundHttpException(Craft::t('enupal-socializer','Provider not found'));
104			}
105			}
106			}
107			}
108
109			if (is_string($provider->fieldMapping)){
			0 ignored issues – show introduced 2020-05-19 07:29 UTC by Report Bug Copy Issue Report The condition `is_string($provider->fieldMapping)` is always `true`. Loading history...
110			$provider->fieldMapping = json_decode($provider->fieldMapping, true);
111			}
112
113			$variables['providerId'] = $providerId;
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-05-19 07:29 UTC by Report Bug Copy Issue Report `$variables` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$variables = array();` before regardless. Loading history...
114			$variables['provider'] = $provider;
115
116			// Set the "Continue Editing" URL
117			$variables['continueEditingUrl'] = 'enupal-socializer/providers/edit/{id}';
118			$settings = Socializer::$app->settings->getSettings();
119			$variables['settings'] = $settings;
120			$variables['apiDocumentation'] = $this->getApiDocumentation($provider->type);
121			$variables['callbackUrl'] = Socializer::$app->settings->getCallbackUrl();
122			$variables['supportedUserFields'] = Socializer::$app->providers->getUserFieldsAsOptions();
123			$variables['userProfileFields'] = Socializer::$app->providers->getUserProfileFieldsAsOptions();
124			$variables['fieldMapping'] = $provider->fieldMapping ?? $settings->fieldMapping ?? Socializer::$app->providers->getDefaultFieldMapping();
125			$userProfileFields = Socializer::$app->providers->getUserProfileFieldsAsOptions();
126			$variables['userProfileFields'] = $userProfileFields;
127
128			return $this->renderTemplate('enupal-socializer/providers/_edit', $variables);
129			}
130
131			/**
132			* Delete a Provider.
133			*
134			* @return \yii\web\Response
135			* @throws \Throwable
136			* @throws \craft\errors\MissingComponentException
137			* @throws \yii\web\BadRequestHttpException
138			*/
139			public function actionDeleteProvider()
140			{
141			$this->requirePostRequest();
142
143			$request = Craft::$app->getRequest();
144
145			$providerId = $request->getRequiredBodyParam('providerId');
146			$provider = Socializer::$app->providers->getProviderById($providerId);
147
148			// @TODO - handle errors
149			Socializer::$app->providers->deleteProvider($provider);
150
151			Craft::$app->getSession()->setNotice(Craft::t('enupal-socializer','Provider deleted.'));
152
153			return $this->redirectToPostedUrl($provider);
154			}
155
156			/**
157			* @param $providerType
158			* @return mixed
159			* @throws \ReflectionException
160			*/
161			private function getApiDocumentation($providerType)
162			{
163			if ($providerType === Apple::class) {
164			return 'https://developer.apple.com/documentation/sign_in_with_apple';
165			}
166
167			if ($providerType === Telegram::class) {
168			return 'https://core.telegram.org/bots';
169			}
170
171			try {
172			$reflection = new \ReflectionClass($providerType);
173			$property = $reflection->getProperty('apiDocumentation');
174			$property->setAccessible(true);
175			$obj = new $providerType(['callback' => 'https://example.com/path/to/script.php',"keys"=>["key" => "ads", "secret"=>"test"]]);
176
177			return $property->getValue($obj);
178			} catch (\Exception $e) {
179			Craft::error("Error trying to get api documentation: ".$e->getMessage() , __METHOD__);
180			}
181
182			return "No Docs available for {$providerType}";
183			}
184			}
185

enupal / socializer

ProvidersController::actionEditProvider() B last analyzed 2024-04-01 14:56 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ProvidersController::actionEditProvider() B
last analyzed 2024-04-01 14:56 UTC