silverstripe / silverstripe-ckan-registry

src/Model/Resource.php

<?php

namespace SilverStripe\CKANRegistry\Model;

use SilverStripe\CKANRegistry\Service\ResourcePopulatorInterface;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\HasManyList;

/**
 * A CKAN Resource that belongs to a DataSet/Package, as to be accessed via the CKAN API.
 *
 * @property string Name
 * @property string ResourceName
 * @property string Endpoint
 * @property string DataSet
 * @property string Identifier
 * @method HasManyList Fields
 * @method HasManyList Filters
 */
class Resource extends DataObject
{
    private static $table_name = 'CKANResource';

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

    private static $db = [

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

        'Name' => 'Varchar',
        'ResourceName' => 'Varchar',
        'Endpoint' => 'Varchar',
        'DataSet' => 'Varchar',
        'Identifier' => 'Varchar',
        'ItemsPerPage' => 'Int',
    ];

    private static $has_many = [

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

        'Fields' => ResourceField::class,
        'Filters' => ResourceFilter::class,
    ];

    private static $defaults = [

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

        'ItemsPerPage' => 30,
    ];

    /**
     * Whenever the CKAN resource identifier is changed we should clear any existing field and filter configurations
     *
     * {@inheritdoc}
     */
    public function onAfterWrite()
    {
        if ($this->Identifier && $this->isChanged('Identifier')) {
            $this->Fields()->each(function (ResourceField $field) {
                $field->delete();
            });

            /** @var ResourcePopulatorInterface $populator */
            $populator = Injector::inst()->get(ResourcePopulatorInterface::class);
            $populator->populateFields($this);

            // Remove the existing filters and add a default text entry to search all ResourceFields
            $this->Filters()
                ->each(function (ResourceFilter $filter) {
                    $filter->delete();
                })
                ->add(ResourceFilter::create([
                    'FilterLabel' => _t(self::class . '.DEFAULT_FILTER_LABEL', 'Search'),
                ]));
        }

        parent::onAfterWrite();
    }

    /**
     * Whenever the CKAN resource identifier is changed, populate a new set of metadata for the new resource
     *
     * {@inheritdoc}
     */
    public function onBeforeWrite()
    {
        if ($this->Identifier && $this->isChanged('Identifier')) {
            /** @var ResourcePopulatorInterface $populator */
            $populator = Injector::inst()->get(ResourcePopulatorInterface::class);
            $populator->populateMetadata($this);
        }

        parent::onBeforeWrite();
    }
}