RegistrationPresenter - Code Metrics - Inspection of "Merge pull request #125 from literat/devel" - literat/srazvs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0adf65...fea2cb )

by Litera

created 2017-10-29 22:41 UTC

RegistrationPresenter B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	494
Duplicated Lines	9.51 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	47
loc	494
rs	8.2769
wmc	41
lcom	1
cbo	12

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	23	1
A	getRegistrationFormFactory()	0	4	1
A	injectRegistrationFormFactory()	0	4	1
A	startup()	0	22	3
B	actionCreate()	24	24	2
A	actionUpdate()	23	23	2
A	renderDefault()	0	11	3
A	renderNew()	0	7	2
A	renderCheck()	0	14	1
A	renderEdit()	0	15	2
B	createComponentRegistrationForm()	0	49	4
B	useLoggedVisitor()	0	29	3
A	getMealModel()	0	4	1
A	setMealModel()	0	6	1
A	getMeetingModel()	0	4	1
A	setMeetingModel()	0	6	1
A	getVisitorModel()	0	4	1
A	setVisitorModel()	0	6	1
A	getProgramModel()	0	4	1
A	setProgramModel()	0	6	1
A	getUserService()	0	4	1
A	setUserService()	0	6	1
A	getProgramService()	0	4	1
A	setProgramService()	0	6	1
A	getEventService()	0	4	1
A	setEventService()	0	6	1
A	getSettingsModel()	0	4	1
A	setSettingsModel()	0	6	1

How to fix Duplicated Code Complexity

Duplicated Code

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

Common duplication problems, and corresponding solutions are:

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

Complex Class

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

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

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

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

<?php

namespace App\Presenters;

use DateTime;
use App\Entities\VisitorEntity;
use App\Models\MeetingModel;
use App\Models\VisitorModel;
use App\Models\ProgramModel;
use App\Models\MealModel;
use App\Services\SkautIS\UserService;
use App\Services\Emailer;
use App\Services\VisitorService;
use App\Services\ProgramService;
use Tracy\Debugger;
use App\Components\Forms\RegistrationForm;
use App\Components\Forms\Factories\IRegistrationFormFactory;
use App\Services\SkautIS\EventService;
use Skautis\Wsdl\WsdlException;
use App\Models\SettingsModel;

/**
 * Registration controller
 *
 * This file handles the registration of visitors
 *
 * @author Tomas Litera
 * @copyright 2013-06-12 <[email protected]>
 * @package srazvs
 */
class RegistrationPresenter extends VisitorPresenter
{

	/**
	 * @var VisitorModel
	 */
	private $visitorModel;

	/**
	 * @var ProgramModel
	 */
	private $programModel;

	/**
	 * @var UserService
	 */
	private $userService;

	/**
	 * @var ProgramService
	 */
	private $programService;

	/**
	 * @var SettingsModel
	 */
	protected $settingsModel;

	/**
	 * @var boolean
	 */
	private $disabled = false;

	/**
	 * @var IRegistrationFormFactory
	 */
	private $registrationFormFactory;

	/**
	 * @var EventService
	 */
	protected $skautisEventService;

	/**
	 * @param MeetingModel   $meetingModel
	 * @param UserService    $userService
	 * @param VisitorModel   $visitorModel
	 * @param MealModel      $mealModel
	 * @param ProgramModel   $programModel
	 * @param VisitorService $visitorService
	 * @param SettingsModel  $settingsModel
	 */
	public function __construct(
		MeetingModel $meetingModel,
		UserService $userService,
		VisitorModel $visitorModel,
		MealModel $mealModel,
		ProgramModel $programModel,
		Emailer $emailer,
		VisitorService $visitorService,
		ProgramService $programService,
		EventService $skautisEvent,
		SettingsModel $settingsModel
	) {
		$this->setMeetingModel($meetingModel);
		$this->setUserService($userService);
		$this->setVisitorModel($visitorModel);
		$this->setMealModel($mealModel);
		$this->setProgramModel($programModel);
		$this->setEmailer($emailer);
		$this->setVisitorService($visitorService);
		$this->setProgramService($programService);
		$this->setEventService($skautisEvent);
		$this->setSettingsModel($settingsModel);
	}

	/**
	 * @return IRegistrationFormFactory
	 */
	public function getRegistrationFormFactory(): IRegistrationFormFactory
	{
		return $this->registrationFormFactory;
	}

	/**
	 * Injector
	 *
	 * @param  IRegistrationFormFactory $factory
	 */

	protected $error = FALSE;

	protected $hash = NULL;
	private $item;
	private $mealData;
	private $user;

	private $event;

	public function injectRegistrationFormFactory(IRegistrationFormFactory $factory)
	{
		$this->registrationFormFactory = $factory;
	}

