Job::getCustomSearchContext() - Code Metrics - Inspection of "PermissionProvider - consolidate to MANAGE_JOBS pe..." - dynamic/silverstripe-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#15)

by Jason
created 2019-05-02 21:10 UTC
Job::getCustomSearchContext() A

↳ Parent: Job
Complexity

Conditions	1
Paths	1
Size

Total Lines	16
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	10
nc	1
nop	0
dl	0
loc	16
ccs	0
cts	1
cp	0
crap	2
rs	9.9332
c	0
b	0
f	0
<?php

namespace Dynamic\Jobs\Page;

use Dynamic\Jobs\Model\JobCategory;
use Dynamic\Jobs\Model\JobSection;
use Dynamic\Jobs\Model\JobSubmission;
use \Page;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\DateField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\Forms\ListboxField;
use SilverStripe\Forms\TreeMultiselectField;
use SilverStripe\ORM\Search\SearchContext;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
 * Class Job
 * @package Dynamic\Jobs\Model
 */
class Job extends Page implements PermissionProvider
{
    /**
     * @var string
     */
    private static $table_name = 'Dynamic_Job';


    /**
     * @var array
     */
    private static $db = [

        'PositionType' => "Enum(array('Full-time', 'Part-time', 'Freelance', 'Internship'))",
        'PostDate' => 'Date',
        'EndPostDate' => 'Date',
    ];

    /**
     * @var array
     */
    private static $has_many = [

        'Sections' => JobSection::class,
        'Submissions' => JobSubmission::class,
    ];

    /**
     * @var array
     */
    private static $many_many = [

        'Categories' => JobCategory::class,
    ];

    /**
     * @var array
     */
    private static $many_many_extraFields = [

        'Categories' => [
            'Sort' => 'Int',
        ],
    ];

    /**
     * @var array
     */
    private static $searchable_fields = [

        'Title',
        'Categories.ID' => [
            'title' => 'Category',
        ],
        'PositionType' => [
            'title' => 'Type',
        ],
    ];

    /**
     * @var string
     */
    private static $default_parent = JobCollection::class;


    /**
     * @var bool
     */
    private static $can_be_root = false;


    /**
     * @var bool
     */
    private static $show_in_sitetree = false;


    /**
     * @var array
     */
    private static $allowed_children = [];


    /**
     * @return SearchContext
     */
    public function getCustomSearchContext()
    {
        $fields = $this->scaffoldSearchFields([
            'restrictFields' => [
                'Title',
                'Categories.ID',
                'PositionType',
            ],
        ]);

        $filters = $this->defaultSearchFilters();

        return new SearchContext(
            $this->ClassName,
            $fields,
            $filters
        );
    }

    /**
     *
     */
    public function populateDefaults()
    {
        $this->PostDate = date('Y-m-d');


        parent::populateDefaults();
    }

