YF\Modules\Base\Model\Record

Complexity

Total Complexity

38

Size/Duplication

Total Lines	425
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	7

Importance

Changes

0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	setInventoryData()	0	5	1
A	getInventoryData()	0	4	1
A	getInventorySummary()	0	4	1
A	isInventory()	0	4	1
A	getInstance()	0	6	1
A	getInstanceById()	0	17	2
A	getId()	0	4	1
A	setId()	0	5	1
A	getRawData()	0	4	1
A	setRawData()	0	5	1
A	getRawValue()	0	4	1
A	setRawValue()	0	5	1
A	getModuleName()	0	4	1
A	getModuleModel()	0	4	1
A	setName()	0	4	1
A	getName()	0	4	1
A	getCustomData()	0	4	1
A	setPrivileges()	0	5	1
A	getDisplayValue()	0	4	2
A	getListDisplayValue()	0	9	2
A	setModuleName()	0	6	1
A	isViewable()	0	4	1
A	isEditable()	0	4	1
A	isDeletable()	0	4	1
A	isPermitted()	0	4	1
A	getListViewActions()	0	32	4
A	getRelatedListActions()	0	23	3
A	getDetailViewUrl()	0	4	1
A	getEditViewUrl()	0	4	1
A	getDeleteUrl()	0	4	1

<?php
/**
 * Basic record model file.
 *
 * @package Model
 *
 * @copyright YetiForce Sp. z o.o.
 * @license   YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
 * @author    Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
 */

namespace YF\Modules\Base\Model;

/**
 * Basic record model class.
 */
class Record extends \App\BaseModel
{
	/** @var string Record ID. */
	protected $id;

	/** @var string Record name. */
	protected $name = '';

	/** @var string Module name. */
	protected $moduleName;

	/** @var array Information about inventory. */
	protected $inventoryData = [];

	/** @var array Information about summary inventory. */
	protected $inventorySummaryData = [];

	/** @var string Privileges. */
	protected $privileges = [];

	/** @var array Custom data. */
	protected $customData = [];

	/** @var \YF\Modules\Base\Model\Module Module model instance. */
	protected $moduleModel;

	/**
	 * Static Function to get the instance of a clean Record for the given module name.
	 *
	 * @param string $module
	 *
	 * @return \self
	 */
	public static function getInstance(string $module): self
	{
		$handlerModule = \App\Loader::getModuleClassName($module, 'Model', 'Record');
		$instance = new $handlerModule();
		return $instance->setModuleName($module);
	}

	/**
	 * Static function to get the instance of record.
	 *
	 * @param string $moduleName
	 * @param int    $recordId
	 * @param array  $headers
	 *
	 * @return \self
	 */
	public static function getInstanceById(string $moduleName, int $recordId, array $headers = []): self
	{
		$api = \App\Api::getInstance();
		if ($headers) {

The expression $headers 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.

			$api->setCustomHeaders($headers);
		}
		$result = $api->call("{$moduleName}/Record/{$recordId}");
		$instance = self::getInstance($moduleName);
		$instance->setData($result['data'] ?? []);
		$instance->setInventoryData($result['inventory'] ?? [], $result['summaryInventory'] ?? []);
		$instance->setPrivileges($result['privileges'] ?? []);
		$instance->name = $result['name'] ?? '';
		unset($result['data'], $result['inventory'], $result['summaryInventory'], $result['privileges'], $result['name']);
		$instance->customData = $result;
		$instance->setId($recordId);
		return $instance;
	}

	/**
	 * Sets information about inventory.
	 *
	 * @param array $values
	 * @param array $summary
	 *
	 * @return void
	 */
	public function setInventoryData(array $values, array $summary = [])
	{
		$this->inventoryData = $values;
		$this->inventorySummaryData = $summary;
	}

	/**
	 * Returns information about inventory.
	 *
	 * @return void

Should the return type not be array? Also, consider making the array more specific, something like array<String>, or String[].

	 */
	public function getInventoryData()
	{
		return $this->inventoryData;
	}

