• Home
• Piwik
• API
• Request

PHP Class Piwik\API\Request

The Request class is used throughout Piwik to call API methods. The difference between using Request and calling API methods directly is that Request will do more after calling the API including: applying generic filters, applying queued filters, and handling the **flat** and **label** query parameters. Additionally, the Request class will **forward current query parameters** to the request which is more convenient than calling {@link Piwik\Common::getRequestVar()} many times over. In most cases, using a Request object to query the API is the correct approach. ### Post-processing The return value of API methods undergo some extra processing before being returned by Request. ### Output Formats The value returned by Request will be serialized to a certain format before being returned. ### Examples **Basic Usage** $request = new Request('method=UserLanguage.getLanguage&idSite=1&date=yesterday&period=week' . '&format=xml&filter_limit=5&filter_offset=0') $result = $request->process(); echo $result; **Getting a unrendered DataTable** use the convenience method 'processRequest' $dataTable = Request::processRequest('UserLanguage.getLanguage', array( 'idSite' => 1, 'date' => 'yesterday', 'period' => 'week', 'filter_limit' => 5, 'filter_offset' => 0 'format' => 'original', // this is the important bit )); echo "This DataTable has " . $dataTable->getRowsCount() . " rows."; Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
__construct ( string | array $request = null, array $defaultRequest = null )	Constructor.
getBaseReportUrl ( string $module, string $action, array $queryParams = [] ) : string	Returns the URL for the current requested report w/o any filter parameters.
getClassNameAPI ( string $plugin ) : string	Returns the name of a plugin's API class by plugin name.
getCurrentUrlWithoutGenericFilters ( array $params ) : string	Returns the current URL without generic filter query parameters.
getRawSegmentFromRequest ( ) : array | boolean	Returns the segment query parameter from the original request, without modifications.
getRenamedModuleAndAction ( $module, $action ) : array(	For backward compatibility: Piwik API still works if module=Referers, we rewrite to correct renamed plugin: Referrers
getRequestArrayFromString ( string | array | null $request, array $defaultRequest = null ) : array	Converts the supplied request string into an array of query paramater name/value mappings. The current query parameters (everything in $_GET and $_POST) are forwarded to request array before it is returned.
getRequestParametersGET ( ) : array	Returns the original request parameters in the current query string as an array mapping query parameter names with values. The result of this function will not be affected by any modifications to $_GET and will not include parameters in $_POST.
isApiRequest ( array $request ) : boolean	Detect if request is an API request. Meaning the module is 'API' and an API method having a valid format was specified.
process ( ) : DataTable | Map | string	Dispatches the API request to the appropriate API method and returns the result after post-processing.
processRequest ( string $method, array $paramOverride = [], array $defaultRequest = null ) : mixed	Helper method that processes an API request in one line using the variables in $_GET and $_POST.
reloadAuthUsingTokenAuth ( array $request = null ) : void	If the token_auth is found in the $request parameter, the current session will be authenticated using this token_auth.
shouldLoadExpanded ( ) : boolean	Returns whether the DataTable result will have to be expanded for the current request before rendering.
shouldLoadFlatten ( ) : boolean

Private Methods

Method	Description
extractModuleAndMethod ( string $parameter ) : array	Returns array($class, $method) from the given string $class.$method
forceReloadAuthUsingTokenAuth ( string $tokenAuth ) : void	The current session will be authenticated using this token_auth.
getDefaultRequest ( ) : array
renameModuleAndActionInRequest ( )
restoreAuthUsingTokenAuth ( $tokenToRestore, $hadSuperUserAccess )
sanitizeRequest ( )	Make sure that the request contains no logical errors
shouldReloadAuthUsingTokenAuth ( $request )

Method Details