phptek / silverstripe-exodus

src/Model/StaticSiteContentSourceImportRule.php

<?php

namespace PhpTek\Exodus\Model;

use SilverStripe\ORM\DataObject;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\FieldType\DBText;
use SilverStripe\ORM\FieldType\DBVarchar;
use SilverStripe\Forms\DropdownField;
use SilverStripe\ORM\FieldType\DBBoolean;
use SilverStripe\ORM\DataObjectSchema;

/**
 * A single import rule that forms part of an ImportSchema
 */
class StaticSiteContentSourceImportRule extends DataObject
{
    /**
     *
     * @var array
     */
    private static $db = [

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

        "FieldName" => DBVarchar::class,
        "CSSSelector" => DBVarchar::class,
        "ExcludeCSSSelector" => DBText::class,
        "Attribute" => DBVarchar::class,
        "PlainText" => DBBoolean::class,
        "OuterHTML" => DBBoolean::class,
    ];

    /**
     * @var string
     */
    private static $table_name = 'StaticSiteContentSourceImportRule';

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

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

The private property $summary_fields is not used, and could be removed.

        "FieldName",
        "PlainText",
        "OuterHTML",
    ];

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

The private property $field_labels is not used, and could be removed.

        "FieldName" => "Target Field Name",
        "CSSSelector" => "CSS Selector",
        'ExcludeCSSSelector' => 'Excluded CSS Selector(s)',
        "Attribute" => "Element Attribute",
        "PlainText" => "Plain Text",
        "OuterHTML" => "Outer HTML",
    ];

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

The private property $has_one is not used, and could be removed.

        "Schema" => StaticSiteContentSourceImportSchema::class,
    ];

    /**
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->FieldName ?: $this->ID;

The property FieldName does not exist on PhpTek\Exodus\Model\StaticSiteContentSourceImportRule. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     *
     * @return string
     */
    public function getAbsoluteURL()
    {
        return $this->URLSegment ?: $this->Filename;

The property URLSegment does not exist on PhpTek\Exodus\Model\StaticSiteContentSourceImportRule. Since you implemented __get, consider adding a @property annotation.

The property Filename does not exist on PhpTek\Exodus\Model\StaticSiteContentSourceImportRule. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     *
     * @return FieldList

The type PhpTek\Exodus\Model\FieldList was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $dataType = $this->Schema()->DataType;

The method Schema() does not exist on PhpTek\Exodus\Model\StaticSiteContentSourceImportRule. Since you implemented __call, consider adding a @method annotation.

        if ($dataType) {
            $fieldList = singleton(DataObjectSchema::class)
                ->fieldSpecs($dataType, DataObjectSchema::DB_ONLY);
            $fieldList = array_combine(array_keys($fieldList), array_keys($fieldList));
            foreach (
                array_merge(
                    array_keys(DataObject::config()->get('fixed_fields')),
                    array_filter($fieldList, function ($item) {
                        return preg_match('#(^Static|ID$)#i', $item);
                    }),
                    ['Version']
                ) as $exclusion
            ) {
                unset($fieldList[$exclusion]);
            }

            natsort($fieldList);

            $fieldNameField = DropdownField::create("FieldName", 'Target Field', $fieldList)
                ->setEmptyString("(choose)")
                ->setDescription('Remote content matched by the CSS selector below is written to this field.');
            $fields->insertBefore($fieldNameField, 'CSSSelector');

'CSSSelector' of type string is incompatible with the type SilverStripe\Forms\FormField expected by parameter $item of SilverStripe\Forms\FieldList::insertBefore().

            $fields->dataFieldByName('CSSSelector')
                ->setDescription('A valid CSS selector whose content is written to the "Target Field" above.')
                ->setAttribute('style', 'width: 300px;');
            $fields->dataFieldByName('ExcludeCSSSelector')
                ->setDescription('A list of valid CSS selectors whose content'
                . ' should be ignored. This is useful for fine-tuning what is returned in an import.'
                . ' Separate multiple exclusions with a newline.');
            $fields->dataFieldByName('OuterHTML')
                ->setDescription('Use outer HTML (Fetches parent element and content and that of its children)');
            $fields->dataFieldByName('PlainText')
                ->setDescription('Convert to plain text (Removes markup)');
        } else {
            $fields->replaceField('FieldName', $fieldName = ReadonlyField::create("FieldName", "Field Name"));
            $fieldName->setDescription('Save this rule before being able to add a field name');
        }

        $fields->dataFieldByName('Attribute')->setDescription('Add the element attribute where the desired text'
        . ' can be found (such as "alt" or "title") if not found as the selected element\'s text itself.');

        return $fields;

The expression return $fields returns the type SilverStripe\Forms\FieldList which is incompatible with the documented return type PhpTek\Exodus\Model\FieldList.

    }
}