SubscriptionController::listCharges() - Code Metrics - Inspection of "Improvements to the admin ui" - ArthurGuy/BBMembershipSystem - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#218)

by Arthur

created 2017-10-28 23:41 UTC

SubscriptionController::listCharges() A

↳ Parent: SubscriptionController

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php namespace BB\Http\Controllers;

use BB\Entities\User;
use BB\Repo\SubscriptionChargeRepository;

class SubscriptionController extends Controller
{


    /**
     * @var SubscriptionChargeRepository
     */
    private $subscriptionChargeRepository;
    /**
     * @var \BB\Repo\UserRepository
     */
    private $userRepository;

    function __construct(\BB\Helpers\GoCardlessHelper $goCardless, SubscriptionChargeRepository $subscriptionChargeRepository, \BB\Repo\UserRepository $userRepository)

    {
        $this->goCardless = $goCardless;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->subscriptionChargeRepository = $subscriptionChargeRepository;
        $this->userRepository = $userRepository;

        $this->middleware('role:member', array('only' => ['create', 'destroy']));
    }

    /**
     * Setup a new pre auth
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function create($userId)
    {
        $user = User::findWithPermission($userId);
        $payment_details = array(
            'redirect_uri'      => route('account.subscription.store', $user->id),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'user'              => [
                'first_name'        =>  $user->given_name,
                'last_name'         =>  $user->family_name,
                'billing_address1'  =>  $user->address->line_1,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                'billing_address2'  =>  $user->address->line_2,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                'billing_town'      =>  $user->address->line_3,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                'billing_postcode'  =>  $user->address->postcode,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                'country_code'      => 'GB'
            ]
        );

        return \Redirect::to($this->goCardless->newPreAuthUrl($payment_details));
    }

    /**
     * Store a newly created resource in storage.
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store($userId)
    {
        $confirm_params = array(
            'resource_id'    => \Request::get('resource_id'),
            'resource_type'  => \Request::get('resource_type'),
            'resource_uri'   => \Request::get('resource_uri'),
            'signature'      => \Request::get('signature'),
        );

        // State is optional
        if (\Request::get('state')) {
            $confirm_params['state'] = \Request::get('state');
        }

        $user = User::findWithPermission($userId);

        try {
            $confirmed_resource = $this->goCardless->confirmResource($confirm_params);
        } catch (\Exception $e) {
            \Notification::error($e->getMessage());
            return \Redirect::route('account.show', $user->id);
        }

        if (strtolower($confirmed_resource->status) != 'active') {
            \Notification::error('Something went wrong, you can try again or get in contact');
            return \Redirect::route('account.show', $user->id);
        }

        $this->userRepository->recordGoCardlessVariableDetails($user->id, $confirmed_resource->id);

        //all we need for a valid member is an active dd so make sure the user account is active
        $this->userRepository->ensureMembershipActive($user->id);

        return \Redirect::route('account.show', [$user->id]);
    }


    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id
     * @return Illuminate\Http\RedirectResponse
     */
    public function destroy($userId, $id = null)
    {

        /**
         * TODO: Check for and cancel pending sub charges
         */
        $user = User::findWithPermission($userId);
        if ($user->payment_method == 'gocardless') {
            try {
                $subscription = $this->goCardless->cancelSubscription($user->subscription_id);
                if ($subscription->status == 'cancelled') {
                    $user->cancelSubscription();

                    \Notification::success('Your subscription has been cancelled');
                    return \Redirect::back();
                }
            } catch (\GoCardless_ApiException $e) {
                if ($e->getCode() == 404) {
                    $user->cancelSubscription();

                    \Notification::success('Your subscription has been cancelled');
                    return \Redirect::back();
                }
            }
        } elseif ($user->payment_method == 'gocardless-variable') {
            $status = $this->goCardless->cancelPreAuth($user->subscription_id);
            if ($status) {
                $user->subscription_id = null;
                $user->payment_method = '';
                $user->save();

                $user->setLeaving();


                $this->subscriptionChargeRepository->cancelOutstandingCharges($userId);

                \Notification::success('Your direct debit has been cancelled');
                return \Redirect::back();
            }
        }
        \Notification::error('Sorry, we were unable to cancel your subscription, please get in contact');
        return \Redirect::back();
    }


