Issues in AdvancedWorkflowAdmin.php - All Issues - Inspection of "ENHANCEMENT Replace CMS graphic with font icon." - symbiote/silverstripe-advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#344)

unknown

created 2018-02-04 21:31 UTC

src/Admin/AdvancedWorkflowAdmin.php (39 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Symbiote\AdvancedWorkflow\Admin;

use SilverStripe\Admin\ModelAdmin;
use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_Base;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\GridField\GridFieldDetailForm;
use SilverStripe\Forms\GridField\GridFieldPaginator;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\View\Requirements;
use Symbiote\AdvancedWorkflow\Admin\WorkflowDefinitionItemRequestClass;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowDefinition;
use Symbiote\AdvancedWorkflow\Dev\WorkflowBulkLoader;
use Symbiote\AdvancedWorkflow\Forms\GridField\GridFieldExportAction;
use Symbiote\AdvancedWorkflow\Forms\GridField\GridFieldWorkflowRestrictedEditButton;
use Symbiote\AdvancedWorkflow\Services\WorkflowService;

/**
 * @package advancedworkflow
 * @todo UI/UX needs looking at for when current user has no pending and/or submitted items, (Current
 * implementation is bog-standard <p> text)
 */
class AdvancedWorkflowAdmin extends ModelAdmin
{
    private static $menu_title    = 'Workflows';

    private static $menu_priority = -1;

    private static $url_segment   = 'workflows';

    private static $menu_icon_class = 'font-icon-flow-tree';


    /**
     *
     * @var array Allowable actions on this controller.
     */
    private static $allowed_actions = array(

        'export',
        'ImportForm'
    );

    private static $url_handlers = array(

        '$ModelClass/export/$ID!' => 'export',
        '$ModelClass/$Action' => 'handleAction',
        '' => 'index'
    );

    private static $managed_models = WorkflowDefinition::class;


    private static $model_importers = array(

        'WorkflowDefinition' => WorkflowBulkLoader::class
    );

    private static $dependencies = array(

        'workflowService' => '%$' . WorkflowService::class,
    );

    private static $fileEditActions = 'getCMSActions';


    /**
     * Defaults are set in {@link getEditForm()}.
     *
     * @var array
     */
    private static $fieldOverrides = array();


    /**
     * @var WorkflowService
     */
    public $workflowService;

    /**
     * Initialise javascript translation files
     *
     * @return void
     */
    protected function init()
    {
        parent::init();

        Requirements::add_i18n_javascript('symbiote/silverstripe-advancedworkflow:client/lang');
        Requirements::javascript('symbiote/silverstripe-advancedworkflow:client/dist/js/advancedworkflow.js');
        Requirements::css('symbiote/silverstripe-advancedworkflow:client/dist/styles/advancedworkflow.css');
    }

    /*
     * Shows up to x2 GridFields for Pending and Submitted items, dependent upon the current CMS user and
     * that user's permissions on the objects showing in each field.
     */
    public function getEditForm($id = null, $fields = null)
    {
        $form = parent::getEditForm($id, $fields);

        // Show items submitted into a workflow for current user to action
        $fieldName = 'PendingObjects';
        $pending = $this->userObjects(Member::currentUser(), $fieldName);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        if ($this->config()->fieldOverrides) {
            $displayFields = $this->config()->fieldOverrides;
        } else {
            $displayFields = array(
                'Title'          => _t('AdvancedWorkflowAdmin.Title', 'Title'),
                'LastEdited'     => _t('AdvancedWorkflowAdmin.LastEdited', 'Changed'),
                'WorkflowTitle'  => _t('AdvancedWorkflowAdmin.WorkflowTitle', 'Effective workflow'),
                'WorkflowStatus' => _t('AdvancedWorkflowAdmin.WorkflowStatus', 'Current action'),
            );
        }

        // Pending/Submitted items GridField Config
        $config = new GridFieldConfig_Base();
        $config->addComponent(new GridFieldEditButton());
        $config->addComponent(new GridFieldDetailForm());
        $config->getComponentByType(GridFieldPaginator::class)->setItemsPerPage(5);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $columns = $config->getComponentByType(GridFieldDataColumns::class);
        $columns->setFieldFormatting($this->setFieldFormatting($config));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if ($pending->count()) {
            $formFieldTop = GridField::create(
                $fieldName,
                $this->isAdminUser(Member::currentUser())?
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                    _t(
                        'AdvancedWorkflowAdmin.GridFieldTitleAssignedAll',
                        'All pending items'
                    ):
                    _t(
                        'AdvancedWorkflowAdmin.GridFieldTitleAssignedYour',
                        'Your pending items'
                    ),
                $pending,
                $config
            );

            $dataColumns = $formFieldTop->getConfig()->getComponentByType(GridFieldDataColumns::class);
            $dataColumns->setDisplayFields($displayFields);

            $formFieldTop->setForm($form);
            $form->Fields()->insertBefore($formFieldTop, WorkflowDefinition::class);
        }

        // Show items submitted into a workflow by current user
        $fieldName = 'SubmittedObjects';
        $submitted = $this->userObjects(Member::currentUser(), $fieldName);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        if ($submitted->count()) {
            $formFieldBottom = GridField::create(
                $fieldName,
                $this->isAdminUser(Member::currentUser())?
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                    _t(
                        'AdvancedWorkflowAdmin.GridFieldTitleSubmittedAll',
                        'All submitted items'
                    ):
                    _t(
                        'AdvancedWorkflowAdmin.GridFieldTitleSubmittedYour',
                        'Your submitted items'
                    ),
                $submitted,
                $config
            );

            $dataColumns = $formFieldBottom->getConfig()->getComponentByType(GridFieldDataColumns::class);
            $dataColumns->setDisplayFields($displayFields);

            $formFieldBottom->setForm($form);
            $formFieldBottom->getConfig()->removeComponentsByType(GridFieldEditButton::class);
            $formFieldBottom->getConfig()->addComponent(new GridFieldWorkflowRestrictedEditButton());
            $form->Fields()->insertBefore($formFieldBottom, WorkflowDefinition::class);
        }

        $grid = $form->Fields()->dataFieldByName(WorkflowDefinition::class);
        if ($grid) {
            $grid->getConfig()->getComponentByType(GridFieldDetailForm::class)

                ->setItemEditFormCallback(function ($form) {
                    $record = $form->getRecord();
                    if ($record) {
                        $record->updateAdminActions($form->Actions());
                    }
                });

            $grid->getConfig()->getComponentByType(GridFieldDetailForm::class)

                ->setItemRequestClass(WorkflowDefinitionItemRequestClass::class);
            $grid->getConfig()->addComponent(new GridFieldExportAction());

            $grid->getConfig()->removeComponentsByType(GridFieldExportButton::class);

        }

        return $form;
    }

    /*
     * @param Member $user
     * @return boolean
     */
    public function isAdminUser(Member $user)
    {
        if (Permission::checkMember($user, 'ADMIN')) {
            return true;
        }
        return false;
    }

    /*
     * By default, we implement GridField_ColumnProvider to allow users to click through to the PagesAdmin.
     * We would also like a "Quick View", that allows users to quickly make a decision on a given workflow-bound
     * content-object
     */
    public function columns()
    {
        $fields = array(
            'Title' => array(
                'link' => function ($value, $item) {
                    $pageAdminLink = singleton(CMSPageEditController::class)->Link('show');
                    return sprintf('<a href="%s/%s">%s</a>', $pageAdminLink, $item->Link, $value);
                }
            ),
            'WorkflowStatus' => array(
                'text' => function ($value, $item) {
                    return $item->WorkflowCurrentAction;
                }
            )
        );
        return $fields;
    }

    /*
     * Discreet method used by both intro gridfields to format the target object's links and clickable text
     *
     * @param GridFieldConfig $config
     * @return array $fieldFormatting
     */
    public function setFieldFormatting(&$config)

    {
        $fieldFormatting = array();
        // Parse the column information
        foreach ($this->columns() as $source => $info) {
            if (isset($info['link']) && $info['link']) {
                $fieldFormatting[$source] = '<a href=\"$ObjectRecordLink\">$value</a>';
            }
            if (isset($info['text']) && $info['text']) {
                $fieldFormatting[$source] = $info['text'];
            }
        }
        return $fieldFormatting;
    }

    /**
     * Get WorkflowInstance Target objects to show for users in initial gridfield(s)
     *
     * @param Member $member
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $fieldName The name of the gridfield that determines which dataset to return
     * @return DataList
     * @todo Add the ability to see embargo/expiry dates in report-gridfields at-a-glance if QueuedJobs module installed
     */
    public function userObjects(Member $user, $fieldName)
    {
        $list = new ArrayList();
        $userWorkflowInstances = $this->getFieldDependentData($user, $fieldName);
        foreach ($userWorkflowInstances as $instance) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (!$instance->TargetID || !$instance->DefinitionID) {
                continue;
            }
            // @todo can we use $this->getDefinitionFor() to fetch the "Parent" definition of $instance? Maybe
            // define $this->workflowParent()

            $effectiveWorkflow = DataObject::get_by_id(WorkflowDefinition::class, $instance->DefinitionID);
            $target = $instance->getTarget();
            if (!is_object($effectiveWorkflow) || !$target) {
                continue;
            }
            $instance->setField('WorkflowTitle', $effectiveWorkflow->getField('Title'));
            $instance->setField('WorkflowCurrentAction', $instance->getCurrentAction());
            // Note the order of property-setting here, somehow $instance->Title is overwritten by the Target
            // Title property..
            $instance->setField('Title', $target->getField('Title'));
            $instance->setField('LastEdited', $target->getField('LastEdited'));
            if (method_exists($target, 'CMSEditLink')) {
                $instance->setField('ObjectRecordLink', $target->CMSEditLink());
            }

            $list->push($instance);
        }
        return $list;
    }

    /*
     * Return content-object data depending on which gridfeld is calling for it
     *
     * @param Member $user
     * @param string $fieldName
     */
    public function getFieldDependentData(Member $user, $fieldName)
    {
        if ($fieldName == 'PendingObjects') {
            return $this->workflowService->userPendingItems($user);
        }
        if ($fieldName == 'SubmittedObjects') {
            return $this->workflowService->userSubmittedItems($user);
        }
    }

    /**
     * Spits out an exported version of the selected WorkflowDefinition for download.
     *
     * @param HTTPRequest $request
     * @return HTTPResponse
     */
    public function export(HTTPRequest $request)
    {
        $url = explode('/', $request->getURL());
        $definitionID = end($url);
        if ($definitionID && is_numeric($definitionID)) {
            $exporter = new WorkflowDefinitionExporter($definitionID);
            $exportFilename = WorkflowDefinitionExporter::$export_filename_prefix.'-'.$definitionID.'.yml';

            $exportBody = $exporter->export();
            $fileData = array(
                'name' => $exportFilename,
                'mime' => 'text/x-yaml',
                'body' => $exportBody,
                'size' => $exporter->getExportSize($exportBody)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            );
            return $exporter->sendFile($fileData);
        }
    }

    /**
     * Required so we can simply change the visible label of the "Import" button and lose some redundant form-fields.
     *
     * @return Form
     */
    public function ImportForm()
    {
        $form = parent::ImportForm();
        if (!$form) {
            return;
        }

        $form->unsetAllActions();
        $newActionList = new FieldList(array(
            new FormAction('import', _t('AdvancedWorkflowAdmin.IMPORT', 'Import workflow'))
        ));
        $form->Fields()->fieldByName('_CsvFile')->getValidator()->setAllowedExtensions(array('yml', 'yaml'));
        $form->Fields()->removeByName('EmptyBeforeImport');
        $form->setActions($newActionList);

        return $form;
    }
}


