Codestyle fixes (#73)

bembelimen · Apr 27, 2020 · ffdb21d · ffdb21d
1 parent 5d7ef5a
commit ffdb21d
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 48 deletions.
diff --git a/administrator/components/com_content/src/Model/ArticlesModel.php b/administrator/components/com_content/src/Model/ArticlesModel.php
@@ -599,26 +599,27 @@ public function getTransitions()
 				$query = $db->getQuery(true);
 
 				$query	->select(
+					[
+						$db->quoteName('t.id', 'value'),
+						$db->quoteName('t.title', 'text'),
+						$db->quoteName('t.from_stage_id'),
+						$db->quoteName('t.to_stage_id'),
+						$db->quoteName('s.id', 'stage_id'),
+						$db->quoteName('s.title', 'stage_title'),
+						$db->quoteName('t.workflow_id'),
+					]
+				)
+					->from($db->quoteName('#__workflow_transitions', 't'))
+					->innerJoin($db->quoteName('#__workflow_stages', 's'))
+					->where(
 						[
-							$db->quoteName('t.id', 'value'),
-							$db->quoteName('t.title', 'text'),
-							$db->quoteName('t.from_stage_id'),
-							$db->quoteName('t.to_stage_id'),
-							$db->quoteName('s.id', 'stage_id'),
-							$db->quoteName('s.title', 'stage_title'),
-							$db->quoteName('t.workflow_id'),
-						])
-						->from($db->quoteName('#__workflow_transitions', 't'))
-						->innerJoin($db->quoteName('#__workflow_stages', 's'))
-						->where(
-							[
-								$db->quoteName('t.to_stage_id') . ' = ' . $db->quoteName('s.id'),
-								$db->quoteName('t.published') . ' = 1',
-								$db->quoteName('s.published') . ' = 1',
-							]
-						)
-						->order($db->quoteName('t.ordering'))
-						->group($db->quoteName('t.id'));
+							$db->quoteName('t.to_stage_id') . ' = ' . $db->quoteName('s.id'),
+							$db->quoteName('t.published') . ' = 1',
+							$db->quoteName('s.published') . ' = 1',
+						]
+					)
+					->order($db->quoteName('t.ordering'))
+					->group($db->quoteName('t.id'));
 
 				$where = [];
 

