UnpublishItemWorkflowAction - Code Metrics - Inspection of "Added unpublish action and moved set property from..." - silverstripe-australia/advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#238)

unknown

created 2015-12-23 04:54 UTC

UnpublishItemWorkflowAction A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	67
Duplicated Lines	25.37 %

Coupling/Cohesion

Components	0
Dependencies	7

Metric	Value
wmc	10
lcom	0
cbo	7
dl	17
loc	67
rs	10

3 Methods

Rating	Name	Duplication	Size	Complexity
C	execute()	0	29	7
A	getCMSFields()	17	17	2
A	canPublishTarget()	0	3	1

How to fix Duplicated Code

<?php
/**
 * Unpublishes an item
 *
 * @author     [email protected]
 * @license    BSD License (http://silverstripe.org/bsd-license/)
 * @package    advancedworkflow
 * @subpackage actions
 */
class UnpublishItemWorkflowAction extends WorkflowAction {
namespace YourVendor;

class YourClass { }

	private static $db = array(

		'UnpublishDelay' => 'Int'
	);

	public static $icon = 'advancedworkflow/images/publish.png';

	public function execute(WorkflowInstance $workflow) {
		if (!$target = $workflow->getTarget()) {
			return true;
		}

		if (class_exists('AbstractQueuedJob') && $this->UnpublishDelay) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$job   = new WorkflowPublishTargetJob($target, "unpublish");
			$days  = $this->UnpublishDelay;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$after = date('Y-m-d H:i:s', strtotime("+$days days"));
			singleton('QueuedJobService')->queueJob($job, $after);
		} else if ($target->hasExtension('WorkflowEmbargoExpiryExtension')) {
			// setting future date stuff if needbe

			// set these values regardless
			$target->DesiredUnPublishDate = '';
			$target->DesiredPublishDate = '';
			$target->write();
			
			if ($target->hasMethod('doUnpublish')) {
				$target->doUnpublish();
			}
		} else {
			if ($target->hasMethod('doUnpublish')) {
				$target->doUnpublish();
			}
		}

		return true;
	}

	public function getCMSFields() {

		$fields = parent::getCMSFields();

		if (class_exists('AbstractQueuedJob')) {
			$before = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSBEFORE', 'Delay publication ');
			$after  = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSAFTER', ' days');

			$fields->addFieldToTab('Root.Main', new FieldGroup(
				_t('UnpublishItemWorkflowAction.UNPUBLICATIONDELAY', 'Delay Un-publishing'),
				new LabelField('UnpublishDelayBefore', $before),
				new NumericField('UnpublishDelay', ''),
				new LabelField('UnpublishDelayAfter', $after)
			));
		}

		return $fields;
	}

	/**
	 * Unpublish action allows a user who is currently assigned at this point of the workflow to
	 *
	 * @param  DataObject $target
	 * @return bool
	 */
	public function canPublishTarget(DataObject $target) {
		return true;
	}

}

1		<?php
2		/**
3		* Unpublishes an item
4		*
5		* @author [email protected]
6		* @license BSD License (http://silverstripe.org/bsd-license/)
7		* @package advancedworkflow
8		* @subpackage actions
9		*/
10		class UnpublishItemWorkflowAction extends WorkflowAction {
		0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11
12		private static $db = array(
		0 ignored issues – show Comprehensibility introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
13		'UnpublishDelay' => 'Int'
14		);
15
16		public static $icon = 'advancedworkflow/images/publish.png';
17
18		public function execute(WorkflowInstance $workflow) {
19		if (!$target = $workflow->getTarget()) {
20		return true;
21		}
22
23		if (class_exists('AbstractQueuedJob') && $this->UnpublishDelay) {
		0 ignored issues – show Documentation introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `UnpublishDelay` does not exist on `object<UnpublishItemWorkflowAction>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
24		$job = new WorkflowPublishTargetJob($target, "unpublish");
25		$days = $this->UnpublishDelay;
		0 ignored issues – show Documentation introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `UnpublishDelay` does not exist on `object<UnpublishItemWorkflowAction>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
26		$after = date('Y-m-d H:i:s', strtotime("+$days days"));
27		singleton('QueuedJobService')->queueJob($job, $after);
28		} else if ($target->hasExtension('WorkflowEmbargoExpiryExtension')) {
29		// setting future date stuff if needbe
30
31		// set these values regardless
32		$target->DesiredUnPublishDate = '';
33		$target->DesiredPublishDate = '';
34		$target->write();
35
36		if ($target->hasMethod('doUnpublish')) {
37		$target->doUnpublish();
38		}
39		} else {
40		if ($target->hasMethod('doUnpublish')) {
41		$target->doUnpublish();
42		}
43		}
44
45		return true;
46		}
47
48	View Code Duplication	public function getCMSFields() {
		0 ignored issues – show Duplication introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
49		$fields = parent::getCMSFields();
50
51		if (class_exists('AbstractQueuedJob')) {
52		$before = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSBEFORE', 'Delay publication ');
53		$after = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSAFTER', ' days');
54
55		$fields->addFieldToTab('Root.Main', new FieldGroup(
56		_t('UnpublishItemWorkflowAction.UNPUBLICATIONDELAY', 'Delay Un-publishing'),
57		new LabelField('UnpublishDelayBefore', $before),
58		new NumericField('UnpublishDelay', ''),
59		new LabelField('UnpublishDelayAfter', $after)
60		));
61		}
62
63		return $fields;
64		}
65
66		/**
67		* Unpublish action allows a user who is currently assigned at this point of the workflow to
68		*
69		* @param DataObject $target
70		* @return bool
71		*/
72		public function canPublishTarget(DataObject $target) {
73		return true;
74		}
75
76		}

silverstripe-australia / advancedworkflow

Pull Request — master (#238)

UnpublishItemWorkflowAction A

Complexity

Size/Duplication

Coupling/Cohesion

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like