UnpublishItemWorkflowAction::getCMSFields() - Code Metrics - symbiote/silverstripe-advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

UnpublishItemWorkflowAction::getCMSFields() A
last analyzed 2019-12-18 23:33 UTC

↳ Parent: UnpublishItemWorkflowAction

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace Symbiote\AdvancedWorkflow\Actions;

use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\LabelField;
use SilverStripe\Forms\NumericField;
use SilverStripe\ORM\DataObject;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowAction;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;
use Symbiote\AdvancedWorkflow\Extensions\WorkflowEmbargoExpiryExtension;
use Symbiote\AdvancedWorkflow\Jobs\WorkflowPublishTargetJob;
use Symbiote\QueuedJob\Services\AbstractQueuedJob;
use Symbiote\QueuedJob\Services\QueuedJobService;

/**
 * Unpublishes an item
 *
 * @author     [email protected]
 * @license    BSD License (http://silverstripe.org/bsd-license/)
 * @package    advancedworkflow
 * @subpackage actions
 */
class UnpublishItemWorkflowAction extends WorkflowAction
{
    private static $db = array(

        'UnpublishDelay' => 'Int'
    );

    private static $icon = 'symbiote/silverstripe-advancedworkflow:images/unpublish.png';


    private static $table_name = 'UnpublishItemWorkflowAction';


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

        if (class_exists(AbstractQueuedJob::class) && $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::class)->queueJob($job, $after);
        } elseif ($target->hasExtension(WorkflowEmbargoExpiryExtension::class)) {
            // 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::class)) {
            $before = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSBEFORE', 'Delay unpublishing by ');
            $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;
    }

    /**
     * @param  DataObject $target
     * @return bool
     */
    public function canPublishTarget(DataObject $target)
    {
        return false;
    }
}


1			<?php
2
3			namespace Symbiote\AdvancedWorkflow\Actions;
4
5			use SilverStripe\Forms\FieldGroup;
6			use SilverStripe\Forms\LabelField;
7			use SilverStripe\Forms\NumericField;
8			use SilverStripe\ORM\DataObject;
9			use Symbiote\AdvancedWorkflow\DataObjects\WorkflowAction;
10			use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;
11			use Symbiote\AdvancedWorkflow\Extensions\WorkflowEmbargoExpiryExtension;
12			use Symbiote\AdvancedWorkflow\Jobs\WorkflowPublishTargetJob;
13			use Symbiote\QueuedJob\Services\AbstractQueuedJob;
14			use Symbiote\QueuedJob\Services\QueuedJobService;
15
16			/**
17			* Unpublishes an item
18			*
19			* @author [email protected]
20			* @license BSD License (http://silverstripe.org/bsd-license/)
21			* @package advancedworkflow
22			* @subpackage actions
23			*/
24			class UnpublishItemWorkflowAction extends WorkflowAction
25			{
26			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2017-10-01 23:10 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...
27			'UnpublishDelay' => 'Int'
28			);
29
30			private static $icon = 'symbiote/silverstripe-advancedworkflow:images/unpublish.png';
			0 ignored issues – show Comprehensibility introduced 2017-10-27 02:51 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...
31
32			private static $table_name = 'UnpublishItemWorkflowAction';
			0 ignored issues – show Comprehensibility introduced 2017-10-01 23:10 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...
33
34			public function execute(WorkflowInstance $workflow)
35			{
36			if (!$target = $workflow->getTarget()) {
37			return true;
38			}
39
40			if (class_exists(AbstractQueuedJob::class) && $this->UnpublishDelay) {
			0 ignored issues – show Documentation introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report The property `UnpublishDelay` does not exist on `object<Symbiote\Advanced...lishItemWorkflowAction>`. 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...
41			$job = new WorkflowPublishTargetJob($target, "unpublish");
42			$days = $this->UnpublishDelay;
			0 ignored issues – show Documentation introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report The property `UnpublishDelay` does not exist on `object<Symbiote\Advanced...lishItemWorkflowAction>`. 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...
43			$after = date('Y-m-d H:i:s', strtotime("+$days days"));
44			singleton(QueuedJobService::class)->queueJob($job, $after);
45			} elseif ($target->hasExtension(WorkflowEmbargoExpiryExtension::class)) {
46			// setting future date stuff if needbe
47
48			// set these values regardless
49			$target->DesiredUnPublishDate = '';
50			$target->DesiredPublishDate = '';
51			$target->write();
52
53			if ($target->hasMethod('doUnpublish')) {
54			$target->doUnpublish();
55			}
56			} else {
57			if ($target->hasMethod('doUnpublish')) {
58			$target->doUnpublish();
59			}
60			}
61
62			return true;
63			}
64
65			public function getCMSFields()
66			{
67			$fields = parent::getCMSFields();
68
69			if (class_exists(AbstractQueuedJob::class)) {
70			$before = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSBEFORE', 'Delay unpublishing by ');
71			$after = _t('UnpublishItemWorkflowAction.DELAYUNPUBDAYSAFTER', ' days');
72
73			$fields->addFieldToTab('Root.Main', new FieldGroup(
74			_t('UnpublishItemWorkflowAction.UNPUBLICATIONDELAY', 'Delay Un-publishing'),
75			new LabelField('UnpublishDelayBefore', $before),
76			new NumericField('UnpublishDelay', ''),
77			new LabelField('UnpublishDelayAfter', $after)
78			));
79			}
80
81			return $fields;
82			}
83
84			/**
85			* @param DataObject $target
86			* @return bool
87			*/
88			public function canPublishTarget(DataObject $target)
89			{
90			return false;
91			}
92			}
93

symbiote / silverstripe-advancedworkflow

GitHub Access Token became invalid

UnpublishItemWorkflowAction::getCMSFields() A last analyzed 2019-12-18 23:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UnpublishItemWorkflowAction::getCMSFields() A
last analyzed 2019-12-18 23:33 UTC