Class luya\admin\dashboard\ChartDashboardObject

All Classes | Properties | Methods
Inheritanceluya\admin\dashboard\ChartDashboardObject » luya\admin\dashboard\BaseDashboardObject » yii\base\BaseObject
Implementsluya\admin\base\DashboardObjectInterface, yii\base\Configurable
Available since version1.0.2
Source Code https://github.com/luyadev/luya-module-admin/blob/master/src/dashboard/ChartDashboardObject.php

ECharts library dashboard object.

The see all possible configuration options visit: https://echarts.apache.org/examples/en/index.html

Example usage:

public $dashboardObjects = [
    [
       'class' => 'luya\admin\dashboard\ChartDashboardObject',
       'dataApiUrl' => 'admin/api-addressbook-contact/sale',
       'title' => 'Echart'
    ]
];

Doughnut echarts (https://echarts.apache.org/examples/en/editor.html?c=pie-doughnut) example response:

public function actionSale()
{
    return [
   	'tooltip' => ['trigger' => 'item', 'formatter' => '{b}: {c} million ({d}%)'],
   	'legend' => ['orient' => 'vertical', 'x' => 'left', 'data' => ['Asia', 'Africa', 'America', 'Europe', 'Oceania']],
   	'series' => [
   		[
   			'name' => "Continent",
   			'type' => 'pie',
   			'radius' => ['50%', '70%'],
   			'avoidLabelOverlap' => false,
   			'labelLine' => ['normal' => ['show' => false]],
   			'label' => [
   				'normal' => ['show' => false, 'position' => 'center'],
   				'emphasis' => [
   					'show' => true,
   					'textStyle' => [
   						'fontSize' => '30',
   						'fontWeight' => 'bold'
   					]
   				]
   			],
   			'data' => [
   				['value' => 4437, 'name' => 'Asia'],
   				['value' => 1203, 'name' => 'Africa'],
   				['value' => 997, 'name' => 'America'],
  				['value' => 740, 'name' => 'Europe'],
   				['value' => 40, 'name' => 'Oceania'],
   			]
   		]
   	]
   ];
}

An API response example for a line diagram:

return [
   'xAxis' => ['type' => 'category', 'boundaryGap' => false, 'data' => ['Jan', 'Feb', 'March']],
   'yAxis' => ['type' => 'value'],
   'series' => [
       'data' => [100,200,125],
   	 'type' => 'line',
    ]
];

Read more about echarts: https://github.com/apache/echarts

Public Properties

Hide inherited properties

Property Type Description Defined By
$dataApiUrl string luya\admin\dashboard\BaseDashboardObject
$outerTemplate string luya\admin\dashboard\ChartDashboardObject
$outerTemplateContent string luya\admin\dashboard\BaseDashboardObject
$template string luya\admin\dashboard\BaseDashboardObject
$title string luya\admin\dashboard\BaseDashboardObject
$variables array An array with key and value, where the key is what is available in the template. luya\admin\dashboard\BaseDashboardObject
$wrapperOptions array Options to generate the wrapper element. luya\admin\dashboard\ChartDashboardObject

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
contentParser() Parse the content will replace {{dataApiUrl}}, {{title}}, {{template}} variables with the content from the object. luya\admin\dashboard\BaseDashboardObject
getDataApiUrl() Get the API Url. luya\admin\dashboard\BaseDashboardObject
getOuterTemplate() Get outer Template for echarts luya\admin\dashboard\ChartDashboardObject
getOuterTemplateContent() Get the Outer Template. luya\admin\dashboard\ChartDashboardObject
getTemplate() Returns the template string. luya\admin\dashboard\BaseDashboardObject
getTitle() Get the Title. luya\admin\dashboard\BaseDashboardObject
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
setDataApiUrl() Setter methdo for dataApiUrl. luya\admin\dashboard\BaseDashboardObject
setTemplate() Setter method for template. luya\admin\dashboard\BaseDashboardObject
setTitle() Setter method for title. luya\admin\dashboard\BaseDashboardObject

Protected Methods

Hide inherited methods

Method Description Defined By
generateUniqueId() luya\admin\dashboard\ChartDashboardObject

Property Details

Hide inherited properties

$outerTemplate public read-only property
public string getOuterTemplate ( )
$wrapperOptions public property

Options to generate the wrapper element. Generates a tag like:

<div class="card-panel" ng-controller="DefaultDashboardObjectController" ng-init="loadData(\'{{dataApiUrl}}\');">
    <!-- content from: $outerTemplate -->
</div>

The tag element <div> can be changed by overriding the key tag.

public array $wrapperOptions = [
    'class' => 'card',
    'tag' => 'div',
]

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name
$params array

Method parameters
return mixed

The method return value
throws yii\base\UnknownMethodException

when calling unknown method

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name
$value mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is read-only

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

                public static function className()
{
    return get_called_class();
}
contentParser() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::contentParser()

Parse the content will replace {{dataApiUrl}}, {{title}}, {{template}} variables with the content from the object.

public string contentParser ( $content )
$content string

The content to parse.

 

                public function contentParser($content)
{
    $customVars = [];
    foreach ($this->variables as $key => $value) {
        if (is_array($value)) {
            [$category, $message] = $value;
            $customVars[$key] = Yii::t($category, $message);
        } else {
            $customVars[$key] = is_callable($value) ? call_user_func($value, $content, $this) : $value;
        }
    }
    $vars = [
        'dataApiUrl' => $this->getDataApiUrl(),
        'title' => $this->getTitle(),
        'template' => StringHelper::template($this->_template, $customVars, false),
    ];
    return StringHelper::template($content, array_merge($vars, $customVars), true);
}
generateUniqueId() protected method

protected string generateUniqueId ( )
return string

An unique string.

 

                protected function generateUniqueId()
{
    return md5(get_class($this) . $this->getTitle() . uniqid());
}
getDataApiUrl() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::getDataApiUrl()

Get the API Url.

public string getDataApiUrl ( )
return string

Returns the api url where the dashboard object collect its data from, which then will be injected into the template in order to render.

 

                public function getDataApiUrl()
{
    return $this->_dataApiUrl;
}
getOuterTemplate() public method

Get outer Template for echarts

<div class="card-header"><h4>{{title}}<h4></div>
<echarts id="charts_'.$uniqid.'" legend="legend" data="data"></echarts>

The variables

  • {{title}}
  • {{dataApiUrl}}

Will be automatically parsed to its original input while rendering.

public string getOuterTemplate ( )

                public function getOuterTemplate()
{
    return '<div class="card-header">{{title}}</div><div class="card-body"><echarts id="charts_'.$this->generateUniqueId().'" data="data"></echarts></div>';
}
getOuterTemplateContent() public method

Get the Outer Template.

The outer is mainly a wrapper which wraps the template. As the template is the input from the module property, it has to wrappe into a nice looking crad panel by default. But this is only used when dealing with base dashboard implementation.

public string getOuterTemplateContent ( )
return string

Returns the outer template string which can contain the {{template}} variable, but don't have to.

 

                public function getOuterTemplateContent()
{
    $options = ArrayHelper::merge([
        'ng-controller' => 'DefaultDashboardObjectController',
        'ng-init' => 'loadData(\'{{dataApiUrl}}\')'], $this->wrapperOptions);
    return Html::tag(ArrayHelper::remove($this->wrapperOptions, 'tag', 'div'), $this->getOuterTemplate(), $options);
}
getTemplate() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::getTemplate()

Returns the template string.

The string is an angular template which can contain angular conditions like ng-repeat, ng-if, etc.

public string getTemplate ( )
return string

The angular template.

 

                public function getTemplate()
{
    return $this->contentParser($this->getOuterTemplateContent());
}
getTitle() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::getTitle()

Get the Title.

public string getTitle ( )
return string

Returns the title of the current dashboard item, like "last logins" etc.

 

                public function getTitle()
{
    return $this->_title;
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}
setDataApiUrl() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::setDataApiUrl()

Setter methdo for dataApiUrl.

public void setDataApiUrl ( $dataApiUrl )
$dataApiUrl string 

                public function setDataApiUrl($dataApiUrl)
{
    $this->_dataApiUrl = $dataApiUrl;
}
setTemplate() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::setTemplate()

Setter method for template.

public void setTemplate ( $template )
$template string 

                public function setTemplate($template)
{
    $this->_template = $template;
}
setTitle() public method

Defined in: luya\admin\dashboard\BaseDashboardObject::setTitle()

Setter method for title.

The title can be either a string on array, if an array is provided the first key is used to defined the yii2 message category and second key is used in order to find the message. For example the input array ['cmsadmin', 'mytitle'] would be converted to Yii::t('cmsadmin', 'mytitle').

public void setTitle ( $title )
$title string|array

The title of the dashboard object item, if an array is given the first element is the translation category the second element the message.

 

                public function setTitle($title)
{
    if (is_array($title)) {
        [$category, $message] = $title;
        $this->_title =  Yii::t($category, $message);
    } else {
        $this->_title = $title;
    }
}