VisitorModel - Code Metrics - Inspection of "Devel" - literat/srazvs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#102)

by Litera

created 2017-09-10 20:50 UTC

VisitorModel B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	542
Duplicated Lines	3.69 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
dl	20
loc	542
c	0
b	0
f	0
rs	8.3999
wmc	38
lcom	1
cbo	6

21 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	41	1
A	getColumns()	0	4	1
B	assemble()	0	56	8
B	modify()	10	36	3
B	modifyByGuid()	10	38	3
A	delete()	0	9	1
A	checked()	0	9	1
A	getCount()	0	7	1
A	setSearch()	0	6	1
A	getSearch()	0	4	1
A	buildSearchQuery()	0	17	2
A	payCharge()	0	16	2
A	getRecipients()	0	9	1
A	getVisitorPrograms()	0	8	1
B	renderProgramSwitcher()	0	23	4
A	all()	0	23	1
A	findById()	0	4	1
A	findByGuid()	0	4	1
A	getSerializedMailAddress()	0	19	2
A	getBill()	0	8	1
A	findVisitorPrograms()	0	8	1

How to fix Duplicated Code

<?php

namespace App\Models;

use Nette\Database\Context;
use Nette\Utils\Strings;
use \Exception;

/**
 * Visitor
 *
 * class for handling visitors
 *
 * @created 2012-11-07
 * @author Tomas Litera <[email protected]>
 */
class VisitorModel extends BaseModel

{

	/** @var string	search pattern */
	public $search;

	/** @var Meeting Meeting class */
	public $Meeting;

	/** @var Meal Meals class */
	public $Meals;

	/** @var Program Programs class */
	public $Programs;

	/** @var Blocks Blocks class */
	public $Blocks;

	/** @var int meeting price */
	public $meeting_price;

	/** @var int meeting advance */
	private $meeting_advance;

	/**
	 * Array of database programs table columns
	 *
	 * @var array	dbColumns[]
	 */
	public $dbColumns = array();

	/**
	 * Array of form names
	 *
	 * @var array	formNames[]
	 */
	public $formNames = array();

	protected $table = 'kk_visitors';

	protected $columns = [
		'name',
		'surname',
		'nick',
		'email',
		'birthday',
		'street',
		'city',
		'postal_code',
		'group_num',
		'group_name',
		'troop_name',
		'province',
		'arrival',
		'departure',
		'comment',
		'question',
		'question2',
		'bill',
		'cost',
		'meeting',
	];

	/** konstruktor */
	public function __construct(

		MeetingModel $Meeting,
		MealModel $Meals,
		ProgramModel $Program,
		BlockModel $Blocks,
		Context $database
	) {
		$this->Meeting = $Meeting;

		$this->meeting_price = $this->Meeting->getPrice('cost');
		$this->meeting_advance = $this->Meeting->getPrice('advance');
		$this->Meals = $Meals;

		$this->Programs = $Program;

		$this->Blocks = $Blocks;

		$this->dbColumns = array(
								"guid",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"name",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"surname",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"nick",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"birthday",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"street",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"city",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"postal_code",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"province",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"group_num",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"group_name",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"troop_name",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"bill",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"cost",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"email",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"comment",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"arrival",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"departure",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"question",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"question2",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"checked",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"meeting",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
								"hash"
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
							);
		$this->formNames = array("name", "description", "material", "tutor", "email", "capacity", "display_in_reg", "block", "category");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
		$this->database = $database;
	}

	/**
	 * @return array
	 */
	public function getColumns()
	{
		return $this->columns;
	}

	/**
	 * Create a new visitor
	 *
	 * @return	string
	 */
	public function assemble(array $DB_data, $meals_data, $programs_data, $returnGuid = false)

