Assignees::getProperties() - Code Metrics - Inspection of "Merge pull request #28 from SemanticMediaWiki/bugf..." - SemanticMediaWiki/SemanticTasks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 24c5f5...cb85bb )

by Peter

created 2019-11-25 14:15 UTC

Assignees::getProperties() B

↳ Parent: Assignees

Complexity

Conditions	6
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	44
rs	8.5937
c	0
b	0
f	0
cc	6
nc	10
nop	3

<?php

namespace ST;

use ParserOutput;
use SMW\ApplicationFactory;
use SMW\DIWikiPage;
use SMWDataItem;
use User;
use WikiPage;

/** @todo: rename TaskDiff something similar */
class Assignees {

	private $taskAssignees;
	private $taskStatus;

	/**
	 * Previously this was SemanticTasksMailer::findOldValues
	 *
	 * @param WikiPage $article
	 * @return bool
	 */
	public function saveAssignees( WikiPage &$article ) {
		$this->taskAssignees = $this->getCurrentAssignees( $article, null );
		$this->taskStatus = $this->getCurrentStatus( $article, null );
		return true;
	}

	public function getSavedStatus() {
		return $this->taskStatus;
	}

	public function getSavedAssignees() {
		return $this->taskAssignees;
	}

	/**
	 * @param WikiPage $article
	 * @param $revision
	 * @return array
	 */
	public function getCurrentAssignees( WikiPage &$article, $revision ) {
		global $stgPropertyAssignedTo;
		return $this->getProperties( $stgPropertyAssignedTo, $article, $revision );
	}

	public function getCurrentCarbonCopy( WikiPage &$article, $revision ) {
		global $stgPropertyCarbonCopy;
		return $this->getProperties( $stgPropertyCarbonCopy, $article, $revision );
	}

	/**
	 * @param WikiPage $article
	 * @param $revision
	 * @return string
	 */
	public function getCurrentStatus( WikiPage &$article, $revision ) {
		global $stgPropertyStatus;
		$status = $this->getProperties( $stgPropertyStatus, $article, $revision );
		$statusString = '';
		if ( count( $status ) > 0 ) {
			$statusString = $status[0];
		}
		return $statusString;
	}

	/**
	 * @param WikiPage $article
	 * @param $revision
	 * @return array
	 */
	public function getNewAssignees( WikiPage &$article, $revision ) {
		return array_diff( $this->getCurrentAssignees( $article, $revision ), $this->taskAssignees );
	}

	/**
	 * @param WikiPage $article
	 * @param $revision
	 * @return array
	 */
	public function getRemovedAssignees( WikiPage &$article, $revision ) {
		return array_diff( $this->taskAssignees, $this->getCurrentAssignees( $article, $revision ) );
	}

	/**
	 * Returns an array of assignees based on $query_word
	 *
	 * @param WikiPage $article
	 * @return array
	 */
	public function getGroupAssignees( WikiPage &$article ) {
		global $stgPropertyAssignedToGroup;
		global $stgPropertyHasAssignee;

		$query_word = $stgPropertyAssignedToGroup;
		$title_text = $article->getTitle()->getFullText();

		// Array of assignees to return
		$assignee_arr = array();

		// get the result of the query "[[$title]][[$query_word::+]]"
		$properties_to_display = array( $query_word );
		$results = Query::getQueryResults( "[[$title_text]][[$query_word::+]]", $properties_to_display,
			false );

		$group_assignees = null;
		// In theory, there is only one row
		while ( $row = $results->getNext() ) {
			$group_assignees = $row[0];
		}

		// If not any row, do nothing
		if ( !empty( $group_assignees ) ) {
			while ( $group_assignee = $group_assignees->getNextObject() ) {
				$group_assignee = $group_assignee->getTitle();
				$group_name = $group_assignee->getText();
				$query_word = $stgPropertyHasAssignee;
				$properties_to_display = array( $query_word );
				$results = Query::getQueryResults( "[[$group_name]][[$query_word::+]]", $properties_to_display,
					false );

				$task_assignees = null;
				// In theory, there is only one row
				while ( $row = $results->getNext() ) {
					$task_assignees = $row[0];
				}

				if ( !empty( $task_assignees ) ) {
					while ( $task_assignee = $task_assignees->getNextObject() ) {
						$assignee_name = $task_assignee->getTitle();
						$assignee_name = $assignee_name->getText();
						/** @todo Create User object */
						$assignee_name = explode( ":", $assignee_name );
						$assignee_name = $assignee_name[0];

						array_push( $assignee_arr, $assignee_name );
					}
				}
			}
		}

		return $assignee_arr;
	}

