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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<?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_Log
* @subpackage Piwik_Log_APICall
*/
/**
* Class used to log all the API Calls information (class / method / parameters / returned value / time spent)
*
* @package Piwik_Log
* @subpackage Piwik_Log_APICall
*/
class Piwik_Log_APICall extends Piwik_Log
{
const ID = 'logger_api_call';
function __construct()
{
$logToFileFilename = self::ID;
$logToDatabaseTableName = self::ID;
$logToDatabaseColumnMapping = null;
$screenFormatter = new Piwik_Log_Formatter_APICall_ScreenFormatter;
$fileFormatter = new Piwik_Log_Formatter_FileFormatter;
parent::__construct($logToFileFilename,
$fileFormatter,
$screenFormatter,
$logToDatabaseTableName,
$logToDatabaseColumnMapping );
$this->setEventItem('caller_ip', ip2long( Piwik_Common::getIp() ) );
}
function log( $className, $methodName, $parameterNames, $parameterValues, $executionTime, $returnedValue)
{
$event = array();
$event['class_name'] = $className;
$event['method_name'] = $methodName;
$event['parameter_names_default_values'] = serialize($parameterNames);
$event['parameter_values'] = serialize($parameterValues);
$event['execution_time'] = $executionTime;
$event['returned_value'] = is_array($returnedValue) ? serialize($returnedValue) : $returnedValue;
parent::log($event);
}
}
/**
* Class used to format the API Call log on the screen.
*
* @package Piwik_Log
* @subpackage Piwik_Log_APICall
*/
class Piwik_Log_Formatter_APICall_ScreenFormatter implements Zend_Log_Formatter_Interface
{
/**
* Formats data into a single line to be written by the writer.
*
* @param array $event event data
* @return string formatted line to write to the log
*/
public function format($event)
{
$str = "\n<br> ";
$str .= "Called: {$event['class_name']}.{$event['method_name']} (took {$event['execution_time']}ms) \n<br>";
$str .= "Parameters: ";
$parameterNamesAndDefault = unserialize($event['parameter_names_default_values']);
$parameterValues = unserialize($event['parameter_values']);
$i = 0;
foreach($parameterNamesAndDefault as $pName => $pDefault)
{
if(isset($parameterValues[$i]))
{
$currentValue = $parameterValues[$i];
}
else
{
$currentValue = $pDefault;
}
$currentValue = $this->formatValue($currentValue);
$str .= "$pName = $currentValue, ";
$i++;
}
$str .= "\n<br> ";
// $str .= "Returned: ".$this->formatValue($event['returned_value']);
$str .= "\n<br> ";
return $str;
}
private function formatValue( $value )
{
if(is_string($value))
{
$value = "'$value'";
}
if(is_null($value))
{
$value= 'null';
}
if(is_array($value))
{
$value = "array( ".implode(", ", $value). ")";
}
return $value;
}
}
|
