blob: feaf139b089d0215f9e691a0569f1e7829e1f787 (
plain)
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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @package Piwik_API
*/
require_once "Archive.php";
/**
* This class is the parent class of all the modules that can be called using the API Proxy.
* For example a plugin "Provider" can publish its API by creating a file plugins/Provider/API.php
* that is extending this Piwik_Apiable class.
* All the Piwik_Apiable classes are read and loaded by the Piwik_API_Proxy class.
* The public methods of this class are published in the API and are then callable using the API module.
* The parameters of the function are read directly from the GET request (they must have the same name).
*
* For example
* public function helloWorld($text) { return "hello " . $text; }
* call be called using
* ?module=API&method=PluginName.helloWorld&text=world!
*
* See the documentation on http://dev.piwik.org > API
*
* @package Piwik_API
* @see Piwik_API_Proxy
*/
abstract class Piwik_Apiable
{
/**
* This array contains the name of the methods of the class we don't want to publish in the API.
* By default only public methods are published. Names of public methods in this array won't be published.
*
* @var array of strings
*/
static public $methodsNotToPublish = array();
protected function __construct()
{
}
/**
* @see self::$methodsNotToPublish
* @param string Method name not to be published
*/
protected function doNotPublishMethod( $methodName )
{
if(!method_exists($this, $methodName))
{
throw new Exception("The method $methodName doesn't exist so it can't be added to the list of the methods not to be published in the API.");
}
$this->methodsNotToPublish[] = $methodName;
}
}
|
