sunnysideup / silverstripe-health-check-provider

src/Model/HealthCheckItemProvider.php

<?php

namespace Sunnysideup\HealthCheckProvider\Model;

use Exception;
use SilverStripe\Core\ClassInfo;

use SilverStripe\Core\Injector\Injector;

use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\Filters\ExactMatchFilter;
use SilverStripe\ORM\Filters\PartialMatchFilter;

use Sunnysideup\HealthCheckProvider\Checks\HealthCheckItemRunner;

class HealthCheckItemProvider extends DataObject
{
    protected $runner;

    #######################
    ### Names Section
    #######################

    private static $singular_name = 'Piece of Info';

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

    private static $plural_name = 'Pieces of Info';

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

    private static $table_name = 'HealthCheckItemProvider';

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

    #######################
    ### Model Section
    #######################

    private static $belongs_many_many = [

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

        'HealthCheckProviders' => HealthCheckProvider::class,
    ];

    private static $db = [

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

        'Include' => 'Boolean',
        'RunnerClassName' => 'Varchar(255)',
    ];

    #######################
    ### Further DB Field Details
    #######################

    private static $defaults = [

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

        'Include' => false,
    ];

    private static $searchable_fields = [

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

        'Include' => ExactMatchFilter::class,
        'RunnerClassName' => PartialMatchFilter::class,
    ];

    #######################
    ### Field Names and Presentation Section
    #######################

    private static $field_labels = [

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

        'Include' => 'Are you happy to send this?',
        'RunnerClassName' => 'Code',
        'HealthCheckProviders' => 'Reports',
    ];

    private static $summary_fields = [

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

        'CodeNice' => 'Code',
        'Include.Nice' => 'Include',
        'AnswerSummary' => 'Data',
    ];

    #######################
    ### Casting Section
    #######################

    private static $casting = [

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

        'AnswerSummary' => 'HTMLText',
        'AnswerAll' => 'HTMLText',
        'Title' => 'Varchar',
        'Code' => 'Varchar',
        'CodeNice' => 'Varchar',
    ];

    public function getTitle()
    {
        return DBField::create_field('HTMLText', $this->getCode());
    }

    public function getCode(): string
    {
        if (class_exists($this->RunnerClassName)) {

The property RunnerClassName does not exist on Sunnysideup\HealthCheckProvider\Model\HealthCheckItemProvider. Since you implemented __get, consider adding a @property annotation.

It seems like $this->RunnerClassName can also be of type null; however, parameter $class of class_exists() does only seem to accept string, maybe add an additional type check?

            return ClassInfo::shortName($this->RunnerClassName);
        }
        return 'error';
    }

    public function getCodeNice(): string
    {
        return preg_replace('#([a-z])([A-Z])#s', '$1 $2', $this->getCode());
    }

    public function getAnswerAll()
    {
        $data = $this->findAnswer();

        return DBField::create_field('HTMLText', '<pre>' . json_encode($data, JSON_PRETTY_PRINT) . '</pre>');
    }

    public function getAnswerSummary()
    {
        $data = $this->findAnswer();
        $data = $this->summariseData($data);

        return DBField::create_field('HTMLText', '<pre>' . json_encode($data, JSON_PRETTY_PRINT) . '</pre>');
    }

    #######################
    ### can Section
    #######################

    public function canCreate($member = null, $context = null)
    {
        return false;
    }

    public function canDelete($member = null)
    {
        return class_exists($this->RunnerClassName) ? false : parent::canDelete($member);

The property RunnerClassName does not exist on Sunnysideup\HealthCheckProvider\Model\HealthCheckItemProvider. Since you implemented __get, consider adding a @property annotation.

It seems like $this->RunnerClassName can also be of type null; however, parameter $class of class_exists() does only seem to accept string, maybe add an additional type check?

    }

    #######################
    ### write Section
    #######################

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        foreach (HealthCheckItemProvider::get() as $item) {
            if (! class_exists($item->RunnerClassName)) {
                DB::alteration_message('Deleting superfluous: ' . $item->RunnerClassName, 'deleted');
                $item->delete();
            }
        }

        $classes = ClassInfo::subclassesFor(HealthCheckItemRunner::class, false);
        $ids = [0 => 0];
        foreach ($classes as $className) {
            $filter = ['RunnerClassName' => $className];
            $obj = DataObject::get_one(HealthCheckItemProvider::class, $filter);
            if (! $obj) {
                $obj = HealthCheckItemProvider::create($filter);
                DB::alteration_message('Creating Health Check: ' . $obj->getTitle(), 'created');
            }
            $id = $obj->write();
            if (! $id) {
                $id = $obj->ID;
            }
            $ids[$id] = $id;
        }
        $badOnes = HealthCheckItemProvider::get()->where('HealthCheckItemProvider.ID NOT IN (' . implode(',', $ids) . ')');
        foreach ($badOnes as $badOne) {
            DB::alteration_message('Deleting superfluous: ' . $badOne->getTitle(), 'deleted');
            $badOne->delete();
        }
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName('HealthCheckProviders');
        $fields->removeByName('RunnerClassName');
        $fields->addFieldsToTab(
            'Root.Main',
            [
                ReadonlyField::create('CodeNice', 'Code'),
                ReadonlyField::create('AnswerAll', 'Answer'),
            ]
        );

        return $fields;
    }

    public function getRunner()
    {
        if (! $this->runner) {
            $class = $this->RunnerClassName;

The property RunnerClassName does not exist on Sunnysideup\HealthCheckProvider\Model\HealthCheckItemProvider. Since you implemented __get, consider adding a @property annotation.

            if (class_exists($class)) {

It seems like $class can also be of type null; however, parameter $class of class_exists() does only seem to accept string, maybe add an additional type check?

                $this->runner = Injector::inst()->get($this->RunnerClassName, $asSingleton = true, [$this]);
            }
        }
        return $this->runner;
    }

    public function findAnswer(): array
    {
        $answer = 'error';
        $isInstalled = false;
        $isEnabled = false;
        if ($this->getRunner()) {
            try {
                $answer = $this->getRunner()->getCalculatedAnswer();
                $isInstalled = $this->getRunner()->IsInstalled();
                $isEnabled = $this->getRunner()->IsEnabled();
            } catch (Exception $exception) {
                $answer = 'Caught exception: ' . $exception->getMessage();
            }
        }
        return [
            'Answer' => $answer,
            'IsInstalled' => $isInstalled,
            'IsEnabled' => $isEnabled,
        ];
    }

    private function summariseData($mixed)
    {
        if (is_string($mixed)) {
            if (strlen($mixed) > 50) {
                return substr($mixed, 0, 50) . '...';
            }
        } elseif (is_array($mixed)) {
            $returnArray = [];
            $count = 0;
            foreach ($mixed as $key => $item) {
                ++$count;
                $returnArray[$this->summariseData($key)] = $this->summariseData($item);
                if ($count > 3) {
                    $returnArray[] = ' + ' . count($mixed) . ' MORE ...';
                    break;
                }
            }
            return $returnArray;
        }
        return $mixed;
    }
}