sunnysideup / silverstripe-health-check-provider

src/Model/HealthCheckProvider.php

<?php

namespace Sunnysideup\HealthCheckProvider\Model;

use SilverStripe\Control\Director;
use SilverStripe\Forms\CheckboxSetField;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\HTMLReadonlyField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

class HealthCheckProvider extends DataObject
{
    /**
     * @var string
     */
    private const VIEW_URL = 'https://check.silverstripe-webdevelopment.com/report/view/';

    /**
     * @var string
     */
    private const NOT_PROVIDED_PHRASE = 'not provided';

    protected $cacheForData = [];

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

    private static $singular_name = 'Report';

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

    private static $plural_name = 'Reports';

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

    private static $table_name = 'HealthCheckProvider';

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

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

    private static $db = [

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

        'MainUrl' => 'Varchar(255)',
        'OtherUrls' => 'Text',
        'SendNow' => 'Boolean',
        'Sent' => 'Boolean',
        'SendCode' => 'Varchar(125)',
        'ResponseCode' => 'Varchar(125)',
        'HasError' => 'Boolean',
        'Data' => 'Text',
    ];

    private static $has_one = [

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

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

    private static $many_many = [

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

        'HealthCheckItemProviders' => HealthCheckItemProvider::class,
    ];

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

    private static $indexes = [

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

        'SendCode' => true,
        'ResponseCode' => true,
    ];

    private static $default_sort = [

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

        'Created' => 'DESC',
    ];

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

    private static $field_labels = [

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

        'SendNow' => 'Send now?',
        'Sent' => 'Has been sent',
        'HealthCheckItemProviders' => 'Pieces of Info',
    ];

    private static $summary_fields = [

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

        'Title' => 'Health Report Data',
        'Sent.Nice' => 'Sent',
        'HasError.Nice' => 'Error',
        'Editor.Title' => 'Editor',
    ];

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

    private static $casting = [

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

        'Title' => 'Varchar',
    ];

    private $checkLoop = 0;

    /**
     * casted variable
     */
    public function getTitle(): string
    {
        $str = 'Health Check for ' . $this->MainUrl;
        if ($this->Sent) {

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

            $str .= '; Sent on ' . $this->dbObject('LastEdited')->Nice();
        } else {
            $str .= '; Not sent yet';
        }
        return $str;
    }

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

    public function canDelete($member = null)
    {
        if ($this->Sent) {

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

            return false;
        }
        return parent::canDelete($member);
    }

    public function canEdit($member = null)
    {
        if ($this->Sent) {

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

            return false;
        }
        return parent::canEdit($member);
    }

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

    protected function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if (! $this->EditorID) {
            $user = Security::getCurrentUser();
            if ($user) {

$user is of type SilverStripe\Security\Member, thus it always evaluated to true.

                $this->EditorID = Security::getCurrentUser()->ID;

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

            }
        }
        if (! $this->MainUrl) {
            $this->MainUrl = $this->getSiteURL();

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

        }
        if ($this->Sent) {

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

            $this->HasError = !$this->getCodesMatch();

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

        }
    }

    public function getCodesMatch(): bool
    {
        if ($this->Sent) {

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

            return $this->SendCode === $this->ResponseCode;

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

        }
        return true;
    }

    protected function onAfterWrite()
    {
        parent::onAfterWrite();

        if ($this->checkLoop < 3) {
            ++$this->checkLoop;
            if (! $this->SendCode) {
                foreach (HealthCheckItemProvider::get()->filter(['Include' => true]) as $item) {
                    $this->HealthCheckItemProviders()->add($item);

The method HealthCheckItemProviders() does not exist on Sunnysideup\HealthCheckProvider\Model\HealthCheckProvider. Since you implemented __call, consider adding a @method annotation.

                }
                $data = $this->retrieveDataInnerInner();
                if (count($data)) {
                    //send code first because included in data.
                    $this->SendCode = $this->createSendCode();

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

                    //create data.
                    $this->Data = json_encode($this->retrieveDataInner());

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

                    //loop
                    $this->write();
                }
            }
        }
    }

    #######################
    ### CMS Edit Section
    #######################

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->MainUrl = $this->getSiteURL();

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