	/**
	 * Returns information about summary inventory.
	 *
	 * @return void

Should the return type not be array? Also, consider making the array more specific, something like array<String>, or String[].

	 */
	public function getInventorySummary()
	{
		return $this->inventorySummaryData;
	}

	public function isInventory()
	{
		return !empty($this->inventoryData);
	}

	/**
	 * Function to get the id of the record.
	 *
	 * @return int|null

Should the return type not be string?

	 */
	public function getId(): ?int
	{
		return $this->id;
	}

	/**
	 * Function to set the id of the record.
	 *
	 * @param int $value
	 *
	 * @return self
	 */
	public function setId(int $value): self
	{
		$this->id = $value;

The property $id was declared of type string, but $value is of type integer. Maybe add a type cast?

		return $this;
	}

	/**
	 * Function to get the raw value.
	 *
	 * @return array
	 */
	public function getRawData(): array
	{
		return $this->customData['rawData'] ?? [];
	}

	/**
	 * Set raw data.
	 *
	 * @param array $rawData
	 *
	 * @return self
	 */
	public function setRawData(array $rawData): self
	{
		$this->customData['rawData'] = $rawData;
		return $this;
	}

	/**
	 * Function to get the raw value for a given key.
	 *
	 * @param string $key
	 *
	 * @return mixed
	 */
	public function getRawValue(string $key)
	{
		return $this->customData['rawData'][$key] ?? '';
	}

	/**
	 * Function to set the raw value for a given key.
	 *
	 * @param string $key
	 * @param mixed  $value
	 *
	 * @return self
	 */
	public function setRawValue(string $key, $value): self
	{
		$this->customData['rawData'][$key] = $value;
		return $this;
	}

	/**
	 * Function to get the name of the module to which the record belongs.
	 *
	 * @return string - Record Module Name
	 */
	public function getModuleName(): string
	{
		return $this->moduleName;
	}

	/**
	 * Get record module model instance.
	 *
	 * @return \YF\Modules\Base\Model\Module - Record module model instance
	 */
	public function getModuleModel(): Module
	{
		return $this->moduleModel;
	}

	/**
	 * Set record name.
	 *
	 * @param string $name
	 *
	 * @return string
	 */
	public function setName(string $name)
	{
		return $this->name = $name;
	}

	/**
	 * Record name.
	 *
	 * @return string
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * Get custom data.
	 *
	 * @return array
	 */
	public function getCustomData(): array
	{
		return $this->customData;
	}

	/**
	 * Set privileges.
	 *
	 * @param bool[] $privileges
	 *
	 * @return self
	 */
	public function setPrivileges(array $privileges): self
	{
		$this->privileges = $privileges;

It seems like $privileges of type array<integer,boolean> is incompatible with the declared type string of property $privileges.

		return $this;
	}

	/**
	 * Function to get the raw value for a given key.
	 *
	 * @param string $key
	 *
	 * @return string
	 */
	public function getDisplayValue(string $key): string
	{
		return !isset($this->getModuleModel()->getFields()[$key]) ? \App\Purifier::encodeHtml($this->get($key)) : $this->getModuleModel()->getFieldModel($key)->getDisplayValue($this->get($key), $this);
	}

	/**
	 * Get list display value.
	 *
	 * @param string $key
	 *
	 * @return string
	 */
	public function getListDisplayValue(string $key): string
	{
		$fieldModel = $this->getModuleModel()->getFieldModel($key);
		$value = '';
		if ($fieldModel->isViewable()) {
			$value = $fieldModel->getListDisplayValue($this->get($key), $this);
		}
		return $value;
	}

	/**
	 * Function to set the name of the module to which the record belongs.
	 *
	 * @param string $moduleName
	 *
	 * @return \self

Should the return type not be Record?

	 */
	public function setModuleName(string $moduleName): self
	{
		$this->moduleName = $moduleName;
		$this->moduleModel = \YF\Modules\Base\Model\Module::getInstance($moduleName);

It seems like \YF\Modules\Base\Model\Module::getInstance($moduleName) of type object<self> is incompatible with the declared type object<YF\Modules\Base\Model\Module> of property $moduleModel.

		return $this;
	}

