symbiote / silverstripe-advancedworkflow

src/Actions/PublishItemWorkflowAction.php

<?php

namespace Symbiote\AdvancedWorkflow\Actions;

use SilverStripe\Forms\CheckboxField;
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\QueuedJobs\Services\AbstractQueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;

/**
 * Publishes an item
 *
 * @author     marcus@symbiote.com.au
 * @license    BSD License (http://silverstripe.org/bsd-license/)
 * @package    advancedworkflow
 * @subpackage actions
 */
class PublishItemWorkflowAction extends WorkflowAction
{
    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'PublishDelay'          => 'Int',
        'AllowEmbargoedEditing' => 'Boolean',
    );

    private static $defaults = array(

Consider using a different property name as you override a private property of the parent class.

The property $defaults is not used and could be removed.

        'AllowEmbargoedEditing' => true
    );

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

Consider using a different property name as you override a private property of the parent class.

The property $icon is not used and could be removed.

    private static $table_name = 'PublishItemWorkflowAction';

Consider using a different property name as you override a private property of the parent class.

The property $table_name is not used and could be removed.

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

        if (class_exists(AbstractQueuedJob::class) && $this->PublishDelay) {

The property PublishDelay does not exist on object<Symbiote\AdvancedWorkflow\Actions\PublishItemWorkflowAction>. Since you implemented __get, maybe consider adding a @property annotation.

            $job   = new WorkflowPublishTargetJob($target);
            $days  = $this->PublishDelay;

The property PublishDelay does not exist on object<Symbiote\AdvancedWorkflow\Actions\PublishItemWorkflowAction>. Since you implemented __set, maybe consider adding a @property annotation.

            $after = date('Y-m-d H:i:s', strtotime("+$days days"));

            // disable editing, and embargo the delay if using WorkflowEmbargoExpiryExtension
            if ($target->hasExtension(WorkflowEmbargoExpiryExtension::class)) {
                $target->AllowEmbargoedEditing = $this->AllowEmbargoedEditing;

The property AllowEmbargoedEditing does not exist on object<Symbiote\AdvancedWorkflow\Actions\PublishItemWorkflowAction>. Since you implemented __set, maybe consider adding a @property annotation.

                $target->PublishOnDate = $after;
                $target->write();
            } else {
                singleton(QueuedJobService::class)->queueJob($job, $after);
            }
        } elseif ($target->hasExtension(WorkflowEmbargoExpiryExtension::class)) {
            $target->AllowEmbargoedEditing = $this->AllowEmbargoedEditing;

The property AllowEmbargoedEditing does not exist on object<Symbiote\AdvancedWorkflow\Actions\PublishItemWorkflowAction>. Since you implemented __set, maybe consider adding a @property annotation.

            // setting future date stuff if needbe

            // set this value regardless
            $target->UnPublishOnDate = $target->DesiredUnPublishDate;
            $target->DesiredUnPublishDate = '';

            // Publish dates
            if ($target->DesiredPublishDate) {
                // Hand-off desired publish date
                $target->PublishOnDate = $target->DesiredPublishDate;
                $target->DesiredPublishDate = '';
                $target->write();
            } else {
                // Ensure previously modified DesiredUnPublishDate values are written
                $target->write();
                if ($target->hasMethod('publishSingle')) {
                    $target->publishSingle();
                }
            }
        } else {
            if ($target->hasMethod('publishSingle')) {
                $target->publishSingle();
            }
        }

        return true;
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        if (class_exists(AbstractQueuedJob::class)) {
            $fields->addFieldsToTab('Root.Main', [
                CheckboxField::create(
                    'AllowEmbargoedEditing',
                    _t(
                        __CLASS__ . '.ALLOWEMBARGOEDEDITING',
                        'Allow editing while item is embargoed? (does not apply without embargo)'
                    )
                ),
                NumericField::create(
                    'PublishDelay',
                    _t('PublishItemWorkflowAction.PUBLICATIONDELAY', 'Publication Delay')
                )->setDescription(_t(
                    __CLASS__ . '.PublicationDelayDescription',
                    'Delay publiation by the specified number of days'
                ))
            ]);
        }

        return $fields;
    }

    /**
     * Publish 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;
    }
}