core/Plugin/Categories.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\Plugin;

use Piwik\Container\StaticContainer;
use Piwik\Piwik;
use Piwik\Plugin;

/**
 * Get categories and subcategories that are defined by plugins.
 */
class Categories
{
    private $pluginManager;

    public function __construct(Plugin\Manager $pluginManager)
    {
        $this->pluginManager = $pluginManager;
    }

    /** @return \Piwik\Category\Category[] */
    public function getAllCategories()
    {
        $categories = $this->pluginManager->findMultipleComponents('Categories', '\\Piwik\\Category\\Category');

        $instances = array();
        foreach ($categories as $category) {
            $cat = StaticContainer::getContainer()->make($category);
            $instances[$cat->getId()] = $cat;
        }

        return $instances;
    }

    /** @return \Piwik\Category\Subcategory[] */
    public function getAllSubcategories()
    {
        $subcategories = array();

        /**
         * Triggered to add custom subcategories.
         *
         * **Example**
         *
         *     public function addSubcategories(&$subcategories)
         *     {
         *         $subcategory = new Subcategory();
         *         $subcategory->setId('General_Overview');
         *         $subcategory->setCategoryId('General_Visits');
         *         $subcategory->setOrder(5);
         *         $subcategories[] = $subcategory;
         *     }
         *
         * @param array &$subcategories An array containing a list of subcategories.
         */
        Piwik::postEvent('Category.addSubcategories', array(&$subcategories));

        $classes = $this->pluginManager->findMultipleComponents('Categories', '\\Piwik\\Category\\Subcategory');

        foreach ($classes as $subcategory) {
            $subcategories[] = StaticContainer::getContainer()->make($subcategory);
        }

        return $subcategories;
    }
}