	/**
	 * Get the email addresses of all the assignees
	 *
	 * @param array $assignees
	 * @return array
	 */
	static public function getAssigneeAddresses( array $assignees ) {
		$assignee_arr = array();
		foreach ( $assignees as $assignee_name ) {
			$assignee = User::newFromName( $assignee_name );
			// if assignee is the current user, do nothing
			# if ( $assignee->getID() != $user->getID() ) {
			if (!$assignee) {
				continue;
			}
			$assignee_mail = new \MailAddress( $assignee->getEmail(), $assignee_name );
			array_push( $assignee_arr, $assignee_mail );
			# }
		}

		return $assignee_arr;
	}

	/**
	 * Returns an array of properties based on $query_word
	 *
	 * @param string $propertyString The property that designate the users to notify.
	 * @param WikiPage $article
	 * @param $revision
	 * @return array
	 */
	private function getProperties( $propertyString, $article, $revision ) {
		$smwFactory = ApplicationFactory::getInstance();
		$mwCollaboratorFactory = $smwFactory->newMwCollaboratorFactory();
		if ($revision === null) {
			$revision = $article->getRevision();
		}
		if ($revision === null) {
			return [];
		}
		if ( version_compare( SMW_VERSION, '3.1', '<' ) ) {
			$editInfo = $mwCollaboratorFactory->newEditInfoProvider(
				$article,
				$revision,
				null
			);
		} else {
			$editInfo = $mwCollaboratorFactory->newEditInfo(
				$article,
				$revision,
				null
			);
		}
		$editInfo->fetchEditInfo();
		$parserOutput = $editInfo->getOutput();

		if ( !$parserOutput instanceof ParserOutput ) {

			return [];
		}

		$propertyStringUnderscores = str_replace( ' ', '_', $propertyString );
		$property = new \SMW\DIProperty( $propertyStringUnderscores, false );

		/** @var $semanticData \SMW\SemanticData */
		$semanticData = $parserOutput->getExtensionData( 'smwdata' );
		$propValues = $semanticData->getPropertyValues( $property );
		$valueList = array_map(function( SMWDataItem $propVal ) {
			if ($propVal instanceof DIWikiPage) {
				return $propVal->getTitle()->getText();
			}
			return $propVal;
		}, $propValues);

		return $valueList;
	}
}



