Свойство | Тип | Описание | |
---|---|---|---|
$alreadyRegistered | array of already registered plugins names |
Метод | Описание | |
---|---|---|
__construct ( ) | ||
buildApiActionName ( $pluginName, $apiAction ) | ||
call ( string $className, string $methodName, array $parametersRequest ) : mixed | null | Will execute $className->$methodName($parametersValues) If any error is detected (wrong number of parameters, method not found, class not found, etc.) it will throw an exception | |
getCountRegisteredClasses ( ) : integer | Returns number of classes already loaded | |
getMetadata ( ) : array | Returns array containing reflection meta data for all the loaded classes eg. number of parameters, method names, etc. | |
getModuleNameFromClassName ( string $className ) : string | Returns the 'moduleName' part of '\\Piwik\\Plugins\\moduleName\\API' | |
getParametersList ( string $class, string $name ) : array | Returns the parameters names and default values for the method $name of the class $class | |
isDeprecatedMethod ( $class, $methodName ) | Check if given method name is deprecated or not. | |
isExistingApiAction ( $pluginName, $apiAction ) | ||
registerClass ( string $className ) | Registers the API information of a given module. | |
setHideIgnoredFunctions ( boolean $hideIgnoredFunctions ) | Sets whether to hide '@ignore'd functions from method metadata or not. | |
shouldHideAPIMethod ( $docComment ) : boolean |
Метод | Описание | |
---|---|---|
checkIfMethodIsAvailable ( ReflectionMethod $method ) : boolean |
Метод | Описание | |
---|---|---|
checkClassIsSingleton ( string $className ) | Checks that the class is a Singleton (presence of the getInstance() method) | |
checkMethodExists ( string $className, string $methodName ) | Checks that the method exists in the class | |
getRequestParametersArray ( array $requiredParameters, array $parametersRequest ) : array | Returns an array containing the values of the parameters to pass to the method to call | |
includeApiFile ( string $fileName ) | Includes the class API by looking up plugins/xxx/API.php | |
isMethodAvailable ( string $className, string $methodName ) : boolean | Returns true if the method is found in the API of the given class name. | |
loadMethodMetadata ( string $class, ReflectionMethod $method ) | ||
setDocumentation ( ReflectionClass $rClass, string $className ) | Will be displayed in the API page |
protected checkIfMethodIsAvailable ( ReflectionMethod $method ) : boolean | ||
$method | ReflectionMethod | |
Результат | boolean |
public getCountRegisteredClasses ( ) : integer | ||
Результат | integer |
public getMetadata ( ) : array | ||
Результат | array |
public getModuleNameFromClassName ( string $className ) : string | ||
$className | string | "API" |
Результат | string | "Referrers" |
public isDeprecatedMethod ( $class, $methodName ) |
public registerClass ( string $className ) | ||
$className | string | ModuleName eg. "API" |
public setHideIgnoredFunctions ( boolean $hideIgnoredFunctions ) | ||
$hideIgnoredFunctions | boolean |
public shouldHideAPIMethod ( $docComment ) : boolean | ||
$docComment | ||
Результат | boolean |