    /**
     * @param bool $includerelations
     * @return array
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);

        $labels['Title'] = _t(__CLASS__ . '.TitleLabel', 'Position Name');
        $labels['Content'] = _t(__CLASS__ . '.ContentLabel', 'Introduction');
        $labels['PositionType'] = _t(__CLASS__ . '.PositionTypeLabel', 'Position Type');
        $labels['PostDate'] = _t(__CLASS__ . '.PostDateLabel', 'Post Start Date');
        $labels['EndPostDate'] = _t(__CLASS__ . '.EndPostDateLabel', 'Post End Date');
        $labels['Details'] =  _t(__CLASS__ . '.DetailsTab', "Details");
        $labels['Submissions'] = _t(__CLASS__ . '.SubmissionsTab', 'Submissions');
        //$labels['Categories'] = _t(JobCategory::class . '.SlideType', 'Image or Video');


        return $labels;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function ($fields) {
            $fields->dataFieldByName('Content')
                ->setTitle($this->fieldLabel('Content'))
                ->setRows(10);

            $fields->addFieldsToTab('Root.' . $this->fieldLabel('Details'), [
                DropdownField::create(
                    'PositionType',
                    $this->fieldLabel('PositionType'),
                    Job::singleton()->dbObject('PositionType')->enumValues()
                )->setEmptyString('--select--'),
                DateField::create('PostDate', $this->fieldLabel('PostDate'))
                    ->setDescription(_t(
                        __CLASS__ . '.PostDateDescription',
                        'Date position should appear on website'
                    )),
                DateField::create('EndPostDate', $this->fieldLabel('EndPostDate'))
                    ->setDescription(_t(
                        __CLASS__ . '.EndPostDateDescription',
                        'Date position should be removed from website'
                    )),
            ]);

            if ($this->ID) {
                // categories
                $categoriesField = ListboxField::create(
                    'Categories',
                    _t(JobCategory::class . '.PLURALNAME', 'Categories'),
                    JobCategory::get()->map()
                );

                $fields->addFieldsToTab('Root.' . $this->fieldLabel('Details'), [
                    $categoriesField,
                ]);

                // sections
                $config = GridFieldConfig_RelationEditor::create();
                $config
                    ->addComponent(new GridFieldOrderableRows('Sort'))
                    ->addComponent(new GridFieldDeleteAction(false))
                    ->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
                    ->removeComponentsByType(GridFieldDeleteAction::class);

                $sections = $this->Sections()->sort('Sort');
                $sections = $this->/** @scrutinizer ignore-call */ Sections()->sort('Sort');
                $sectionsField = GridField::create(
                    'Sections',
                    _t(JobSection::class . '.PLURALNAME', 'Sections'),
                    $sections,
                    $config
                )
                    ->setDescription(_t(
                        __CLASS__ . '.SectionsDescription',
                        'ex: Requirements, Education, Duties, etc.'
                    ));

                $fields->addFieldsToTab('Root.Main', [
                    $sectionsField,
                ]);

                // submissions
                $config = GridFieldConfig_RelationEditor::create();
                $config
                    ->addComponent(new GridFieldDeleteAction(false))
                    ->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
                    ->removeComponentsByType(GridFieldDeleteAction::class);

                $submissions = $this->Submissions();
                $submissions = $this->Submissions();
                $submissionsField = GridField::create(
                    'Submissions',
                    _t(JobSubmission::class . '.PLURALNAME', 'Submissions'),
                    $submissions,
                    $config)
                ;
                $fields->addFieldsToTab('Root.' . $this->fieldLabel('Submissions'), [
                    $submissionsField,
                ]);
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return string
     */
    public function getApplyButton()
    {
        $apply = Controller::join_links(
            $this->Link(),
            'apply'
        );
        return $apply;
    }

    /**
     * @return mixed
     */
    public function getApplicationLink()
    {
        if ($this->parent()->Application()->ID != 0) {
            return $this->parent()->Application()->URL;
        }
        return false;
    }

    /**
     * @return mixed
     */
    public function getCategoryList()
    {
        return $this->Categories()->sort('Sort');
        return $this->/** @scrutinizer ignore-call */ Categories()->sort('Sort');
    }

    /**
     * @return bool
     */
    public function getPrimaryCategory()
    {
        if ($this->Categories()->exists()) {
            return $this->Categories()->first();
        }
        return false;
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return [
            'JOB_MANAGE' => [
                'name' => _t(
                    __CLASS__ . '.JOB_MANAGE',
                    'Manage Jobs'
                ),
                'category' => _t(
                __CLASS__ . '.JOB_MANAGE_CATEGORY',
                    'Jobs'
                ),
                'help' => _t(
                    __CLASS__ . '.JOB_MANAGE_HELP',
                    'Access to add, edit and delete Jobs'
                ),
                'sort' => 400,
            ],
        ];
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canEdit($member = null)
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canDelete($member = null)
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canCreate($member = null, $context = [])
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }
}

dynamic / silverstripe-jobs

Pull Request — master (#15)

Job::getCustomSearchContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
