VojtaSvoboda\Brands\Components\Letters

Complexity

Total Complexity

8

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	componentDetails()	0	7	1
A	defineProperties()	0	11	1
A	onRun()	0	4	1
A	getBrandsPageOptions()	0	4	1
B	getBrandCharacters()	0	33	4

<?php namespace VojtaSvoboda\Brands\Components;

use Cms\Classes\ComponentBase;
use Cms\Classes\Page;
use VojtaSvoboda\Brands\Models\Brand as Model;

class Letters extends ComponentBase
{
    public $characters;

    public function componentDetails()
    {
        return [
            'name' => 'Brand letters',
            'description' => 'Show all starting letters to filtrate brands.',
        ];
    }

    public function defineProperties()
    {
        return [
            'brandsPage' => [
                'title' => 'Brands page',
                'description' => 'Page for showing brands',
                'type' => 'dropdown',
                'default' => 'brands',
            ],
        ];
    }

    public function onRun()
    {
        $this->page['characters'] = $this->characters = $this->getBrandCharacters();
    }

    /**
     * Get sorted list of brand letters.
     *
     * @return array
     */
    public function getBrandCharacters()
    {
        // get unique letters
        $letters = [];
        Model::all()->each(function($brand) use (&$letters)
        {
            // get letter
            $letter = mb_strtolower(mb_substr($brand->name, 0, 1));

            // init array when doesn't exists
            if (!isset($letters[$letter])) {
                $letters[$letter] = [
                    'name' => $letter,
                    'count' => 0,
                    'url' => $this->controller->pageUrl($this->property('brandsPage'), [
                        'letter' => $letter,
                    ]),
                ];
            }
            $letters[$letter]['count']++;
        });

        // sort them
        usort($letters, function($a, $b) {
            if ($a['name'] == $b['name']) {
                return 0;
            }

            return $a['name'] > $b['name'] ? 1 : -1;
        });

        return $letters;
    }

    /**
     * Get options for the dropdown where the link to the brand page can be selected.
     *
     * @return array
     */
    public function getBrandsPageOptions()
    {
        return Page::sortBy('baseFileName')->lists('baseFileName', 'baseFileName');
    }
}