	{
		$return = true;

		if(!$DB_data['province']) {
			$DB_data['province'] = 0;
		}

		$DB_data['birthday'] = new \DateTime($DB_data['birthday']);
		$DB_data['reg_daytime'] = (new \DateTime())->format('Y-m-d H:i:s');
		$DB_data['guid'] = md5(uniqid());

		$ID_visitor = $this->database
			->table($this->getTable())
			->insert($DB_data)->id;

		// visitor's id is empty and i must add one
		$meals_data['visitor'] = $ID_visitor;

		if($ID_visitor){
			// gets data from database
			$program_blocks = $this->Blocks->getProgramBlocks($DB_data['meeting']);

			foreach($program_blocks as $DB_blocks_data) {
				$bindingsData = array(
					'visitor' => $ID_visitor,
					'program' => $programs_data[$DB_blocks_data['id']],
				);
				// insert into binding table
				// var programs_data contains requested values in format block-id => program-id
				$bindingsData['guid'] = md5(uniqid());
				$result_binding = $this->database->query('INSERT INTO `kk_visitor-program`', $bindingsData);

				if(!$result_binding) {
					throw new Exception('Error while binding visitor`s program');
				}
			}

			if($return) {

				// create meals for visitor
				if(!$return = $this->Meals->create($meals_data)) {
					throw new Exception('Error while creating meals');
				}
			}
		} else {
			throw new Exception('Error while creating visitor');
		}

		//return $return;
		if($returnGuid) {
			return $DB_data['guid'];
		} else {
			return $ID_visitor;
		}
	}

	/**
	 * Modify a visitor
	 *
	 * @param	int		$visitor_id		ID of a visitor
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param	array	$db_data		Visitor's database data
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param	array	$meals_data		Data of meals
	 * @param	array	$programs_data	Program's data
	 * @return	mixed					TRUE or array of errors
	 */
	public function modify($ID_visitor, $DB_data, $meals_data, $programs_data)

	{
		// for returning specific error
		$error = array('visitor' => true, 'meal' => true, 'program' => true);

		$DB_data['birthday'] = new \DateTime($DB_data['birthday']);

		$result = $this->database
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			->table($this->getTable())
			->where('id', $ID_visitor)
			->update($DB_data);

		// change meals
		$result = $this->Meals->update($ID_visitor, $meals_data);
		$error['meal'] = $result;

		// gets data from database
		$programBlocks = $this->Blocks->getProgramBlocks($DB_data['meeting']);

		// get program of visitor
		$oldPrograms = $this->getVisitorPrograms($ID_visitor);

		// update old data to new existing
		foreach($programBlocks as $programBlock) {

			$data = array('program' => $programs_data[$programBlock->id]);
			// read first value from array and shift it to the end
			$oldProgram = array_shift($oldPrograms);

			$result = $this->database
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				->table('kk_visitor-program')
				->where('visitor ? AND id ?', $ID_visitor, (empty($oldProgram)) ? $oldProgram : $oldProgram->id)
				->update($data);
		}

		return $ID_visitor;
	}

	/**
	 * Modify a visitor
	 *
	 * @param	int		$visitor_id		ID of a visitor
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param	array	$db_data		Visitor's database data
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param	array	$meals_data		Data of meals
	 * @param	array	$programs_data	Program's data
	 * @return	mixed					TRUE or array of errors
	 */
	public function modifyByGuid($guid, $DB_data, $meals_data, $programs_data)

	{
		// for returning specific error
		$error = array('visitor' => true, 'meal' => true, 'program' => true);

		$DB_data['birthday'] = new \DateTime($DB_data['birthday']);

		$result = $this->database
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			->table($this->getTable())
			->where('guid', $guid)
			->update($DB_data);

		$visitor = $this->findByGuid($guid);

		// change meals
		$result = $this->Meals->update($visitor->id, $meals_data);
		$error['meal'] = $result;

		// gets data from database
		$programBlocks = $this->Blocks->getProgramBlocks($DB_data['meeting']);

		// get program of visitor
		$oldPrograms = $this->getVisitorPrograms($visitor->id);

		// update old data to new existing
		foreach($programBlocks as $programBlock) {

			$data = array('program' => $programs_data[$programBlock->id]);
			// read first value from array and shift it to the end
			$oldProgram = array_shift($oldPrograms);

			$result = $this->getDatabase()
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				->table('kk_visitor-program')
				->where('visitor ? AND id ?', $visitor->id, (empty($oldProgram)) ? $oldProgram : $oldProgram->id)
				->update($data);
		}

		return $guid;
	}

