silverstripe / silverstripe-externallinks

src/Model/BrokenExternalPageTrackStatus.php

<?php

namespace SilverStripe\ExternalLinks\Model;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\i18n\i18nEntityProvider;
use SilverStripe\Versioned\Versioned;
use SilverStripe\ORM\DataObject;

/**
 * Represents the status of a track run
 *
 * @method DataList TrackedPages()
 * @method DataList BrokenLinks()
 * @property int $TotalPages Get total pages count
 * @property int $CompletedPages Get completed pages count
 */
class BrokenExternalPageTrackStatus extends DataObject implements i18nEntityProvider
{
    private static $table_name = 'BrokenExternalPageTrackStatus';

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

    private static $db = array(

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

        'Status' => 'Enum("Completed, Running", "Running")',
        'JobInfo' => 'Varchar(255)'
    );

    private static $has_many = array(

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

        'TrackedPages' => BrokenExternalPageTrack::class,
        'BrokenLinks' => BrokenExternalLink::class
    );

    /**
     * Get the latest track status
     *
     * @return BrokenExternalPageTrackStatus
     */
    public static function get_latest()
    {
        return self::get()
            ->sort('ID', 'DESC')
            ->first();
    }

    /**
     * Returns the list of provided translations for this object
     *
     * @return array
     */
    public function provideI18nEntities()
    {
        return [
            __CLASS__ . '.SINGULARNAME' => 'Broken External Page Track Status',
            __CLASS__ . '.PLURALNAME' => 'Broken External Page Track Statuses',
            __CLASS__ . '.PLURALS' => [
              'one' => 'A Broken External Page Track Status',
              'other' => '{count} Broken External Page Track Statuses',
            ],
        ];
    }

    /**
     * Gets the list of Pages yet to be checked
     *
     * @return DataList

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

     */
    public function getIncompletePageList()
    {
        $pageIDs = $this
            ->getIncompleteTracks()
            ->column('PageID');
        if ($pageIDs) {
            return Versioned::get_by_stage(SiteTree::class, 'Stage')

The expression return SilverStripe\Versioned\Versioned::get_by_stage(SilverStripe\CMS\Model\SiteTree::class, 'Stage')->byIDs($pageIDs) returns the type SilverStripe\ORM\DataList which is incompatible with the documented return type SilverStripe\ExternalLinks\Model\DataList.

            ->byIDs($pageIDs);
        }
    }

    /**
     * Get the list of incomplete BrokenExternalPageTrack
     *
     * @return DataList
     */
    public function getIncompleteTracks()
    {
        return $this
            ->TrackedPages()
            ->filter('Processed', 0);
    }

    /**
     * Get total pages count
     *
     * @return int
     */
    public function getTotalPages()
    {
        return $this->TrackedPages()->count();
    }

    /**
     * Get completed pages count
     *
     * @return int
     */
    public function getCompletedPages()
    {
        return $this
            ->TrackedPages()
            ->filter('Processed', 1)
            ->count();
    }

    /**
     * Returns the latest run, or otherwise creates a new one
     *
     * @return BrokenExternalPageTrackStatus
     */
    public static function get_or_create()
    {
        // Check the current status
        $status = self::get_latest();
        if ($status && $status->Status == 'Running') {
            $status->updateStatus();
            return $status;
        }

        return self::create_status();
    }

    /**
     * Create and prepare a new status
     *
     * @return BrokenExternalPageTrackStatus
     */
    public static function create_status()
    {
        // If the script is to be started create a new status
        $status = self::create();
        $status->updateJobInfo('Creating new tracking object');

        // Setup all pages to test
        $pageIDs = Versioned::get_by_stage(SiteTree::class, 'Stage')
            ->column('ID');
        foreach ($pageIDs as $pageID) {
            $trackPage = BrokenExternalPageTrack::create();
            $trackPage->PageID = $pageID;
            $trackPage->StatusID = $status->ID;
            $trackPage->write();
        }

        return $status;
    }

    public function updateJobInfo($message)
    {
        $this->JobInfo = $message;

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

        $this->write();
    }

    /**
     * Self check status
     */
    public function updateStatus()
    {
        if ($this->CompletedPages == $this->TotalPages) {
            $this->Status = 'Completed';

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

            $this->updateJobInfo('Setting to completed');
        }
    }
}