phptek / silverstripe-exodus

src/Model/StaticSiteImportDataObject.php

<?php

namespace PhpTek\Exodus\Model;

use PhpTek\Exodus\Model\FailedURLRewriteObject;
use PhpTek\Exodus\Model\FailedURLRewriteSummary;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

/**
 * Caches some metadata for each import. Allows imports to have a DataObject-like functionality.
 *
 * @author Russell Michell <russ@theruss.com>
 * @package phptek/silverstripe-exodus
 * @see {@link StaticSiteImporter}
 */
class StaticSiteImportDataObject extends DataObject
{
    use Injectable;

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

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

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

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

        'Ended' => DBDatetime::class,
    ];

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

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

        'User' => Member::class,
    ];

    /**
     * Get the most recently started/run import.
     *
     * @param Member $member
     * @return null | DataList

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

     */
    public static function current($member = null)
    {
        $import = StaticSiteImportDataObject::get()
                ->sort('Created')
                ->last();

        if ($import && $member) {
            return $import->filter('UserID', $member->ID);
        }

        return $import;

The expression return $import also could return the type SilverStripe\ORM\DataObject which is incompatible with the documented return type PhpTek\Exodus\Model\DataList|null.

    }

    /**
     * To be called at the start of an import.
     *
     * @return StaticSiteImportDataObject
     */
    public function start()
    {
        $this->UserID = Security::getCurrentUser()->getField('ID');

The property UserID does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->write();

        return $this;
    }

    /**
     * To be called at the end of an import.
     *
     * @return StaticSiteImportDataObject
     */
    public function end()
    {
        $this->Ended = DBDatetime::now()->getValue();

The property Ended does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->write();

        return $this;
    }

    /**
     * Make sure related FailedURLRewriteObject's are also removed
     *
     * @todo Would belongs_to() do the job?
     * @return void
     */
    public function onAfterDelete()
    {
        parent::onAfterDelete();

        $relatedFailedRewriteObjects = DataObject::get(FailedURLRewriteObject::class)->filter('ImportID', $this->ID);
        $relatedFailedRewriteSummaries = DataObject::get(FailedURLRewriteSummary::class)->filter('ImportID', $this->ID);

        $relatedFailedRewriteObjects->each(function ($item) {
            $item->delete();
        });

        $relatedFailedRewriteSummaries->each(function ($item) {
            $item->delete();
        });
    }
}