        return $this;
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName(
            [
                'SendCode',
                'SendNow',
                'ResponseCode',
                'Sent',
                'Data',
                'EditorID',
            ]
        );
        if ($this->exists()) {
            $fields->removeByName(
                [
                    'HealthCheckItemProviders',
                ]
            );
            if ($this->Sent) {

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

                $viewLink = $this->ViewLink();
                if ($viewLink) {
                    $fields->addFieldsToTab(
                        'Root.Main',
                        [
                            HTMLReadonlyField::create(
                                'Link',
                                'Open report',
                                '<a href="' . $viewLink . '">View Link</a>'
                            ),
                        ]
                    );
                }
            } else {
                $fields->removeByName(
                    [
                        'HasError',
                    ]
                );
                $fields->addFieldsToTab(
                    'Root.Main',
                    [
                        CheckboxSetField::create(
                            'HealthCheckItemProviders',
                            'Data Points to be Provided',
                            HealthCheckItemProvider::get()->filter(['Include' => true])->map('ID', 'CodeNice')
                        )->setDescription('Please untick any data that you prefer not to provide.'),
                    ]
                );
            }
            $fields->addFieldsToTab(
                'Root.Main',
                [
                    TextField::create('MainUrl', 'Main URL'),
                    TextField::create('MainUrl', 'Main URL'),
                    TextField::create('OtherUrls', 'Other Urls')
                        ->setDescription('Separate by comma - e.g. new.mysite.com, otherurl.com, etc ...'),
                    ReadonlyField::create('HasBeenSent', 'Sent', $this->dbObject('Sent')->Nice()),
                    ReadonlyField::create('Editor Email', 'Editor Email', $this->Editor()->Email),

The method Editor() does not exist on Sunnysideup\HealthCheckProvider\Model\HealthCheckProvider. Since you implemented __call, consider adding a @method annotation.

                    ReadonlyField::create('LastEdited'),
                ]
            );
            $fields->addFieldsToTab(
                'Root.Output',
                [
                    ReadonlyField::create('SendCode'),
                    ReadonlyField::create('ResponseCode'),
                    LiteralField::create(
                        'Output',
                        '<h2>Data</h2><pre>' . json_encode(json_decode($this->Data), JSON_PRETTY_PRINT) . '</pre>'
                    ),
                ]
            );
            $fields->addFieldsToTab(
                'Root.PiecesOfInfo',
                [
                    GridField::create(
                        'HealthCheckItemProvidersList',
                        'Data List',
                        HealthCheckItemProvider::get(),
                        GridFieldConfig_RecordEditor::create()
                    ),
                ]
            );
        } else {
            $fields->removeByName(
                [
                    'HasError',
                ]
            );
        }
        return $fields;
    }

    public function ViewLink()
    {
        if ($this->ResponseCode) {

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

            return self::VIEW_URL . $this->ResponseCode . '/';
        }
    }

    protected function hasAnswers(): bool
    {
        return (int) $this->HealthCheckItemProviders()->count() > 0;
    }

    protected function createSendCode(): string
    {
        $array = $this->retrieveDataInnerInner();
        $serialized = serialize($array);

        return hash('ripemd160', $this->ID . $serialized);
    }

    /**
     * Return the host website URL
     * @return string             URL of the host website
     */
    protected function getSiteURL(): string
    {
        $base = Director::host();

        return rtrim($base, '/');
    }

    #######################
    ### Calculations
    #######################

    protected function retrieveDataInner(): array
    {
        return [
            'ID' => $this->ID,
            'SendCode' => $this->SendCode,
            'MainUrl' => $this->MainUrl,
            'OtherUrls' => $this->OtherUrls,

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

            'Editor' => [
                'Email' => $this->Editor()->Email,
                'FirstName' => $this->Editor()->FirstName,
                'Surname' => $this->Editor()->Surname,
            ],
            'Data' => $this->retrieveDataInnerInner(),
        ];
    }

    protected function retrieveDataInnerInner(): array
    {
        if (count($this->cacheForData) === 0) {
            $this->cacheForData = [];
            $includeIDList = $this->HealthCheckItemProviders()
                ->filter(['Include' => true])
                ->column('ID');
            $list = HealthCheckItemProvider::get();
            foreach ($list as $item) {
                $shortName = $item->getCode();
                if (in_array($item->ID, $includeIDList, false)) {
                    $this->cacheForData[$shortName] = $item->findAnswer($this);
                } else {
                    $this->cacheForData[$shortName] = SELF::NOT_PROVIDED_PHRASE;
                }
            }
        }

        return $this->cacheForData;
    }
}