1			<?php
2
3			namespace ST;
4
5			use ParserOutput;
6			use SMW\ApplicationFactory;
7			use SMW\DIWikiPage;
8			use SMWDataItem;
9			use User;
10			use WikiPage;
11
12			/** @todo: rename TaskDiff something similar */
13			class Assignees {
14
15			private $taskAssignees;
16			private $taskStatus;
17
18			/**
19			* Previously this was SemanticTasksMailer::findOldValues
20			*
21			* @param WikiPage $article
22			* @return bool
23			*/
24			public function saveAssignees( WikiPage &$article ) {
25			$this->taskAssignees = $this->getCurrentAssignees( $article, null );
26			$this->taskStatus = $this->getCurrentStatus( $article, null );
27			return true;
28			}
29
30			public function getSavedStatus() {
31			return $this->taskStatus;
32			}
33
34			public function getSavedAssignees() {
35			return $this->taskAssignees;
36			}
37
38			/**
39			* @param WikiPage $article
40			* @param $revision
41			* @return array
42			*/
43			public function getCurrentAssignees( WikiPage &$article, $revision ) {
44			global $stgPropertyAssignedTo;
45			return $this->getProperties( $stgPropertyAssignedTo, $article, $revision );
46			}
47
48			public function getCurrentCarbonCopy( WikiPage &$article, $revision ) {
49			global $stgPropertyCarbonCopy;
50			return $this->getProperties( $stgPropertyCarbonCopy, $article, $revision );
51			}
52
53			/**
54			* @param WikiPage $article
55			* @param $revision
56			* @return string
57			*/
58			public function getCurrentStatus( WikiPage &$article, $revision ) {
59			global $stgPropertyStatus;
60			$status = $this->getProperties( $stgPropertyStatus, $article, $revision );
61			$statusString = '';
62			if ( count( $status ) > 0 ) {
63			$statusString = $status[0];
64			}
65			return $statusString;
66			}
67
68			/**
69			* @param WikiPage $article
70			* @param $revision
71			* @return array
72			*/
73			public function getNewAssignees( WikiPage &$article, $revision ) {
74			return array_diff( $this->getCurrentAssignees( $article, $revision ), $this->taskAssignees );
75			}
76
77			/**
78			* @param WikiPage $article
79			* @param $revision
80			* @return array
81			*/
82			public function getRemovedAssignees( WikiPage &$article, $revision ) {
83			return array_diff( $this->taskAssignees, $this->getCurrentAssignees( $article, $revision ) );
84			}
85
86			/**
87			* Returns an array of assignees based on $query_word
88			*
89			* @param WikiPage $article
90			* @return array
91			*/
92			public function getGroupAssignees( WikiPage &$article ) {
93			global $stgPropertyAssignedToGroup;
94			global $stgPropertyHasAssignee;
95
96			$query_word = $stgPropertyAssignedToGroup;
97			$title_text = $article->getTitle()->getFullText();
98
99			// Array of assignees to return
100			$assignee_arr = array();
101
102			// get the result of the query "[[$title]][[$query_word::+]]"
103			$properties_to_display = array( $query_word );
104			$results = Query::getQueryResults( "[[$title_text]][[$query_word::+]]", $properties_to_display,
105			false );
106
107			$group_assignees = null;
108			// In theory, there is only one row
109			while ( $row = $results->getNext() ) {
110			$group_assignees = $row[0];
111			}
112
113			// If not any row, do nothing
114			if ( !empty( $group_assignees ) ) {
115			while ( $group_assignee = $group_assignees->getNextObject() ) {
116			$group_assignee = $group_assignee->getTitle();
117			$group_name = $group_assignee->getText();
118			$query_word = $stgPropertyHasAssignee;
119			$properties_to_display = array( $query_word );
120			$results = Query::getQueryResults( "[[$group_name]][[$query_word::+]]", $properties_to_display,
121			false );
122
123			$task_assignees = null;
124			// In theory, there is only one row
125			while ( $row = $results->getNext() ) {
126			$task_assignees = $row[0];
127			}
128
129			if ( !empty( $task_assignees ) ) {
130			while ( $task_assignee = $task_assignees->getNextObject() ) {
131			$assignee_name = $task_assignee->getTitle();
132			$assignee_name = $assignee_name->getText();
133			/** @todo Create User object */
134			$assignee_name = explode( ":", $assignee_name );
135			$assignee_name = $assignee_name[0];
136
137			array_push( $assignee_arr, $assignee_name );
138			}
139			}
140			}
141			}
142
143			return $assignee_arr;
144			}
145
146			/**
147			* Get the email addresses of all the assignees
148			*
149			* @param array $assignees
150			* @return array
151			*/
152			static public function getAssigneeAddresses( array $assignees ) {
153			$assignee_arr = array();
154			foreach ( $assignees as $assignee_name ) {
155			$assignee = User::newFromName( $assignee_name );
156			// if assignee is the current user, do nothing
157			# if ( $assignee->getID() != $user->getID() ) {
158			if (!$assignee) {
159			continue;
160			}
161			$assignee_mail = new \MailAddress( $assignee->getEmail(), $assignee_name );
162			array_push( $assignee_arr, $assignee_mail );
163			# }
164			}
165
166			return $assignee_arr;
167			}
168
169			/**
170			* Returns an array of properties based on $query_word
171			*
172			* @param string $propertyString The property that designate the users to notify.
173			* @param WikiPage $article
174			* @param $revision
175			* @return array
176			*/
177			private function getProperties( $propertyString, $article, $revision ) {
178			$smwFactory = ApplicationFactory::getInstance();
179			$mwCollaboratorFactory = $smwFactory->newMwCollaboratorFactory();
180			if ($revision === null) {
181			$revision = $article->getRevision();
182			}
183			if ($revision === null) {
184			return [];
185			}
186			if ( version_compare( SMW_VERSION, '3.1', '<' ) ) {
187			$editInfo = $mwCollaboratorFactory->newEditInfoProvider(
188			$article,
189			$revision,
190			null
191			);
192			} else {
193			$editInfo = $mwCollaboratorFactory->newEditInfo(
194			$article,
195			$revision,
196			null
197			);
198			}
199			$editInfo->fetchEditInfo();
200			$parserOutput = $editInfo->getOutput();
201
202			if ( !$parserOutput instanceof ParserOutput ) {
			0 ignored issues – show Bug introduced 2019-11-21 16:05 UTC by Report Bug Copy Issue Report The class `ParserOutput` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
203			return [];
204			}
205
206			$propertyStringUnderscores = str_replace( ' ', '_', $propertyString );
207			$property = new \SMW\DIProperty( $propertyStringUnderscores, false );
208
209			/** @var $semanticData \SMW\SemanticData */
210			$semanticData = $parserOutput->getExtensionData( 'smwdata' );
211			$propValues = $semanticData->getPropertyValues( $property );
212			$valueList = array_map(function( SMWDataItem $propVal ) {
213			if ($propVal instanceof DIWikiPage) {
214			return $propVal->getTitle()->getText();
215			}
216			return $propVal;
217			}, $propValues);
218
219			return $valueList;
220			}
221			}
222
223

SemanticMediaWiki / SemanticTasks

Push — master ( 24c5f5...cb85bb )

Assignees::getProperties() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like