GitHub Access Token became invalid

Pull Request — master (#344)

src/Admin/AdvancedWorkflowAdmin.php (39 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1			<?php
2
3			namespace Symbiote\AdvancedWorkflow\Admin;
4
5			use SilverStripe\Admin\ModelAdmin;
6			use SilverStripe\CMS\Controllers\CMSPageEditController;
7			use SilverStripe\Control\HTTPRequest;
8			use SilverStripe\Core\Manifest\ModuleLoader;
9			use SilverStripe\Forms\GridField\GridField;
10			use SilverStripe\Forms\GridField\GridFieldConfig_Base;
11			use SilverStripe\Forms\GridField\GridFieldDataColumns;
12			use SilverStripe\Forms\GridField\GridFieldEditButton;
13			use SilverStripe\Forms\GridField\GridFieldDetailForm;
14			use SilverStripe\Forms\GridField\GridFieldPaginator;
15			use SilverStripe\Forms\FieldList;
16			use SilverStripe\Forms\FormAction;
17			use SilverStripe\Forms\GridField\GridFieldExportButton;
18			use SilverStripe\ORM\ArrayList;
19			use SilverStripe\ORM\DataObject;
20			use SilverStripe\Security\Member;
21			use SilverStripe\Security\Permission;
22			use SilverStripe\View\Requirements;
23			use Symbiote\AdvancedWorkflow\Admin\WorkflowDefinitionItemRequestClass;
24			use Symbiote\AdvancedWorkflow\DataObjects\WorkflowDefinition;
25			use Symbiote\AdvancedWorkflow\Dev\WorkflowBulkLoader;
26			use Symbiote\AdvancedWorkflow\Forms\GridField\GridFieldExportAction;
27			use Symbiote\AdvancedWorkflow\Forms\GridField\GridFieldWorkflowRestrictedEditButton;
28			use Symbiote\AdvancedWorkflow\Services\WorkflowService;
29
30			/**
31			* @package advancedworkflow
32			* @todo UI/UX needs looking at for when current user has no pending and/or submitted items, (Current
33			* implementation is bog-standard <p> text)
34			*/
35			class AdvancedWorkflowAdmin extends ModelAdmin
36			{
37			private static $menu_title = 'Workflows';
			0 ignored issues – show Comprehensibility introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$menu_title` 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...
38			private static $menu_priority = -1;
			0 ignored issues – show Comprehensibility introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-01 23:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$menu_priority` 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...

symbiote / silverstripe-advancedworkflow

GitHub Access Token became invalid

Pull Request — master (#344)

src/Admin/AdvancedWorkflowAdmin.php (39 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like