fannie/classlib2.0/FannieReportTool.php
<?php
/*******************************************************************************
Copyright 2014 Whole Foods Co-op
This file is part of CORE-POS.
IT CORE is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
IT CORE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
in the file license.txt along with IT CORE; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*********************************************************************************/
namespace COREPOS\Fannie\API;
/**
* @class FannieReportTool
* @codeCoverageIgnore
*
* This class behaves identically to FanniePage.
* It exists only for categorization purposes
* so pages that provide report-esque data but not
* in the standard, tabular format can be
* discovered automatically.
*/
class FannieReportTool extends \FanniePage
{
public $required = True;
/**
Description of the report
*/
public $description = "
Base class for hybrid report/tool pages
";
public $page_set = 'Reports';
/**
Assign report to a "set" of reports
*/
public $report_set = '';
public $discoverable = true;
public function coverage()
{
// code coverage metrics require something callable
return 0;
}
}