156 lines
4.3 KiB
PHP
156 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - Open source web analytics
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*
|
|
*/
|
|
|
|
namespace Piwik\DataTable;
|
|
|
|
use Exception;
|
|
use Piwik\Common;
|
|
use Piwik\DataTable;
|
|
use Piwik\Singleton;
|
|
|
|
/**
|
|
* The DataTable_Manager registers all the instanciated DataTable and provides an
|
|
* easy way to access them. This is used to store all the DataTable during the archiving process.
|
|
* At the end of archiving, the ArchiveProcessor will read the stored datatable and record them in the DB.
|
|
*
|
|
* @method static \Piwik\DataTable\Manager getInstance()
|
|
*/
|
|
class Manager extends Singleton
|
|
{
|
|
/**
|
|
* Array used to store the DataTable
|
|
*
|
|
* @var array
|
|
*/
|
|
private $tables = array();
|
|
|
|
/**
|
|
* Id of the next inserted table id in the Manager
|
|
* @var int
|
|
*/
|
|
protected $nextTableId = 1;
|
|
|
|
/**
|
|
* Add a DataTable to the registry
|
|
*
|
|
* @param DataTable $table
|
|
* @return int Index of the table in the manager array
|
|
*/
|
|
public function addTable($table)
|
|
{
|
|
$this->tables[$this->nextTableId] = $table;
|
|
$this->nextTableId++;
|
|
return $this->nextTableId - 1;
|
|
}
|
|
|
|
/**
|
|
* Returns the DataTable associated to the ID $idTable.
|
|
* NB: The datatable has to have been instanciated before!
|
|
* This method will not fetch the DataTable from the DB.
|
|
*
|
|
* @param int $idTable
|
|
* @throws Exception If the table can't be found
|
|
* @return DataTable The table
|
|
*/
|
|
public function getTable($idTable)
|
|
{
|
|
if (!isset($this->tables[$idTable])) {
|
|
throw new TableNotFoundException(sprintf("This report has been reprocessed since your last click. To see this error less often, please increase the timeout value in seconds in Settings > General Settings. (error: id %s not found).", $idTable));
|
|
}
|
|
return $this->tables[$idTable];
|
|
}
|
|
|
|
/**
|
|
* Returns the latest used table ID
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getMostRecentTableId()
|
|
{
|
|
return $this->nextTableId - 1;
|
|
}
|
|
|
|
/**
|
|
* Delete all the registered DataTables from the manager
|
|
*/
|
|
public function deleteAll($deleteWhenIdTableGreaterThan = 0)
|
|
{
|
|
foreach ($this->tables as $id => $table) {
|
|
if ($id > $deleteWhenIdTableGreaterThan) {
|
|
$this->deleteTable($id);
|
|
}
|
|
}
|
|
if ($deleteWhenIdTableGreaterThan == 0) {
|
|
$this->tables = array();
|
|
$this->nextTableId = 1;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deletes (unsets) the datatable given its id and removes it from the manager
|
|
* Subsequent get for this table will fail
|
|
*
|
|
* @param int $id
|
|
*/
|
|
public function deleteTable($id)
|
|
{
|
|
if (isset($this->tables[$id])) {
|
|
Common::destroy($this->tables[$id]);
|
|
$this->setTableDeleted($id);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deletes all tables starting from the $firstTableId to the most recent table id except the ones that are
|
|
* supposed to be ignored.
|
|
*
|
|
* @param int[] $idsToBeIgnored
|
|
* @param int $firstTableId
|
|
*/
|
|
public function deleteTablesExceptIgnored($idsToBeIgnored, $firstTableId = 0)
|
|
{
|
|
$lastTableId = $this->getMostRecentTableId();
|
|
|
|
for ($index = $firstTableId; $index <= $lastTableId; $index++) {
|
|
if (!in_array($index, $idsToBeIgnored)) {
|
|
$this->deleteTable($index);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove the table from the manager (table has already been unset)
|
|
*
|
|
* @param int $id
|
|
*/
|
|
public function setTableDeleted($id)
|
|
{
|
|
$this->tables[$id] = null;
|
|
}
|
|
|
|
/**
|
|
* Debug only. Dumps all tables currently registered in the Manager
|
|
*/
|
|
public function dumpAllTables()
|
|
{
|
|
echo "<hr />Manager->dumpAllTables()<br />";
|
|
foreach ($this->tables as $id => $table) {
|
|
if (!($table instanceof DataTable)) {
|
|
echo "Error table $id is not instance of datatable<br />";
|
|
var_export($table);
|
|
} else {
|
|
echo "<hr />";
|
|
echo "Table (index=$id) TableId = " . $table->getId() . "<br />";
|
|
echo $table;
|
|
echo "<br />";
|
|
}
|
|
}
|
|
echo "<br />-- End Manager->dumpAllTables()<hr />";
|
|
}
|
|
}
|