	/**
	 * @return void
	 */
	public function startup()
	{
		parent::startup();

		$this->getMeetingModel()->setMeetingId($this->getMeetingId());

		if($this->getDebugMode() || $this->getSettingsModel()->findDebugRegime()) {
			$this->getMeetingModel()->setRegistrationHandlers(1);
			$this->setMeetingId(1);
		} else {
			$this->getMeetingModel()->setRegistrationHandlers($this->getMeetingId());
		}

		//$this->user = $this->container->getService('userService');
		//$this->event = $this->container->getService('eventService');

		$template = $this->getTemplate();

		$template->page_title = "Registrace srazu VS";
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->meeting_heading = $this->getMeetingModel()->getRegHeading();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->isRegistrationOpen = $this->getMeetingModel()->isRegOpen($this->getDebugMode());
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
	}

	/**
	 * Process data from form
	 *
	 * @return void
	 */
	public function actionCreate()

	{
		try {
			$postData = $this->getHttpRequest()->getPost();
			$postData['meeting'] = $this->getMeetingId();

			$guid = $this->getVisitorService()->create($postData);
			$result = $this->sendRegistrationSummary($postData, $guid);

			$this->logInfo('Creation of registration(%s) successfull, result: %s', [
				$guid,
				json_encode($result),
			]);
			$this->flashSuccess("Registrace({$guid}) byla úspěšně založena.");
		} catch(Exception $e) {

			$this->logError('Creation of registration(%s) failed, result: %s', [
				$guid,
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				$e->getMessage(),
			]);
			$this->flashError('Creation of registration failed, result: ' . $e->getMessage());
		}

		$this->redirect('Registration:check', $guid);
	}

	/**
	 * @param  string  $guid
	 * @return void
	 */
	public function actionUpdate($guid)

	{
		try {
			$postData = $this->getHttpRequest()->getPost();

			$result = $this->getVisitorService()->update($guid, $postData);
			$result = $this->sendRegistrationSummary($postData, $guid);

			$this->logInfo('Modification of registration(%s) successfull, result: %s', [
				$guid,
				json_encode($result),
			]);
			$this->flashSuccess("Registrace({$guid}) byla úspěšně upravena.");
		} catch(Exception $e) {

			$this->logError('Modification of registration(%s) failed, result: %s', [
				$guid,
				$e->getMessage(),
			]);
			$this->flashError("Modification of registration({$guid}) failed, result: " . $e->getMessage());
		}

		$this->redirect('Registration:check', $guid);
	}

	/**
	 * Renders default template
	 */
	public function renderDefault()
	{
		$template = $this->getTemplate();
		$disabled = $this->getMeetingModel()->isRegOpen($this->getDebugMode()) ? "" : "disabled";
		$template->disabled = $disabled;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->loggedIn = $this->getUserService()->isLoggedIn();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

		if($this->getUserService()->isLoggedIn()) {
			$this['registrationForm']->setDefaults(($this->useLoggedVisitor())->toArray());
		}
	}

	/**
	 * Renders new template
	 */
	public function renderNew()
	{
		$template = $this->getTemplate();
		$disabled = $this->getMeetingModel()->isRegOpen($this->getDebugMode()) ? "" : "disabled";
		$template->disabled = $disabled;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->loggedIn = false;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
	}

