Outlook::getNumberFields() - Code Metrics - Inspection of "Update dependencies" - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — developer ( 6b5868...bed0f9 )

by Radosław

created 2023-10-30 17:11 UTC

Outlook::getNumberFields() B

↳ Parent: Outlook

Complexity

Conditions	7
Paths	3

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	13
dl	0
loc	19
rs	8.8333
c	0
b	0
f	0
cc	7
nc	3
nop	1

<?php
/**
 * Mail outlook message file.
 *
 * @package App
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 */

namespace App\Mail\ScannerEngine;

/**
 * Mail outlook message class.
 */
class Outlook extends Base
{
	/**
	 * Scanner engine name.
	 *
	 * @var string
	 */
	public $name = 'Outlook';

	/** {@inheritdoc} */
	public function getActions(): array
	{
		return array_filter(explode(',', \App\User::getCurrentUserModel()->getDetail('mail_scanner_actions')));
	}

	/** {@inheritdoc} */
	public function getMailCrmId()
	{
		if ($this->has('mailCrmId')) {
			return $this->get('mailCrmId');
		}
		$mailCrmId = \App\Mail\Message::findByCid($this->getCid());
		$this->set('mailCrmId', $mailCrmId);
		return $mailCrmId;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
	}

	/** {@inheritdoc} */
	public function getMailType(): int
	{
		if ($this->has('mailType')) {
			return $this->get('mailType');

		}
		$to = false;
		$from = (bool) \App\Mail\RecordFinder::findUserEmail([$this->get('from_email')]);
		if ($this->has('to_email')) {
			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('to_email'));
		} elseif ($this->has('cc_email')) {
			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('cc_email'));
		} elseif ($this->has('bcc_email')) {
			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('bcc_email'));
		}
		$key = self::MAIL_TYPE_RECEIVED;
		if ($from && $to) {
			$key = self::MAIL_TYPE_INTERNAL;
		} elseif ($from) {
			$key = self::MAIL_TYPE_SENT;
		}
		$this->set('mailType', $key);
		return $key;
	}

	/** {@inheritdoc} */
	public function getUserId(): int
	{
		return \App\User::getCurrentUserRealId();
	}

	/**
	 * Initialize with request data.
	 *
	 * @param \App\Request $request
	 *
	 * @return void
	 */
	public function initFromRequest(\App\Request $request)
	{
		$this->set('subject', $request->isEmpty('mailSubject') ? '-' : \App\TextUtils::textTruncate($request->getByType('mailSubject', 'Text'), 65535, false));
		$this->set('headers', $request->isEmpty('mailHeaders') ? '' : \App\TextUtils::textTruncate($request->getRaw('mailHeaders'), 16777215, false));
		$this->set('from_email', $request->getByType('mailFrom', 'Email'));
		$this->set('date', $request->getByType('mailDateTimeCreated', 'DateTimeInIsoFormat'));
		$this->set('message_id', $request->getByType('mailMessageId', 'MailId'));
		if (!$request->isEmpty('mailTo')) {
			$this->set('to_email', $request->getArray('mailTo', 'Email'));
		}
		if (!$request->isEmpty('mailCc', true)) {
			$this->set('cc_email', $request->getArray('mailCc', 'Email'));
		}
		if (!$request->isEmpty('mailBcc', true)) {
			$this->set('bcc_email', $request->getArray('mailBcc', 'Email'));
		}
		if (!$request->isEmpty('mailBody', true)) {
			$this->set('body', $request->getForHtml('mailBody'));
		}
	}

	/** {@inheritdoc} */
	public function findRelatedRecords(bool $onlyId = false): array
	{
		$ids = $this->findRelatedRecordsByEmail();
		if ($idsBySubject = $this->findRelatedRecordsBySubject()) {
			$ids[] = current($idsBySubject);
		}
		if (!$onlyId) {
			foreach ($ids as &$id) {
				$id = [
					'id' => $id,
					'module' => \App\Record::getType($id),
					'label' => \App\Record::getLabel($id),
				];
			}
		}
		return $ids;
	}

	/** {@inheritdoc} */
	public function findRelatedRecordsByEmail(): array
	{
		if (isset($this->processData['findByEmail'])) {
			return $this->processData['findByEmail'];
		}
		$emails = $this->get('to_email');
		$emails[] = $this->get('from_email');
		if ($this->has('cc_email')) {
			$emails = array_merge($emails, $this->get('cc_email'));
		}
		if ($this->has('bcc_email')) {
			$emails = array_merge($emails, $this->get('bcc_email'));
		}
		return $this->processData['findByEmail'] = \App\Utils::flatten(\App\Mail\RecordFinder::findByEmail($emails, $this->getEmailsFields()));
	}

	/** {@inheritdoc} */
	public function findRelatedRecordsBySubject(): array
	{
		if (isset($this->processData['findBySubject'])) {
			return $this->processData['findBySubject'];
		}
		return $this->processData['findBySubject'] = \App\Mail\RecordFinder::findBySubject($this->get('subject'), $this->getNumberFields());
	}

	/** {@inheritdoc} */
	public function getEmailsFields(?string $searchModuleName = null): array
	{
		$cacheKey = $searchModuleName ?? '-';
		if (isset($this->emailsFieldsCache[$cacheKey])) {
			return $this->emailsFieldsCache[$cacheKey];

		}
		$user = \App\User::getCurrentUserModel();
		$fields = [];
		if ($mailScannerFields = $user->getDetail('mail_scanner_fields')) {
			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
				$field = explode('|', $field);
				if (($searchModuleName && $searchModuleName !== $field[1]) || !\in_array($field[3], [13, 319])) {
					continue;
				}
				$fields[$field[1]][$field[3]][] = $field[2];
			}
		}
		$this->emailsFieldsCache[$cacheKey] = $fields;
		return $fields;
	}

	/** {@inheritdoc} */
	public function getNumberFields(?string $searchModuleName = null): array
	{
		$cacheKey = $searchModuleName ?? '-';
		if (isset($this->numberFieldsCache[$cacheKey])) {
			return $this->numberFieldsCache[$cacheKey];

		}
		$user = \App\User::getCurrentUserModel();
		$fields = [];
		if ($mailScannerFields = $user->getDetail('mail_scanner_fields')) {
			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
				$field = explode('|', $field);
				if (($searchModuleName && $searchModuleName !== $field[1]) || 4 !== (int) $field[3]) {
					continue;
				}
				$fields[$field[1]][$field[3]][] = $field[2];
			}
		}
		$this->numberFieldsCache[$cacheKey] = $fields;
		return $fields;
	}

	/** {@inheritdoc} */
	public function getExceptions(): array
	{
		return [];
	}
}


