bytic / models-smart-properties

src/Properties/AbstractProperty/Generic.php

<?php

namespace ByTIC\Models\SmartProperties\Properties\AbstractProperty;

use ByTIC\Models\SmartProperties\Workflow\State;
use Symfony\Component\Workflow\Definition;
use Symfony\Component\Workflow\Event\AnnounceEvent;
use Symfony\Component\Workflow\Marking;
use Symfony\Component\Workflow\Transition;
use Symfony\Component\Workflow\Workflow;

/**
 * Class Generic
 * @package ByTIC\Models\SmartProperties\Properties\AbstractProperty
 */
abstract class Generic extends State
{
    use Traits\HasItemTrait;
    use Traits\HasManagerTrait;
    use Traits\HasNameTrait;
    use Traits\HasTranslationTrait;

    /**
     * @var null|string
     */
    protected $field;

    /**
     * @param $name
     * @return null
     */
    public function __get($name)
    {
        $method = 'get' . ucfirst($name);
        if (method_exists($this, $method)) {
            return $this->$method();
        }

        return null;
    }

    /**
     * @param bool $short
     * @return string
     */
    public function getLabelHTML($short = false)
    {
        return '<span class="' . $this->getLabelClasses() . '" rel="tooltip" title="' . $this->getLabel() . '"  

Are you sure the usage of $this->getLabel() targeting ByTIC\Models\SmartProperties\Properties\AbstractProperty\Generic::getLabel() seems to always return null.

        style="' . $this->getColorCSS() . '">
            ' . $this->getIconHTML() . '
            ' . $this->getLabel($short) . '

Are you sure the usage of $this->getLabel($short) targeting ByTIC\Models\SmartProperties\Properties\AbstractProperty\Generic::getLabel() seems to always return null.

        </span>';
    }

    /**
     * get the label class name
     *
     * @return string
     */
    public function getLabelClasses(): string
    {
        return 'badge bg-' . $this->getColorClass() . ' badge-' . $this->getColorClass() . ' label label-' . $this->getColorClass();
    }

    /**
     * Get the color class
     *
     * @return string
     */
    public function getColorClass()
    {
        return 'dark';
    }


    /**
     * @return string
     */
    abstract protected function getLabelSlug();

    /**
     * @return boolean
     */
    protected function hasShortLabel()
    {
        return true;
    }

    /**
     * @return string
     */
    public function getColorCSS()
    {
        $css = [];
        if ($this->getBGColor()) {
            $css[] = 'background-color: ' . $this->getBGColor().' !important';
        }
        if ($this->getFGColor()) {
            $css[] = 'color: ' . $this->getFGColor().' !important';
        }

        return implode(';', $css);
    }

    /**
     * @return bool|string
     */
    public function getBGColor()
    {
        return false;
    }

    /**
     * @return bool|string
     */
    public function getFGColor()
    {
        return false;
    }

    /**
     * @return string
     */
    public function getIconHTML(): string
    {
        $icon = $this->getIcon();
        if (strpos($icon, 'glyphicon') !== false) {

$icon of type false is incompatible with the type string expected by parameter $haystack of strpos().

            return '<span class="glyphicon glyphicon-white ' . $icon . '"></span> ';

Are you sure $icon of type false can be used in concatenation?

        }
        if (strpos($icon, 'fas') === 0 || strpos($icon, 'far') === 0) {
            return '<i class="' . $icon . '"></i>';
        }
        if (strpos($icon, 'fa') === 0) {
            return '<i class="fas ' . $icon . '"></i>';
        }

        return '';
    }

    /**
     * @return bool|string
     */
    public function getIcon()
    {
        return false;
    }

    /**
     * @return bool|mixed
     */
    public function update()
    {
        $item = $this->getItem();
        if (!is_object($item)) {
            return false;
        }
        $this->preValueChange();

        $fromState = (string) $item->{$this->getField()};
        $toState = $this->getName();
        /** @noinspection PhpUndefinedFieldInspection */
        $item->{$this->getField()} = $toState;
        $this->preUpdate();
        $return = $item->saveRecord();

Are you sure the assignment to $return is correct as $item->saveRecord() targeting Nip\Records\AbstractModels\Record::saveRecord() seems to always return null.

It seems like saveRecord() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->postUpdate();

        $marking = new Marking();
        $initialTransition = new Transition('generic_transition', [$fromState], [$toState]);
        $workflow = new Workflow(new Definition([], []));
        $event = new AnnounceEvent($item, $marking, $initialTransition, $workflow, []);

        event($event);
        return $return;
    }

    public function preValueChange()
    {
    }

    /**
     * @return null|string
     */
    public function getField()
    {
        return $this->field;
    }

    /**
     * @param null|string $field
     */
    public function setField($field)
    {
        $this->field = $field;
    }

    public function preUpdate()
    {
    }

    public function postUpdate()
    {
    }

    /**
     * @return string
     */
    public function getMessageType()
    {
        return 'info';
    }

}