	/**
	 * Delete one or multiple record/s
	 *
	 * @param	int		ID/s of record
	 * @return	boolean
	 */
	public function delete($id)
	{
		return $this->getDatabase()
			->table($this->getTable())
			->where('id', $id)
			->update([
				'deleted' => '1'
			]);
	}

	/**
	 * Set as checked one or multiple record/s
	 *
	 * @param	int		ID/s of record
	 * @param 	int 	0 | 1
	 * @return	boolean
	 */
	public function checked($id, $value)
	{
		$checked = ['checked' => $value];

		return $this->getDatabase()
			->table($this->getTable())
			->where('id', $id)
			->update($checked);
	}

	/**
	 * Get count of visitors
	 *
	 * @return  integer
	 */
	public function getCount()
	{
		return $this->getDatabase()
			->table($this->getTable())
			->where('meeting ? AND deleted ?', $this->getMeetingId(), '0')
			->count('id');
	}

	/**
	 * @param  string $search
	 * @return $this
	 */
	public function setSearch($search)
	{
		$this->search = $search;

		return $this;
	}

	/**
	 * @return string
	 */
	protected function getSearch()
	{
		return $this->search;
	}

	/**
	 * @return string
	 */
	protected function buildSearchQuery()
	{
		$search = $this->getSearch();

		$query = '';
		if($search) {
			$query = "AND (`code` REGEXP '" . $search . "'
							OR `group_num` REGEXP '" . $search . "'
							OR `name` REGEXP '" . $search . "'
							OR `surname` REGEXP '" . $search . "'
							OR `nick` REGEXP '" . $search . "'
							OR `city` REGEXP '" . $search . "'
							OR `group_name` REGEXP '" . $search . "')";
		}