	/**
	 * Function checks if there are permissions to preview record.
	 *
	 * @return bool
	 */
	public function isViewable()
	{
		return true;
	}

	/**
	 * Function checks if there are permissions to edit record.
	 *
	 * @return bool
	 */
	public function isEditable(): bool
	{
		return $this->privileges['isEditable'];
	}

	/**
	 * Function checks if there are permissions to delete record.
	 *
	 * @return bool
	 */
	public function isDeletable(): bool
	{
		return $this->privileges['moveToTrash'];
	}

	/**
	 * Function checks permissions to action.
	 *
	 * @param string $actionName
	 *
	 * @return bool
	 */
	public function isPermitted(string $actionName): bool
	{
		return $this->privileges[$actionName];
	}

	/**
	 * Function to get the list view actions for the record.
	 *
	 * @return string
	 */
	public function getListViewActions(): string
	{
		$recordLinks = [];
		if ($this->isViewable()) {
			$recordLinks[] = [
				'label' => 'LBL_SHOW_COMPLETE_DETAILS',
				'moduleName' => $this->getModuleName(),
				'href' => $this->getDetailViewUrl(),
				'icon' => 'fas fa-th-list',
				'class' => 'btn-sm btn-info active js-popover-tooltip',
			];
		}
		if ($this->isEditable()) {
			$recordLinks[] = [
				'label' => 'BTN_EDIT',
				'moduleName' => $this->getModuleName(),
				'href' => $this->getEditViewUrl(),
				'icon' => 'fas fa-edit',
				'class' => 'btn-sm btn-success active js-popover-tooltip',
			];
		}
		if ($this->isDeletable()) {
			$recordLinks[] = [
				'label' => 'LBL_DELETE',
				'moduleName' => $this->getModuleName(),
				'data' => ['url' => $this->getDeleteUrl()],
				'icon' => 'fas fa-trash-alt',
				'class' => 'btn-sm btn-danger active js-delete-record js-popover-tooltip',
			];
		}
		return \App\Layout\Action::getListViewActions($recordLinks);
	}

	/**
	 * Function to get the list view actions for the record.
	 *
	 * @return string
	 */
	public function getRelatedListActions(): string
	{
		$recordLinks = [];
		if ($this->isViewable()) {
			$recordLinks[] = [
				'label' => 'LBL_SHOW_COMPLETE_DETAILS',
				'moduleName' => $this->getModuleName(),
				'href' => $this->getDetailViewUrl(),
				'icon' => 'fas fa-th-list',
				'class' => 'btn-sm btn-info active js-popover-tooltip',
			];
		}
		if ($this->isEditable()) {
			$recordLinks[] = [
				'label' => 'BTN_EDIT',
				'moduleName' => $this->getModuleName(),
				'href' => $this->getEditViewUrl(),
				'icon' => 'fas fa-edit',
				'class' => 'btn-sm btn-success active js-popover-tooltip',
			];
		}
		return \App\Layout\Action::getListViewActions($recordLinks);
	}

	/**
	 * Function to get the Detail View url for the record.
	 *
	 * @return string - Record Detail View Url
	 */
	public function getDetailViewUrl()
	{
		return 'index.php?module=' . $this->getModuleName() . '&view=DetailView&record=' . $this->getId();
	}

	/**
	 * Function to get the Edit View url for the record.
	 *
	 * @return string - Record Edit View Url
	 */
	public function getEditViewUrl()
	{
		return 'index.php?module=' . $this->getModuleName() . '&view=EditView&record=' . $this->getId();
	}

	/**
	 * Function to get the delete action url for the record.
	 *
	 * @return string
	 */
	public function getDeleteUrl()
	{
		return 'index.php?module=' . $this->getModuleName() . '&action=Delete&record=' . $this->getId();
	}
}