dynamic / silverstripe-elemental-testimonials

src/Elements/ElementTestimonials.php

<?php

namespace Dynamic\Elements\Elements;

use DNADesign\Elemental\Models\BaseElement;
use Dynamic\Elements\Model\Testimonial;
use Dynamic\Elements\Model\TestimonialCategory;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\ListboxField;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\FieldType\DBField;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;

/**
 * Class ElementTestimonials
 * @package Dynamic\Elements\Elements
 *
 * @property int $Limit
 * @property string $Content
 */
class ElementTestimonials extends BaseElement
{
    /**
     * @var string
     */
    private static $icon = 'font-icon-chat';

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

    /**
     * @var string
     */
    private static $singular_name = 'Testimonials Element';

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

    /**
     * @var string
     */
    private static $plural_name = 'Testimonials Elements';

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

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

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.

        'Limit' => 'Int',
        'Content' => 'HTMLText',
    ];

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

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

        'TestimonialCategories' => TestimonialCategory::class,
    ];

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

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

        'Limit' => 3,
    ];

    /**
     * @return DBHTMLText

The type Dynamic\Elements\Elements\DBHTMLText was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getSummary()
    {
        if ($this->TestimonialCategories()->count() > 0) {

The method TestimonialCategories() does not exist on Dynamic\Elements\Elements\ElementTestimonials. Since you implemented __call, consider adding a @method annotation.

            $ct = 0;
            foreach ($this->TestimonialCategories() as $category) {
                $ct += $category->Testimonials()->count();
            }
            if ($ct == 1) {

The condition $ct == 1 is always false.

                $label = ' testimonial';
            } else {
                $label = ' testimonials';
            }
            return DBField::create_field(
                'HTMLText',
                $ct . $label
            )->Summary(20);
        }
    }

    /**
     * @return array
     */
    protected function provideBlockSchema()
    {
        $blockSchema = parent::provideBlockSchema();
        $blockSchema['content'] = $this->getSummary();
        return $blockSchema;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return _t(__CLASS__ . '.BlockType', 'Testimonials');
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            $fields->dataFieldByName('Content')
                ->setRows(8);

            $fields->dataFieldByName('Limit')
                ->setTitle('Number of testimonials to show');

            if ($this->exists()) {
                $fields->removeByName([
                    'TestimonialCategories'
                ]);

                $fields->addFieldToTab('Root.Main',
                    'Limit',

'Limit' of type string is incompatible with the type SilverStripe\Forms\FormField expected by parameter $field of SilverStripe\Forms\FieldList::addFieldToTab().

                    ListboxField::create(
                        'TestimonialCategories',
                        'Categories',
                        TestimonialCategory::get()->map()->toArray()
                    )
                );
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return mixed
     */
    public function getTestimonialsList()
    {
        $random = DB::get_conn()->random();
        $testimonials = Testimonial::get();

        $categories = $this->TestimonialCategories();
        if ($categories->count() > 0) {
            $testimonials = $testimonials->filterAny(['TestimonialCategories.ID' => $categories->column()]);
        }

        $testimonials = $testimonials->sort($random);
        if (0 < $this->Limit) {
            $testimonials = $testimonials->limit($this->Limit);
        }

        return $testimonials;
    }
}