		return $query;
	}

	/**
	 * Modify the visitor's bill
	 *
	 * @param	int	ID/s of visitor
	 * @param	string	type of payment (pay | advance)
	 * @return	string	error message or true
	 */
	public function payCharge($query_id, $type)

	{
		$billData = $this->getBill($query_id);

		if($billData['bill'] < $this->Meeting->getPrice('cost')) {
			$bill = array('bill' => $this->Meeting->getPrice($type));
			$payResult = $this->getDatabase()
				->table($this->getTable())
				->where('id', $query_id)
				->update($bill);

			return $payResult;
		} else {
			throw new Exception('Charge already paid!');
		}
	}

	/**
	 * Get recipients by ids
	 *
	 * @param	mixed	ID of visitor
	 * @return	mixed	result
	 */
	public function getRecipients($ids)
	{
		return $this->getDatabase()
			->table($this->getTable())
			->select('email', 'name', 'surname')
			->where('id', $ids)
			->where('deleted', '0')
			->fetchAll();
	}

	/**
	 * Get visitor's programs
	 *
	 * @param	int		ID of visitor
	 * @return	mixed	result
	 */
	public function getVisitorPrograms($visitorId)
	{
		return $this->getDatabase()
			->table('kk_visitor-program')
			->select('id, program')
			->where('visitor', $visitorId)
			->fetchAll();
	}

	/**
	 * Render program switcher for unique visitor
	 *
	 * @param	int		ID of meeting
	 * @param	int		ID of visitor
	 * @return	string	html
	 */
	public function renderProgramSwitcher($meetingId, $visitorId)
	{
		$html = "";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

		// gets data from database
		$programBlocks = $this->Blocks->getProgramBlocks($meetingId);

		// table is empty
		if(!$programBlocks){
			$html .= "<div class='emptyTable' style='width:400px;'>Nejsou žádná aktuální data.</div>\n";
		} else {
			foreach($programBlocks as $block) {
				$html .= "<div class='block-" . $block->id .  " ".Strings::webalize($block['day'])."'>".$block['day'].", ".$block['from']." - ".$block['to']." : ".$block['name']."</div>\n";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
				// rendering programs in block
				if($block['program'] == 1) {
					$html .= "<div class='block-" . $block->id .  " programs ".Strings::webalize($block['day'])." ".Strings::webalize($block['name'])."'>".$this->Programs->getPrograms($block['id'], $visitorId)."</div>";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
				}
				$html .= "<br />";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
			}
		}

		return $html;
	}

	/**
	 * @return Row
	 */
	public function all()
	{
		return $this->getDatabase()->query('SELECT 	vis.id AS id,
								vis.guid AS guid,
								code,
								name,
								surname,
								nick,
								email,
								group_name,
								group_num,
								city,
								province_name AS province,
								bill,
								cost,
								birthday,
								checked
						FROM kk_visitors AS vis
						LEFT JOIN kk_provinces AS provs ON vis.province = provs.id
						WHERE meeting = ? AND vis.deleted = ? ' . $this->buildSearchQuery() . '
						ORDER BY vis.id ASC',
						$this->getMeetingId(), '0')->fetchAll();
	}

	/**
	 * Return visitor by id
	 *
	 * @param  int    $id
	 * @return ActiveRow
	 */
	public function findById($id)
	{
		return $this->find($id);
	}

	/**
	 * Return visitor by guid
	 *
	 * @param  string  $guid
	 * @return ActiveRow
	 */
	public function findByGuid($guid)
	{
		return $this->findBy('guid', $guid);
	}

	/**
	 * @param  array  $queryId
	 * @return string
	 */
	public function getSerializedMailAddress(array $queryId = [])
	{
		$recipientMailAddresses = '';

		$emails = $this->getDatabase()
			->table($this->getTable())
			->select('email')
			->where('id', $queryId)
			->group('email')
			->fetchAll();

		foreach($emails as $item){
			$recipientMailAddresses .= $item['email'] . ",\n";
		}

		$recipientMailAddresses = rtrim($recipientMailAddresses, "\n,");

		return $recipientMailAddresses;
	}

	/**
	 * @param  int  $id
	 * @return Visitor
	 */
	public function getBill($id)
	{
		return $this->getDatabase()
			->table($this->getTable())
			->select('bill')
			->where('id', $id)
			->fetch();
	}

	/**
	 * @param	int		ID of visitor
	 * @return	mixed	result
	 */
	public function findVisitorPrograms(int $visitorId)
	{
		return $this->getDatabase()
			->table('kk_visitor-program')
			->select('id, program')
			->where('visitor', $visitorId)
			->fetchAll();
	}

}


1			<?php
2
3			namespace App\Models;
4
5			use Nette\Database\Context;
6			use Nette\Utils\Strings;
7			use \Exception;
8
9			/**
10			* Visitor
11			*
12			* class for handling visitors
13			*
14			* @created 2012-11-07
15			* @author Tomas Litera <[email protected]>
16			*/
17			class VisitorModel extends BaseModel
			0 ignored issues – show Coding Style introduced 2017-03-07 23:06 UTC by Report Bug Copy Issue Report The property $meeting_price is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2017-03-07 23:06 UTC by Report Bug Copy Issue Report The property $meeting_advance is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
18			{
19
20			/** @var string search pattern */
21			public $search;
22
23			/** @var Meeting Meeting class */
24			public $Meeting;
25
26			/** @var Meal Meals class */
27			public $Meals;
28
29			/** @var Program Programs class */
30			public $Programs;
31
32			/** @var Blocks Blocks class */
33			public $Blocks;
34
35			/** @var int meeting price */
36			public $meeting_price;
37
38			/** @var int meeting advance */
39			private $meeting_advance;

literat / srazvs

Pull Request — master (#102)

VisitorModel B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

21 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like