	/**
	 * @param  string  $guid
	 * @return void
	 */
	public function renderCheck($guid)
	{
		$visitor = $this->getVisitorModel()->findByGuid($guid);

		$this->getMeetingModel()->setRegistrationHandlers($visitor->meeting);

		$template = $this->getTemplate();
		$template->guid = $guid;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->visitor = $visitor;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->meetingId = $visitor->meeting;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->meals = $this->getMealModel()->findByVisitorId($visitor->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->province = $this->getMeetingModel()->getProvinceNameById($visitor->province);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->programs = $this->getProgramModel()->findByVisitorId($visitor->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
	}

	/**
	 * @param  string $guid
	 * @return void
	 */
	public function renderEdit($guid)
	{
		$visitor = $this->getVisitorService()->findByGuid($guid);
		$meetingId = $visitor['meeting'];

		$this->getMeetingModel()->setRegistrationHandlers($meetingId);

		$template = $this->getTemplate();
		$template->guid = $guid;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->meetingId = $meetingId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->loggedIn = $this->getUserService()->isLoggedIn();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		$template->disabled = $this->getMeetingModel()->isRegOpen($this->getDebugMode()) ? "" : "disabled";
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

		$this['registrationForm']->setDefaults($visitor);
	}

	/**
	 * @return RegistrationFormControl
	 */
	protected function createComponentRegistrationForm(): RegistrationForm
	{
		$control = $this->registrationFormFactory->create();
		$control->setMeetingId($this->getMeetingId());
		$control->onRegistrationSave[] = function(RegistrationForm $control, $newVisitor) {
			try {
				$guid = $this->getParameter('guid');

				if($guid) {
					$guid = $this->getVisitorService()->update($guid, (array) $newVisitor);
				} else {
					$guid = $this->getVisitorService()->create((array) $newVisitor);
				}
/*
				if($this->getUserService()->isLoggedIn() && $this->getMeetingModel()->findCourseId()) {
					$this->getEventService()->insertEnroll(
						$this->getUserService()->getSkautis()->getUser()->getLoginId(),
						$this->getMeetingModel()->findCourseId(),
						// TODO: get real phone number
						'123456789'
					);
				}
*/
				$result = $this->sendRegistrationSummary((array) $newVisitor, $guid);

				$this->logInfo('Storage of visitor(%s) successfull, result: %s', [
					$guid,
					json_encode($result),
				]);
				$this->flashSuccess("Účastník({$guid}) byl úspěšně uložen.");
			} catch(WsdlException $e) {
				$this->logWarning('Storage of visitor(%s) failed, result: %s', [
					$guid,
					$e->getMessage(),
				]);
				$this->flashError("Uložení účastníka ({$guid}) selhalo. Účastník je již zaregistrován.");
			} catch(Exception $e) {

				$this->logError('Storage of visitor(%s) failed, result: %s', [
					$guid,
					$e->getMessage(),
				]);
				$this->flashError('Uložení účastníka selhalo, chyba: ' . $e->getMessage());
			}

			$this->redirect('Registration:check', $guid);
		};

		return $control;
	}

	/**
	 * @return VisitorEntity
	 */
	protected function useLoggedVisitor(): VisitorEntity
	{
		$userDetail = $this->getUserService()->getUserDetail();
		$skautisUser = $this->getUserService()->getPersonalDetail($userDetail->ID_Person);
		$membership = $this->getUserService()->getPersonUnitDetail($userDetail->ID_Person);

		if(!preg_match('/^[1-9]{1}[0-9a-zA-Z]{2}\.[0-9a-zA-Z]{1}[0-9a-zA-Z]{1}$/', $membership->RegistrationNumber)) {
			$skautisUserUnit = $this->getUserService()->getParentUnitDetail($membership->ID_Unit)[0];
		} else {
			$skautisUserUnit = $this->getUserService()->getUnitDetail($membership->ID_Unit);
		}

		$visitor = new VisitorEntity;
		$visitor->name = $skautisUser->FirstName;
		$visitor->surname = $skautisUser->LastName;
		$visitor->nick = $skautisUser->NickName;
		$visitor->email = $skautisUser->Email;
		$visitor->street = $skautisUser->Street;
		$visitor->city = $skautisUser->City;
		$visitor->postal_code = preg_replace('/\s+/', '', $skautisUser->Postcode);
		$visitor->birthday = (new DateTime($skautisUser->Birthday))->format('d. m. Y');
		$visitor->group_name = $skautisUserUnit->DisplayName;
		$visitor->group_num = $skautisUserUnit->RegistrationNumber;
		if(isset($membership->Unit)) {
			$visitor->troop_name = $membership->Unit;
		}

		return $visitor;
	}

	/**
	 * @return MealModel
	 */
	protected function getMealModel()
	{
		return $this->mealModel;
	}

	/**
	 * @param  MealModel $model
	 * @return $this
	 */
	protected function setMealModel(MealModel $model)
	{
		$this->mealModel = $model;

		return $this;
	}

	/**
	 * @return MeetingModel
	 */
	protected function getMeetingModel()
	{
		return $this->meetingModel;
	}

	/**
	 * @param  MeetingModel $model
	 * @return $this
	 */
	protected function setMeetingModel(MeetingModel $model)
	{
		$this->meetingModel = $model;

		return $this;
	}

	/**
	 * @return VisitorModel
	 */
	protected function getVisitorModel()
	{
		return $this->visitorModel;
	}

	/**
	 * @param  VisitorModel $model
	 * @return $this
	 */
	protected function setVisitorModel(VisitorModel $model)
	{
		$this->visitorModel = $model;

		return $this;
	}

	/**
	 * @return ProgramModel
	 */
	protected function getProgramModel()
	{
		return $this->programModel;
	}

	/**
	 * @param  ProgramModel $model
	 * @return $this
	 */
	protected function setProgramModel(ProgramModel $model)
	{
		$this->programModel = $model;

		return $this;
	}

	/**
	 * @return UserService
	 */
	protected function getUserService()
	{
		return $this->userService;
	}

	/**
	 * @param  UserService $service
	 * @return $this
	 */
	protected function setUserService(UserService $service)
	{
		$this->userService = $service;

		return $this;
	}

	/**
	 * @return ProgramService
	 */
	protected function getProgramService()
	{
		return $this->programService;
	}

	/**
	 * @param  ProgramService $service
	 * @return $this
	 */
	protected function setProgramService(ProgramService $service)
	{
		$this->programService = $service;

		return $this;
	}

	/**
	 * @return EventService
	 */
	protected function getEventService(): EventService
	{
		return $this->skautisEventService;
	}

	/**
	 * @param EventService $skautisEvent
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 *
	 * @return self
	 */
	protected function setEventService(EventService $service): self
	{
		$this->skautisEventService = $service;

		return $this;
	}


	/**
	 * @return SettingsModel
	 */
	public function getSettingsModel()
	{
		return $this->settingsModel;
	}

	/**
	 * @param SettingsModel $model
	 *
	 * @return self
	 */
	public function setSettingsModel(SettingsModel $model): self
	{
		$this->settingsModel = $model;

		return $this;
	}

}


Push — master ( 0adf65...fea2cb )

RegistrationPresenter B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

28 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

literat / srazvs

Push — master ( 0adf65...fea2cb )

RegistrationPresenter B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

28 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like