Piwik\API\Request::isApiRequest PHP Method

isApiRequest() public static method

Detect if request is an API request. Meaning the module is 'API' and an API method having a valid format was specified.
public static isApiRequest ( array $request ) : boolean
$request array eg array('module' => 'API', 'method' => 'Test.getMethod')
return boolean
    public static function isApiRequest($request)
    {
        $module = Common::getRequestVar('module', '', 'string', $request);
        $method = Common::getRequestVar('method', '', 'string', $request);
        return $module === 'API' && !empty($method) && count(explode('.', $method)) === 2;
    }

Usage Example

Exemplo n.º 1
0
 public function test_isApiRequest_shouldDetectIfItIsApiRequestOrNot()
 {
     $this->assertFalse(Request::isApiRequest(array()));
     $this->assertFalse(Request::isApiRequest(array('module' => '', 'method' => '')));
     $this->assertFalse(Request::isApiRequest(array('module' => 'API')));
     // no method
     $this->assertFalse(Request::isApiRequest(array('module' => 'CoreHome', 'method' => 'index.test')));
     // not api
     $this->assertFalse(Request::isApiRequest(array('module' => 'API', 'method' => 'testmethod')));
     // no valid action
     $this->assertTrue(Request::isApiRequest(array('module' => 'API', 'method' => 'test.method')));
 }
All Usage Examples Of Piwik\API\Request::isApiRequest