1			<?php
2			/**
3			* Mail outlook message file.
4			*
5			* @package App
6			*
7			* @copyright YetiForce S.A.
8			* @license YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
9			* @author Mariusz Krzaczkowski <[email protected]>
10			*/
11
12			namespace App\Mail\ScannerEngine;
13
14			/**
15			* Mail outlook message class.
16			*/
17			class Outlook extends Base
18			{
19			/**
20			* Scanner engine name.
21			*
22			* @var string
23			*/
24			public $name = 'Outlook';
25
26			/** {@inheritdoc} */
27			public function getActions(): array
28			{
29			return array_filter(explode(',', \App\User::getCurrentUserModel()->getDetail('mail_scanner_actions')));
30			}
31
32			/** {@inheritdoc} */
33			public function getMailCrmId()
34			{
35			if ($this->has('mailCrmId')) {
36			return $this->get('mailCrmId');
37			}
38			$mailCrmId = \App\Mail\Message::findByCid($this->getCid());
39			$this->set('mailCrmId', $mailCrmId);
40			return $mailCrmId;
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `return $mailCrmId` returns the type `boolean\|integer` which is incompatible with the return type mandated by `App\Mail\ScannerEngine\Base::getMailCrmId()` of `array`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
41			}
42
43			/** {@inheritdoc} */
44			public function getMailType(): int
45			{
46			if ($this->has('mailType')) {
47			return $this->get('mailType');
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `return $this->get('mailType')` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
48			}
49			$to = false;
50			$from = (bool) \App\Mail\RecordFinder::findUserEmail([$this->get('from_email')]);
51			if ($this->has('to_email')) {
52			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('to_email'));
53			} elseif ($this->has('cc_email')) {
54			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('cc_email'));
55			} elseif ($this->has('bcc_email')) {
56			$to = (bool) \App\Mail\RecordFinder::findUserEmail($this->get('bcc_email'));
57			}
58			$key = self::MAIL_TYPE_RECEIVED;
59			if ($from && $to) {
60			$key = self::MAIL_TYPE_INTERNAL;
61			} elseif ($from) {
62			$key = self::MAIL_TYPE_SENT;
63			}
64			$this->set('mailType', $key);
65			return $key;
66			}
67
68			/** {@inheritdoc} */
69			public function getUserId(): int
70			{
71			return \App\User::getCurrentUserRealId();
72			}
73
74			/**
75			* Initialize with request data.
76			*
77			* @param \App\Request $request
78			*
79			* @return void
80			*/
81			public function initFromRequest(\App\Request $request)
82			{
83			$this->set('subject', $request->isEmpty('mailSubject') ? '-' : \App\TextUtils::textTruncate($request->getByType('mailSubject', 'Text'), 65535, false));
84			$this->set('headers', $request->isEmpty('mailHeaders') ? '' : \App\TextUtils::textTruncate($request->getRaw('mailHeaders'), 16777215, false));
85			$this->set('from_email', $request->getByType('mailFrom', 'Email'));
86			$this->set('date', $request->getByType('mailDateTimeCreated', 'DateTimeInIsoFormat'));
87			$this->set('message_id', $request->getByType('mailMessageId', 'MailId'));
88			if (!$request->isEmpty('mailTo')) {
89			$this->set('to_email', $request->getArray('mailTo', 'Email'));
90			}
91			if (!$request->isEmpty('mailCc', true)) {
92			$this->set('cc_email', $request->getArray('mailCc', 'Email'));
93			}
94			if (!$request->isEmpty('mailBcc', true)) {
95			$this->set('bcc_email', $request->getArray('mailBcc', 'Email'));
96			}
97			if (!$request->isEmpty('mailBody', true)) {
98			$this->set('body', $request->getForHtml('mailBody'));
99			}
100			}
101
102			/** {@inheritdoc} */
103			public function findRelatedRecords(bool $onlyId = false): array
104			{
105			$ids = $this->findRelatedRecordsByEmail();
106			if ($idsBySubject = $this->findRelatedRecordsBySubject()) {
107			$ids[] = current($idsBySubject);
108			}
109			if (!$onlyId) {
110			foreach ($ids as &$id) {
111			$id = [
112			'id' => $id,
113			'module' => \App\Record::getType($id),
114			'label' => \App\Record::getLabel($id),
115			];
116			}
117			}
118			return $ids;
119			}
120
121			/** {@inheritdoc} */
122			public function findRelatedRecordsByEmail(): array
123			{
124			if (isset($this->processData['findByEmail'])) {
125			return $this->processData['findByEmail'];
126			}
127			$emails = $this->get('to_email');
128			$emails[] = $this->get('from_email');
129			if ($this->has('cc_email')) {
130			$emails = array_merge($emails, $this->get('cc_email'));
131			}
132			if ($this->has('bcc_email')) {
133			$emails = array_merge($emails, $this->get('bcc_email'));
134			}
135			return $this->processData['findByEmail'] = \App\Utils::flatten(\App\Mail\RecordFinder::findByEmail($emails, $this->getEmailsFields()));
136			}
137
138			/** {@inheritdoc} */
139			public function findRelatedRecordsBySubject(): array
140			{
141			if (isset($this->processData['findBySubject'])) {
142			return $this->processData['findBySubject'];
143			}
144			return $this->processData['findBySubject'] = \App\Mail\RecordFinder::findBySubject($this->get('subject'), $this->getNumberFields());
145			}
146
147			/** {@inheritdoc} */
148			public function getEmailsFields(?string $searchModuleName = null): array
149			{
150			$cacheKey = $searchModuleName ?? '-';
151			if (isset($this->emailsFieldsCache[$cacheKey])) {
152			return $this->emailsFieldsCache[$cacheKey];
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `return $this->emailsFieldsCache[$cacheKey]` returns the type `string` which is incompatible with the type-hinted return `array`. Loading history...
153			}
154			$user = \App\User::getCurrentUserModel();
155			$fields = [];
156			if ($mailScannerFields = $user->getDetail('mail_scanner_fields')) {
157			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
158			$field = explode('\|', $field);
159			if (($searchModuleName && $searchModuleName !== $field[1]) \|\| !\in_array($field[3], [13, 319])) {
160			continue;
161			}
162			$fields[$field[1]][$field[3]][] = $field[2];
163			}
164			}
165			$this->emailsFieldsCache[$cacheKey] = $fields;
166			return $fields;
167			}
168
169			/** {@inheritdoc} */
170			public function getNumberFields(?string $searchModuleName = null): array
171			{
172			$cacheKey = $searchModuleName ?? '-';
173			if (isset($this->numberFieldsCache[$cacheKey])) {
174			return $this->numberFieldsCache[$cacheKey];
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `return $this->numberFieldsCache[$cacheKey]` returns the type `string` which is incompatible with the type-hinted return `array`. Loading history...
175			}
176			$user = \App\User::getCurrentUserModel();
177			$fields = [];
178			if ($mailScannerFields = $user->getDetail('mail_scanner_fields')) {
179			foreach (explode(',', trim($mailScannerFields, ',')) as $field) {
180			$field = explode('\|', $field);
181			if (($searchModuleName && $searchModuleName !== $field[1]) \|\| 4 !== (int) $field[3]) {
182			continue;
183			}
184			$fields[$field[1]][$field[3]][] = $field[2];
185			}
186			}
187			$this->numberFieldsCache[$cacheKey] = $fields;
188			return $fields;
189			}
190
191			/** {@inheritdoc} */
192			public function getExceptions(): array
193			{
194			return [];
195			}
196			}
197

YetiForceCompany / YetiForceCRM

Push — developer ( 6b5868...bed0f9 )

Outlook::getNumberFields() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like