silverstripe / silverstripe-blog

src/Widgets/BlogTagsWidget.php

<?php

namespace SilverStripe\Blog\Widgets;

use SilverStripe\Blog\Model\Blog;
use SilverStripe\Core\Convert;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\NumericField;
use SilverStripe\ORM\DataList;
use SilverStripe\Widgets\Model\Widget;

if (!class_exists(Widget::class)) {
    return;
}

/**
 * @method Blog Blog()
 */
class BlogTagsWidget extends Widget
{
    /**
     * @var string
     */
    private static $title = 'Tags';

    /**
     * @var string
     */
    private static $cmsTitle = 'Blog Tags';

    /**
     * @var string
     */
    private static $description = 'Displays a list of blog tags.';

    /**
     * @var array
     */
    private static $db = [
        'Limit' => 'Int',
        'Order' => 'Varchar',
        'Direction' => 'Varchar',
    ];

    /**
     * @var array
     */
    private static $has_one = [
        'Blog' => Blog::class
    ];

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

    /**
     * {@inheritdoc}
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (Fieldlist $fields) {
            $fields[] = DropdownField::create(
                'BlogID',
                _t(__CLASS__ . '.Blog', 'Blog'),
                Blog::get()->map()
            );

            $fields[] = NumericField::create(
                'Limit',
                _t(__CLASS__ . '.Limit', 'Limit'),
                0
            )
                ->setDescription(
                    _t(
                        __CLASS__ . '.Limit_Description',
                        'Limit the number of tags shown by this widget (set to 0 to show all tags).'
                    )
                )
                ->setMaxLength(3);

            $fields[] = DropdownField::create(
                'Order',
                _t(__CLASS__ . '.Sort', 'Sort'),
                ['Title' => 'Title', 'Created' => 'Created', 'LastEdited' => 'Updated']
            )
                ->setDescription(
                    _t(__CLASS__ . '.Sort_Description', 'Change the order of tags shown by this widget.')
                );

            $fields[] = DropdownField::create(
                'Direction',
                _t(__CLASS__ . '.Direction', 'Direction'),
                ['ASC' => 'Ascending', 'DESC' => 'Descending']
            )
                ->setDescription(
                    _t(
                        __CLASS__ . '.Direction_Description',
                        'Change the direction of ordering of tags shown by this widget.'
                    )
                );
        });

        return parent::getCMSFields();
    }

    /**
     * @return DataList
     */
    public function getTags()
    {
        $blog = $this->Blog();

        if (!$blog) {
            return [];
        }

        $query = $blog->Tags();

        if ($this->Limit) {
            $query = $query->limit(Convert::raw2sql($this->Limit));

\SilverStripe\Core\Convert::raw2sql($this->Limit) is of type array|string, but the function expects a integer.

        }

        if ($this->Order && $this->Direction) {
            $query = $query->sort(Convert::raw2sql($this->Order), Convert::raw2sql($this->Direction));
        }

        return $query;
    }
}