diff --git a/administrator/components/com_content/src/View/Articles/HtmlView.php b/administrator/components/com_content/src/View/Articles/HtmlView.php
@@ -170,8 +170,8 @@ protected function addToolbar()
 			if (count($this->transitions))
 			{
 				$childBar->separatorButton('transition-headline')
-						->text('COM_CONTENT_RUN_TRANSITIONS')
-						->buttonClass('text-center py-2 h3');
+					->text('COM_CONTENT_RUN_TRANSITIONS')
+					->buttonClass('text-center py-2 h3');
 
 				$cmd = "Joomla.submitbutton('articles.runTransition');";
 				$messages = "{error: [Joomla.JText._('JLIB_HTML_PLEASE_MAKE_A_SELECTION_FROM_THE_LIST')]}";
@@ -181,10 +181,10 @@ protected function addToolbar()
 				foreach ($this->transitions as $transition)
 				{
 					$childBar->standardButton('transition')
-							->text($transition['text'])
-							->buttonClass('transition-' . (int) $transition['value'])
-							->icon('fas fa-project-diagram')
-							->onclick('document.adminForm.transition_id.value=' . (int) $transition['value'] . ';' . $cmd);
+						->text($transition['text'])
+						->buttonClass('transition-' . (int) $transition['value'])
+						->icon('fas fa-project-diagram')
+						->onclick('document.adminForm.transition_id.value=' . (int) $transition['value'] . ';' . $cmd);
 				}
 
 				$childBar->separatorButton('transition-separator');

diff --git a/administrator/components/com_workflow/src/Table/StageTable.php b/administrator/components/com_workflow/src/Table/StageTable.php
@@ -179,7 +179,7 @@ public function store($updateNulls = true)
 	{
 		if (!(int) $this->ordering)
 		{
-			$this->ordering = $this->getNextOrder($this->_db->quoteName('workflow_id') . ' = ' .  (int) $this->workflow_id);
+			$this->ordering = $this->getNextOrder($this->_db->quoteName('workflow_id') . ' = ' . (int) $this->workflow_id);
 		}
 
 		$table = new StageTable($this->getDbo());

diff --git a/administrator/components/com_workflow/src/Table/TransitionTable.php b/administrator/components/com_workflow/src/Table/TransitionTable.php
@@ -65,10 +65,10 @@ public function __construct(DatabaseDriver $db)
 	 * @since   4.0.0
 	 */
 	public function store($updateNulls = true)
-	{	
+	{
 		if (!(int) $this->ordering)
 		{
-			$this->ordering = $this->getNextOrder($this->_db->quoteName('workflow_id') . ' = ' .  (int) $this->workflow_id);
+			$this->ordering = $this->getNextOrder($this->_db->quoteName('workflow_id') . ' = ' . (int) $this->workflow_id);
 		}
 
 		return parent::store($updateNulls);

diff --git a/libraries/src/MVC/Model/WorkflowBehaviorTrait.php b/libraries/src/MVC/Model/WorkflowBehaviorTrait.php
@@ -26,15 +26,27 @@
 trait WorkflowBehaviorTrait
 {
 	/**
-	 * The  for the component.
+	 * The name of the component.
 	 *
 	 * @var    string
 	 * @since  4.0.0
 	 */
 	protected $extension = null;
 
+	/**
+	 * The section of the component.
+	 *
+	 * @var    string
+	 * @since  4.0.0
+	 */
 	protected $section = '';
 
+	/**
+	 * Is workflow for this component enabled?
+	 *
+	 * @var    boolean
+	 * @since  4.0.0
+	 */
 	protected $workflowEnabled = false;
 
 	/**

diff --git a/libraries/src/Workflow/WorkflowServiceInterface.php b/libraries/src/Workflow/WorkflowServiceInterface.php
@@ -15,14 +15,15 @@
  *
  * @since  4.0.0
  */
-interface WorkflowServiceInterface {
+interface WorkflowServiceInterface
+{
 	/**
 	 * Check if the functionality is supported by the context
 	 *
-	 * @param   string  $feature  The functionality
-	 * @param   string  $context  The context of the functionality
+	 * @param   string  $functionality  The functionality
+	 * @param   string  $context        The context of the functionality
 	 *
-	 * @return bool
+	 * @return boolean
 	 *
 	 * @since  4.0.0
 	 */
@@ -33,7 +34,7 @@ public function supportFunctionality($functionality, $context): bool;
 	 *
 	 * @param   string  $context  The context of the workflow
 	 *
-	 * @return bool
+	 * @return boolean
 	 */
 	public function getModelName($context): string;
 
@@ -42,7 +43,7 @@ public function getModelName($context): string;
 	 *
 	 * @param   string  $context  The context of the workflow
 	 *
-	 * @return bool
+	 * @return boolean
 	 */
 	public function isWorkflowActive($context): bool;
 

diff --git a/libraries/src/Workflow/WorkflowServiceTrait.php b/libraries/src/Workflow/WorkflowServiceTrait.php
@@ -10,6 +10,7 @@
 
 use Joomla\CMS\Component\ComponentHelper;
 use Joomla\CMS\Factory;
+use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
 use Joomla\CMS\MVC\Model\WorkflowModelInterface;
 
 \defined('JPATH_PLATFORM') or die;
@@ -19,8 +20,16 @@
  *
  * @since  4.0.0
  */
-trait WorkflowServiceTrait {
-	abstract function getMVCFactory();
+trait WorkflowServiceTrait
+{
+	/**
+	 * Get a MVC factory
+	 *
+	 * @return  MVCFactoryInterface
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	abstract public function getMVCFactory(): MVCFactoryInterface;
 
 	/** @var array Supported functionality */
 	protected $supportedFunctionality = [
@@ -31,10 +40,10 @@ abstract function getMVCFactory();
 	/**
 	 * Check if the functionality is supported by the context
 	 *
-	 * @param   string  $feature  The functionality
-	 * @param   string  $context  The context of the functionality
+	 * @param   string  $functionality  The functionality
+	 * @param   string  $context        The context of the functionality
 	 *
-	 * @return bool
+	 * @return boolean
 	 */
 	public function supportFunctionality($functionality, $context): bool
 	{
@@ -56,7 +65,7 @@ public function supportFunctionality($functionality, $context): bool
 	 *
 	 * @param   string  $context  The context of the workflow
 	 *
-	 * @return bool
+	 * @return boolean
 	 */
 	public function getModelName($context) : string
 	{
@@ -91,7 +100,7 @@ public static function getConditions(string $extension): array
 	 *
 	 * @param   string  $context  The context of the workflow
 	 *
-	 * @return bool
+	 * @return boolean
 	 */
 	public function isWorkflowActive($context): bool
 	{

diff --git a/plugins/workflow/publishing/publishing.php b/plugins/workflow/publishing/publishing.php
@@ -87,7 +87,7 @@ public function onContentPrepareForm(Form $form, $data)
 	protected function enhanceTransitionForm(Form $form, $data)
 	{
 		$model = $this->app->bootComponent('com_workflow')
-				->getMVCFactory()->createModel('Workflow', 'Administrator', ['ignore_request' => true]);
+			->getMVCFactory()->createModel('Workflow', 'Administrator', ['ignore_request' => true]);
 
 		$workflow_id = !empty($data->workflow_id) ? (int) $data->workflow_id : (int) $form->getValue('workflow_id');
 
@@ -146,7 +146,7 @@ protected function enhanceItemForm(Form $form, $data)
 		$modelName = $component->getModelName($context);
 
 		$table = $component->getMVCFactory()->createModel($modelName, $this->app->getName(), ['ignore_request' => true])
-					->getTable();
+			->getTable();
 
 		$form->setFieldAttribute($table->getColumnAlias('published'), 'disabled', 'true');
 
@@ -227,9 +227,11 @@ public function onWorkflowBeforeTransition($context, $pks, $transition)
 
 		$value = (int) $transition->options->get('publishing');
 
-		// Here it becomes tricky. We would like to use the component models publish method, so we will
-		// Execute the normal "onContentBeforeChangeState" plugins. But they could cancel the execution,
-		// So we have to precheck and cancel the whole transition stuff if not allowed.
+		/**
+		 * Here it becomes tricky. We would like to use the component models publish method, so we will
+		 * Execute the normal "onContentBeforeChangeState" plugins. But they could cancel the execution,
+		 * So we have to precheck and cancel the whole transition stuff if not allowed.
+		 */
 		$this->app->set('plgWorkflowPublishing.' . $context, $pks);
 
 		$result = $this->app->triggerEvent('onContentBeforeChangeState', [$context, $pks, $value]);
@@ -367,7 +369,9 @@ protected function isSupported($context)
 
 		$component = $this->app->bootComponent($parts[0]);
 
-		if (!$component instanceof WorkflowServiceInterface || !$component->isWorkflowActive($context) || !$component->supportFunctionality($this->supportname, $context))
+		if (!$component instanceof WorkflowServiceInterface
+			|| !$component->isWorkflowActive($context)
+			|| !$component->supportFunctionality($this->supportname, $context))
 		{
 			return false;
 		}