Piwik\Plugins\Insights\API::canGenerateInsights PHP Method

canGenerateInsights() public method

Detects whether insights can be generated for this date/period combination or not.
public canGenerateInsights ( string $date, string $period ) : boolean
$date string eg 'today', '2012-12-12'
$period string eg 'day' or 'week'
return boolean
    public function canGenerateInsights($date, $period)
    {
        Piwik::checkUserHasSomeViewAccess();
        try {
            $lastDate = $this->model->getLastDate($date, $period, 1);
        } catch (\Exception $e) {
            return false;
        }
        if (empty($lastDate)) {
            return false;
        }
        return true;
    }

Usage Example

Example #1
0
 public function test_canGenerateInsights()
 {
     $this->assertTrue($this->api->canGenerateInsights('2012-12-12', 'day'));
     $this->assertTrue($this->api->canGenerateInsights('2012-12-12', 'week'));
     $this->assertTrue($this->api->canGenerateInsights('2012-12-12', 'month'));
     $this->assertFalse($this->api->canGenerateInsights('last10', 'day'));
     $this->assertFalse($this->api->canGenerateInsights('2012-11-11,2012-12-12', 'range'));
 }