Piwik\Widget\WidgetContainerConfig::setId PHP Method

setId() public method

The id can be used by any plugins to add more widgets to this container and it will be also used for the unique widget id and in the URL to render this widget.
public setId ( string $id ) : static
$id string eg 'Products' or 'Contents'
return static
    public function setId($id)
    {
        $this->id = $id;
        return $this;
    }

Usage Example

コード例 #1
0
ファイル: ReportWidgetFactory.php プロジェクト: piwik/piwik
 /**
  * Creates a new container widget based on the specified report in {@link construct()}.
  *
  * It will automatically use the report's categoryId, subcategoryId (if specified) and order in order to
  * create the container.
  *
  * @param string $containerId eg 'Products' or 'Contents' see {Piwik\Widget\WidgetContainerConfig::setId()}.
  *                            Other reports or widgets will be able to add more widgets to this container.
  *                            This is useful when you want to show for example multiple related widgets
  *                            together.
  * @return WidgetContainerConfig
  */
 public function createContainerWidget($containerId)
 {
     $widget = new WidgetContainerConfig();
     $widget->setCategoryId($this->report->getCategoryId());
     $widget->setId($containerId);
     if ($this->report->getSubcategoryId()) {
         $widget->setSubcategoryId($this->report->getSubcategoryId());
     }
     $orderThatListsReportsAtTheEndOfEachCategory = 100 + $this->report->getOrder();
     $widget->setOrder($orderThatListsReportsAtTheEndOfEachCategory);
     return $widget;
 }