    public function listCharges()
    {
        $charges = $this->subscriptionChargeRepository->getChargesPaginated();
        return \View::make('payments.sub-charges')->with('charges', $charges);
    }

    public function updatePaymentMethod($id)
    {
        $user = User::findWithPermission($id);
        $paymentMethod = \Input::get('payment_method');

        if ($paymentMethod === 'balance' && $user->payment_method == 'gocardless-variable') {
            $user->payment_method  = 'balance';
            $user->secondary_payment_method = 'gocardless-variable';
            $user->save();
        }

        if ($paymentMethod === 'gocardless-variable' && $user->payment_method == 'balance') {
            if (empty($user->subscription_id)) {
                $user->payment_method = null;
            } else {
                $user->payment_method = 'gocardless-variable';
            }
            $user->secondary_payment_method = null;
            $user->save();
        }

        \Notification::success('Details Updated');
        return \Redirect::route('account.show', [$user->id]);
    }
}


1			<?php namespace BB\Http\Controllers;
2
3			use BB\Entities\User;
4			use BB\Repo\SubscriptionChargeRepository;
5
6			class SubscriptionController extends Controller
7			{
8
9
10			/**
11			* @var SubscriptionChargeRepository
12			*/
13			private $subscriptionChargeRepository;
14			/**
15			* @var \BB\Repo\UserRepository
16			*/
17			private $userRepository;
18
19			function __construct(\BB\Helpers\GoCardlessHelper $goCardless, SubscriptionChargeRepository $subscriptionChargeRepository, \BB\Repo\UserRepository $userRepository)
			0 ignored issues – show Best Practice introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
20			{
21			$this->goCardless = $goCardless;
			0 ignored issues – show Bug introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `goCardless` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
22			$this->subscriptionChargeRepository = $subscriptionChargeRepository;
23			$this->userRepository = $userRepository;
24
25			$this->middleware('role:member', array('only' => ['create', 'destroy']));
26			}
27
28			/**
29			* Setup a new pre auth
30			*
31			* @return \Illuminate\Http\RedirectResponse
32			*/
33			public function create($userId)
34			{
35			$user = User::findWithPermission($userId);
36			$payment_details = array(
37			'redirect_uri' => route('account.subscription.store', $user->id),
			0 ignored issues – show Documentation introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report `$user->id` is of type `integer`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38			'user' => [
39			'first_name' => $user->given_name,
40			'last_name' => $user->family_name,
41			'billing_address1' => $user->address->line_1,
			0 ignored issues – show Documentation introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `address` does not exist on `object<BB\Entities\User>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
42			'billing_address2' => $user->address->line_2,
			0 ignored issues – show Documentation introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `address` does not exist on `object<BB\Entities\User>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
43			'billing_town' => $user->address->line_3,
			0 ignored issues – show Documentation introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `address` does not exist on `object<BB\Entities\User>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
44			'billing_postcode' => $user->address->postcode,
			0 ignored issues – show Documentation introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The property `address` does not exist on `object<BB\Entities\User>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
45			'country_code' => 'GB'
46			]
47			);
48
49			return \Redirect::to($this->goCardless->newPreAuthUrl($payment_details));
50			}
51
52			/**
53			* Store a newly created resource in storage.
54			*
55			* @return \Illuminate\Http\RedirectResponse
56			*/
57			public function store($userId)
58			{
59			$confirm_params = array(
60			'resource_id' => \Request::get('resource_id'),
61			'resource_type' => \Request::get('resource_type'),
62			'resource_uri' => \Request::get('resource_uri'),
63			'signature' => \Request::get('signature'),
64			);
65
66			// State is optional
67			if (\Request::get('state')) {
68			$confirm_params['state'] = \Request::get('state');
69			}
70
71			$user = User::findWithPermission($userId);
72
73			try {
74			$confirmed_resource = $this->goCardless->confirmResource($confirm_params);
75			} catch (\Exception $e) {
76			\Notification::error($e->getMessage());
77			return \Redirect::route('account.show', $user->id);
78			}
79
80			if (strtolower($confirmed_resource->status) != 'active') {
81			\Notification::error('Something went wrong, you can try again or get in contact');
82			return \Redirect::route('account.show', $user->id);
83			}
84
85			$this->userRepository->recordGoCardlessVariableDetails($user->id, $confirmed_resource->id);
86
87			//all we need for a valid member is an active dd so make sure the user account is active
88			$this->userRepository->ensureMembershipActive($user->id);
89
90			return \Redirect::route('account.show', [$user->id]);
91			}
92
93
94			/**
95			* Remove the specified resource from storage.
96			*
97			* @param int $id
98			* @return Illuminate\Http\RedirectResponse
99			*/
100			public function destroy($userId, $id = null)
101			{
102
103			/**
104			* TODO: Check for and cancel pending sub charges
105			*/
106			$user = User::findWithPermission($userId);
107			if ($user->payment_method == 'gocardless') {
108			try {
109			$subscription = $this->goCardless->cancelSubscription($user->subscription_id);
110			if ($subscription->status == 'cancelled') {
111			$user->cancelSubscription();
			0 ignored issues – show Deprecated Code introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The method `BB\Entities\User::cancelSubscription()` has been deprecated. This method has been deprecated. Loading history...
112			\Notification::success('Your subscription has been cancelled');
113			return \Redirect::back();
114			}
115			} catch (\GoCardless_ApiException $e) {
116			if ($e->getCode() == 404) {
117			$user->cancelSubscription();
			0 ignored issues – show Deprecated Code introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The method `BB\Entities\User::cancelSubscription()` has been deprecated. This method has been deprecated. Loading history...
118			\Notification::success('Your subscription has been cancelled');
119			return \Redirect::back();
120			}
121			}
122			} elseif ($user->payment_method == 'gocardless-variable') {
123			$status = $this->goCardless->cancelPreAuth($user->subscription_id);
124			if ($status) {
125			$user->subscription_id = null;
126			$user->payment_method = '';
127			$user->save();
128
129			$user->setLeaving();
			0 ignored issues – show Deprecated Code introduced 2015-11-23 19:55 UTC by Report Bug Copy Issue Report The method `BB\Entities\User::setLeaving()` has been deprecated. This method has been deprecated. Loading history...
130
131			$this->subscriptionChargeRepository->cancelOutstandingCharges($userId);
132
133			\Notification::success('Your direct debit has been cancelled');
134			return \Redirect::back();
135			}
136			}
137			\Notification::error('Sorry, we were unable to cancel your subscription, please get in contact');
138			return \Redirect::back();
139			}
140
141
142			public function listCharges()
143			{
144			$charges = $this->subscriptionChargeRepository->getChargesPaginated();
145			return \View::make('payments.sub-charges')->with('charges', $charges);
146			}
147
148			public function updatePaymentMethod($id)
149			{
150			$user = User::findWithPermission($id);
151			$paymentMethod = \Input::get('payment_method');
152
153			if ($paymentMethod === 'balance' && $user->payment_method == 'gocardless-variable') {
154			$user->payment_method = 'balance';
155			$user->secondary_payment_method = 'gocardless-variable';
156			$user->save();
157			}
158
159			if ($paymentMethod === 'gocardless-variable' && $user->payment_method == 'balance') {
160			if (empty($user->subscription_id)) {
161			$user->payment_method = null;
162			} else {
163			$user->payment_method = 'gocardless-variable';
164			}
165			$user->secondary_payment_method = null;
166			$user->save();
167			}
168
169			\Notification::success('Details Updated');
170			return \Redirect::route('account.show', [$user->id]);
171			}
172			}
173

ArthurGuy / BBMembershipSystem

Pull Request — master (#218)

SubscriptionController::listCharges() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like