AbstractChart.php

<?php


namespace RadiateCode\DaChartjs\Abstracts;

use RadiateCode\DaChartjs\Chart;

abstract class AbstractChart
{
    /**
     * Chart title
     *
     * ---------------------------------------------------------------------
     * Note: it can be use as chart id or chart name in js & html
     * ---------------------------------------------------------------------
     *
     * @return string
     */
    abstract protected function chartTitle(): string;

    /**
     * Chart type
     *
     * ---------------------------------------------------------------------
     * Note: Chart type must be concrete class of TypeInterface
     * ---------------------------------------------------------------------
     *
     * @return string
     */
    abstract protected function chartType(): string;

    /**
     * Chart labels
     *
     * ---------------------------------------------------------------------------------
     * Note: This labels are used to label the data index (default x axis) in the chart view
     * ---------------------------------------------------------------------------------
     *
     * @return array
     */
    abstract protected function labels(): array;

    /**
     * Dataset
     *
     * -------------------------------------------------------------------------------------------------
     * Note: datasets can be generate by Dataset Facade Or we can pass custom array with dataset properties,
     * -------------------------------------------------------------------------------------------------
     *
     * @return array
     */
    abstract protected function datasets(): array;

    /**
     * Chart size
     *
     * [Note: Set height and width. Width can be optional when we want responsive chart]
     * @return array
     */
    protected function chartSize(): array
    {
        return [];
    }

    /**
     * change default options
     *
     * ---------------------------------------------------------------------------------------------
     * Note: Each type of chart has default options, we can use this method
     * when we need to modify those default options
     * ---------------------------------------------------------------------------------------------
     *
     * @return array
     */
    protected function changeDefaultOptions(): array
    {
        return [];
    }

    /**
     * Custom options
     *
     * ---------------------------------------------------------------------------------------------
     * Note: If we don't want to use the default, then this methods can be useful for custom options
     * ---------------------------------------------------------------------------------------------
     *
     * @return array|string
     */
    protected function options()
    {
        return [];
    }

    /**
     * Render the chart
     *
     * @return array
     */
    public function render(): array
    {
        return $this->chart()->render();
    }

    /**
     * Build the chart html & js scripts
     */
    public function template()
    {
        return $this->chart()->template();
    }


    /**
     * chart Config
     *
     * @return Chart
     */
    private function chart(): Chart
    {
        $chart = Chart::build($this->chartTitle(), $this->chartType());

        $optionModifications = $this->changeDefaultOptions();

        $chartSize = $this->chartSize();

        if ( ! empty($this->options())) {
            $chart->options($this->options());
        }

        if ( ! empty($optionModifications)) {
            foreach ($optionModifications as $key => $value) {
                $chart->changeDefaultOption($key, $value);
            }
        }

        if ( ! empty($chartSize)) {
            if (array_key_exists('height', $chartSize)) {
                $chart->size($chartSize['height']);
            }
            if (array_key_exists('height', $chartSize) && array_key_exists('width', $chartSize)) {
                $chart->size($chartSize['height'], $chartSize['width']);
            }
        }

        return $chart
            ->labels($this->labels())
            ->datasets($this->datasets());
    }
}