sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Helpers/Chart/Dynamic.php
+222 -188
View File
@@ -10,167 +10,202 @@
namespace IPS\Helpers\Chart;
use IPS\Member;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use DateInterval;
use DateTimeZone;
use Exception;
use IPS\core\Statistics\Chart as StatisticsChart;
use IPS\DateTime;
use IPS\Db;
use IPS\Helpers\Chart;
use IPS\Helpers\Form;
use IPS\Helpers\Form\Date;
use IPS\Helpers\Form\Text;
use IPS\Http\Url;
use IPS\IPS;
use IPS\Member;
use IPS\Output;
use IPS\Request;
use IPS\Session;
use IPS\Theme;
use Throwable;
use function defined;
use function file_get_contents;
use function in_array;
use function is_array;
use function is_numeric;
use function mb_substr;
use const IPS\TEMP_DIRECTORY;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Dynamic Chart Helper
*/
abstract class _Dynamic extends \IPS\Helpers\Chart
abstract class Dynamic extends Chart
{
/**
* @brief URL
*/
public $url;
public Url $url;
/**
* @var Url|null
*/
public ?Url $baseURL = null;
/**
* @brief $timescale (daily, weekly, monthly)
*/
public $timescale = 'monthly';
public mixed $timescale = 'monthly';
/**
* @brief Unique identifier for URLs
*/
public $identifier = '';
public string $identifier = '';
/**
* @brief Start Date
*/
public $start;
public mixed $start = NULL;
/**
* @brief End Date
*/
public $end;
public mixed $end = NULL;
/**
* @brief Series
*/
protected $series = array();
protected array $series = array();
/**
* @brief Title
*/
public $title;
public ?string $title = NULL;
/**
* @brief Description
*/
public $description;
public ?string $description = NULL;
/**
* @brief Google Chart Options
*/
public $options = array();
public array $options = array();
/**
* @brief Type
*/
public $type;
public mixed $type;
/**
* @brief Search term
*/
public $searchTerm = null;
public mixed $searchTerm = null;
/**
* @brief Available Types
*/
public $availableTypes = array( 'AreaChart', 'LineChart', 'ColumnChart', 'BarChart', 'PieChart', 'Table' );
public array $availableTypes = array( 'AreaChart', 'LineChart', 'ColumnChart', 'BarChart', 'PieChart', 'Table' );
/**
* @brief Available Filters
*/
public $availableFilters = array();
public array $availableFilters = array();
/**
* @brief Current Filters
*/
public $currentFilters = array();
public array $currentFilters = array();
/**
* @brief Plot zeros
*/
public $plotZeros = TRUE;
public bool $plotZeros = TRUE;
/**
* @brief Value for number formatter
*/
public $format = NULL;
public mixed $format = NULL;
/**
* @brief Allow user to adjust interval (group by daily, monthly, etc.)
*/
public $showIntervals = TRUE;
public bool $showIntervals = TRUE;
/**
* @brief Allow user to adjust date range
*/
public $showDateRange = TRUE;
public bool $showDateRange = TRUE;
/**
* @brief Show save button
*/
public $showSave = TRUE;
public bool $showSave = TRUE;
/**
* @brief If a warning about timezones needs to be shown
*/
public $timezoneError = FALSE;
public bool $timezoneError = FALSE;
/**
* @brief If we need to show a timezone warning, we usually include a link to learn more - set this to TRUE to hide the link
*/
public $hideTimezoneLink = FALSE;
public bool $hideTimezoneLink = FALSE;
/**
* @brief If set to an \IPS\DateTime instance, minimum time will be checked against this value
* @brief If set to an DateTime instance, minimum time will be checked against this value
*/
public $minimumDate = NULL;
public ?DateTime $minimumDate = NULL;
/**
* @brief Enable hourly filtering. USE WITH CAUTION.
*/
public $enableHourly = FALSE;
public bool $enableHourly = FALSE;
/**
* @brief Error(s) to show on chart UI
*/
public $errors = array();
public array $errors = array();
/**
* @brief Saved custom filters
*/
public $savedCustomFilters = array();
public array $savedCustomFilters = array();
/**
* @brief Prefix passed to tables
*/
public string $tableLangPrefix = '';
/**
* Constructor
*
* @param \IPS\Http\Url $url The URL the chart will be displayed on
* @param string $title Title
* @param array $options Options
* @param string $defaultType The default chart type
* @param string $defaultTimescale The default timescale to use
* @param array $defaultTimes The default start/end times to use
* @param string $identifier If there will be more than one chart per page, provide a unique identifier
* @param \IPS\DateTime|NULL $minimumDate The earliest available date for this chart
* @see <a href='https://google-developers.appspot.com/chart/interactive/docs/gallery'>Charts Gallery - Google Charts - Google Developers</a>
* @param Url $url The URL the chart will be displayed on
* @param string $title Title
* @param array $options Options
* @param string $defaultType The default chart type
* @param string $defaultTimescale The default timescale to use
* @param array $defaultTimes The default start/end times to use
* @param string $identifier If there will be more than one chart per page, provide a unique identifier
* @param DateTime|null $minimumDate The earliest available date for this chart
* @return void
*@see <a href='https://google-developers.appspot.com/chart/interactive/docs/gallery'>Charts Gallery - Google Charts - Google Developers</a>
*/
public function __construct( \IPS\Http\Url $url, $title='', $options=array(), $defaultType='AreaChart', $defaultTimescale='monthly', $defaultTimes=array( 'start' => 0, 'end' => 0 ), $identifier='', $minimumDate=NULL )
public function __construct( Url $url, string $title='', array $options=array(), string $defaultType='AreaChart', string $defaultTimescale='monthly', array $defaultTimes=array( 'start' => 0, 'end' => 0 ), string $identifier='', DateTime $minimumDate=null )
{
/* If we are deleting a chart, just do that now and redirect */
if( isset( \IPS\Request::i()->deleteChart ) )
if( isset( Request::i()->deleteChart ) )
{
\IPS\Session::i()->csrfCheck();
\IPS\Db::i()->delete( 'core_saved_charts', array( 'chart_id=? and chart_member=?', \IPS\Request::i()->deleteChart, \IPS\Member::loggedIn()->member_id ) );
\IPS\Output::i()->redirect( \IPS\Request::i()->url()->stripQueryString( array( 'deleteChart', 'chartId', 'csrfKey' ) ), 'chart_deleted' );
Session::i()->csrfCheck();
Db::i()->delete( 'core_saved_charts', array( 'chart_id=? and chart_member=?', Request::i()->deleteChart, Member::loggedIn()->member_id ) );
Output::i()->redirect( Request::i()->url()->stripQueryString( array( 'deleteChart', 'chartId', 'csrfKey' ) ), 'chart_deleted' );
}
if ( !isset( $options['chartArea'] ) )
@@ -181,22 +216,22 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
);
}
if( isset( \IPS\Request::i()->chartId ) AND \IPS\Request::i()->chartId != '_default' )
if( isset( Request::i()->chartId ) AND Request::i()->chartId != '_default' )
{
$url = $url->setQueryString( 'chartId', \IPS\Request::i()->chartId );
$url = $url->setQueryString( 'chartId', Request::i()->chartId );
}
$this->baseURL = $url;
$this->title = $title;
$this->options = $options;
$this->timescale = $defaultTimescale;
$this->start = $defaultTimes['start'] ?: \IPS\DateTime::create()->sub( new \DateInterval('P6M') );
$this->end = $defaultTimes['end'] ?: \IPS\DateTime::create();
$this->start = $defaultTimes['start'] ?: DateTime::create()->sub( new DateInterval('P6M') );
$this->end = $defaultTimes['end'] ?: DateTime::create();
$this->minimumDate = $minimumDate;
if ( isset( \IPS\Request::i()->type[ $this->identifier ] ) and \in_array( \IPS\Request::i()->type[ $this->identifier ], $this->availableTypes ) )
if ( isset( Request::i()->type[ $this->identifier ] ) and in_array( Request::i()->type[ $this->identifier ], $this->availableTypes ) )
{
$this->type = \IPS\Request::i()->type[ $this->identifier ];
$this->type = Request::i()->type[ $this->identifier ];
$url = $url->setQueryString( 'type', array( $this->identifier => $this->type ) );
}
else
@@ -205,18 +240,18 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
/* Are we searching? The chart controller should inspect this property if it supports searching to limit the series it adds. */
if( isset( $this->options['limitSearch'] ) AND isset( \IPS\Request::i()->search[ $this->identifier ] ) )
if( isset( $this->options['limitSearch'] ) AND isset( Request::i()->search[ $this->identifier ] ) )
{
$this->searchTerm = \IPS\Request::i()->search[ $this->identifier ];
$this->searchTerm = Request::i()->search[ $this->identifier ];
}
/* Change timescale */
if ( isset( \IPS\Request::i()->timescale[ $this->identifier ] ) and \in_array( \IPS\Request::i()->timescale[ $this->identifier ], array( 'hourly', 'daily', 'weekly', 'monthly' ) ) )
if ( isset( Request::i()->timescale[ $this->identifier ] ) and in_array( Request::i()->timescale[ $this->identifier ], array( 'hourly', 'daily', 'weekly', 'monthly' ) ) )
{
if( \IPS\Request::i()->timescale[ $this->identifier ] != 'hourly' OR ( \IPS\Request::i()->timescale[ $this->identifier ] == 'hourly' AND $this->enableHourly === TRUE ) )
if( Request::i()->timescale[ $this->identifier ] != 'hourly' OR ( Request::i()->timescale[ $this->identifier ] == 'hourly' AND $this->enableHourly === TRUE ) )
{
$this->timescale = \IPS\Request::i()->timescale[ $this->identifier ];
$url = $url->setQueryString( 'timescale', array( $this->identifier => \IPS\Request::i()->timescale[ $this->identifier ] ) );
$this->timescale = Request::i()->timescale[ $this->identifier ];
$url = $url->setQueryString( 'timescale', array( $this->identifier => Request::i()->timescale[ $this->identifier ] ) );
}
}
@@ -227,26 +262,26 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
else
{
$this->addHeader( \IPS\Member::loggedIn()->language()->addToStack('date'), ( $this->timescale == 'none' OR $this->timescale == 'hourly' ) ? 'datetime' : 'date' );
$this->addHeader( Member::loggedIn()->language()->addToStack('date'), ( $this->timescale == 'none' OR $this->timescale == 'hourly' ) ? 'datetime' : 'date' );
}
if ( isset( \IPS\Request::i()->start[ $this->identifier ] ) )
if ( isset( Request::i()->start[ $this->identifier ] ) )
{
try
{
$originalStart = $this->start;
if( !\IPS\Request::i()->start[ $this->identifier ] )
if( !Request::i()->start[ $this->identifier ] )
{
$this->start = 0;
}
elseif ( \is_numeric( \IPS\Request::i()->start[ $this->identifier ] ) )
elseif ( is_numeric( Request::i()->start[ $this->identifier ] ) )
{
$this->start = \IPS\DateTime::ts( \IPS\Request::i()->start[ $this->identifier ] );
$this->start = DateTime::ts( Request::i()->start[ $this->identifier ] );
}
else
{
$this->start = new \IPS\DateTime( \IPS\Helpers\Form\Date::_convertDateFormat( \IPS\Request::i()->start[ $this->identifier ] ), new \DateTimeZone( \IPS\Member::loggedIn()->timezone ) );
$this->start = new DateTime( Date::_convertDateFormat( Request::i()->start[ $this->identifier ] ), new DateTimeZone( Member::loggedIn()->timezone ) );
}
if( $this->minimumDate > $this->start )
@@ -264,24 +299,24 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
$url = $url->setQueryString( 'start', array( $this->identifier => $this->start->getTimestamp() ) );
}
}
catch ( \Exception $e ) {}
catch ( Exception $e ) {}
}
if ( isset( \IPS\Request::i()->end[ $this->identifier ] ) )
if ( isset( Request::i()->end[ $this->identifier ] ) )
{
try
{
if( !\IPS\Request::i()->end[ $this->identifier ] )
if( !Request::i()->end[ $this->identifier ] )
{
$this->end = \IPS\DateTime::create();
$this->end = DateTime::create();
}
elseif ( \is_numeric( \IPS\Request::i()->end[ $this->identifier ] ) )
elseif ( is_numeric( Request::i()->end[ $this->identifier ] ) )
{
$this->end = \IPS\DateTime::ts( \IPS\Request::i()->end[ $this->identifier ] );
$this->end = DateTime::ts( Request::i()->end[ $this->identifier ] );
}
else
{
$this->end = new \IPS\DateTime( \IPS\Helpers\Form\Date::_convertDateFormat( \IPS\Request::i()->end[ $this->identifier ] ), new \DateTimeZone( \IPS\Member::loggedIn()->timezone ) );
$this->end = new DateTime( Date::_convertDateFormat( Request::i()->end[ $this->identifier ] ), new DateTimeZone( Member::loggedIn()->timezone ) );
}
/* The end date should include items to the end of the day */
@@ -289,86 +324,85 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
$url = $url->setQueryString( 'end', array( $this->identifier => $this->end->getTimestamp() ) );
}
catch ( \Exception $e ) {}
catch ( Exception $e ) {}
}
if ( isset( \IPS\Request::i()->filters[ $this->identifier ] ) )
if ( isset( Request::i()->filters[ $this->identifier ] ) )
{
$url = $url->setQueryString( 'filters', '' );
}
$this->url = $url;
if ( \IPS\Member::loggedIn()->timezone and \in_array( \IPS\Member::loggedIn()->timezone, \DateTimeZone::listIdentifiers() ) )
if ( Member::loggedIn()->timezone and in_array( Member::loggedIn()->timezone, DateTimeZone::listIdentifiers() ) )
{
try
{
$r = \IPS\Db::i()->query( "SELECT TIMEDIFF( NOW(), CONVERT_TZ( NOW(), @@session.time_zone, '" . \IPS\Db::i()->escape_string( \IPS\Member::loggedIn()->timezone ) . "' ) );" )->fetch_row();
$r = Db::i()->query( "SELECT TIMEDIFF( NOW(), CONVERT_TZ( NOW(), @@session.time_zone, '" . Db::i()->escape_string( Member::loggedIn()->timezone ) . "' ) );" )->fetch_row();
if ( $r[0] === NULL )
{
$this->timezoneError = TRUE;
}
}
catch ( \IPS\Db\Exception $e )
catch ( Db\Exception $e )
{
$this->timezoneError = TRUE;
}
}
/* If we have requested a saved chart, load its filters */
if( isset( \IPS\Request::i()->chartId ) AND \IPS\Request::i()->chartId != '_default' AND !isset( \IPS\Request::i()->filters ) )
if( isset( Request::i()->chartId ) AND Request::i()->chartId != '_default' AND !isset( Request::i()->filters ) )
{
foreach( $this->loadAvailableChartTabs() as $chart )
{
if( $chart['chart_id'] == \IPS\Request::i()->chartId )
if( $chart['chart_id'] == Request::i()->chartId )
{
$filters = array();
foreach( json_decode( $chart['chart_configuration'], true ) as $key => $value )
{
if ( \mb_substr( $key, 0, 11 ) == 'customform_' )
if ( mb_substr( $key, 0, 11 ) == 'customform_' )
{
$this->savedCustomFilters[ \mb_substr( $key, 11 ) ] = $value;
$this->savedCustomFilters[ mb_substr( $key, 11 ) ] = $value;
}
else
{
$filters[ $key ] = $value;
}
}
\IPS\Request::i()->filters = array( $this->identifier => $filters );
Request::i()->filters = array( $this->identifier => $filters );
}
}
}
foreach( \IPS\Request::i() as $key => $value )
foreach( Request::i() as $key => $value )
{
if ( $value and \mb_substr( $key, 0, 11 ) === 'customform_' )
if ( $value and mb_substr( $key, 0, 11 ) === 'customform_' )
{
$name = \mb_substr( preg_replace( '#' . $this->identifier . '#', '', $key ), 11 );
$name = mb_substr( preg_replace( '#' . $this->identifier . '#', '', $key ), 11 );
$this->savedCustomFilters[ $name ] = $value;
}
}
}
/**
* Compile Data for Output
*
* @param array $data The data
* @return void
* @return void
*/
abstract public function compileForOutput();
abstract public function compileForOutput() : void;
/**
* Get the chart output
*
* @return string
*/
abstract public function getOutput();
abstract public function getOutput(): string;
/**
* @brief Form to save filters
*/
public $form = NULL;
public ?Form $form = NULL;
/**
* HTML
@@ -380,8 +414,8 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
try
{
/* Generate a form so we can save our filters as a new saved chart */
$this->form = new \IPS\Helpers\Form;
$this->form->class = 'ipsForm_vertical';
$this->form = new Form;
$this->form->class = 'ipsForm--vertical ipsForm--chart-custom-filters';
if ( $this->customFiltersForm )
{
@@ -395,102 +429,103 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
/* If we have a sub selector from a node form, add on the identifier and pass off to the form to show the ajax */
if ( \IPS\Request::i()->_nodeSelectName )
if ( Request::i()->_nodeSelectName )
{
\IPS\Request::i()->_nodeSelectName = $this->identifier . \IPS\Request::i()->_nodeSelectName;
Request::i()->_nodeSelectName = $this->identifier . Request::i()->_nodeSelectName;
return (string) $this->getCustomFiltersForm();
}
/* We have an existing chart ID */
if( isset( \IPS\Request::i()->chartId ) AND \IPS\Request::i()->chartId != '_default' )
if( isset( Request::i()->chartId ) AND Request::i()->chartId != '_default' )
{
$title = '';
foreach( $this->loadAvailableChartTabs() as $chart )
{
if( $chart['chart_id'] == \IPS\Request::i()->chartId )
if( $chart['chart_id'] == Request::i()->chartId )
{
$title = $chart['chart_title'];
break;
}
}
$custom = array();
$chartFilters = ( isset( \IPS\Request::i()->chartFilters ) and \IPS\Request::i()->chartFilters ) ? \IPS\Request::i()->chartFilters : array();
$this->timescale = ( isset( \IPS\Request::i()->timescale ) and \IPS\Request::i()->timescale[ $this->identifier ] ) ? \IPS\Request::i()->timescale[ $this->identifier ] : $chart['chart_timescale'] ?? 'monthly';
foreach( \IPS\Request::i() as $key => $value )
$chartFilters = ( isset( Request::i()->chartFilters ) and Request::i()->chartFilters ) ? Request::i()->chartFilters : array();
$this->timescale = ( isset( Request::i()->timescale ) and Request::i()->timescale[ $this->identifier ] ) ? Request::i()->timescale[ $this->identifier ] : $chart['chart_timescale'] ?? 'monthly';
foreach( Request::i() as $key => $value )
{
if ( \mb_substr( $key, 0, 11 ) === 'customform_' )
if ( mb_substr( $key, 0, 11 ) === 'customform_' )
{
$custom[ preg_replace( '#' . $this->identifier . '#', '', $key ) ] = $value;
}
}
$this->form->add( new \IPS\Helpers\Form\Text( 'custom_chart_title', $title, TRUE ) );
$this->form->add( new Text( 'custom_chart_title', $title, TRUE ) );
if( $values = $this->form->values() )
{
\IPS\Db::i()->update( 'core_saved_charts', array( 'chart_title' => $values['custom_chart_title'] ), array( 'chart_id=? AND chart_member=?', \IPS\Request::i()->chartId, \IPS\Member::loggedIn()->member_id ) );
Db::i()->update( 'core_saved_charts', array( 'chart_title' => $values['custom_chart_title'] ), array( 'chart_id=? AND chart_member=?', Request::i()->chartId, Member::loggedIn()->member_id ) );
/* And then return the output we need */
\IPS\Output::i()->json( array(
Output::i()->json( array(
'title' => $values['custom_chart_title']
) );
}
/* And we want to save our filter updates */
if( isset( \IPS\Request::i()->saveFilters ) )
if( isset( Request::i()->saveFilters ) )
{
\IPS\Db::i()->update( 'core_saved_charts', array( 'chart_configuration' => json_encode( array_merge( $chartFilters, $custom ) ), 'chart_timescale' => \IPS\Request::i()->timescale ?? $this->timescale ?? 'monthly' ), array( 'chart_id=? AND chart_member=?', \IPS\Request::i()->chartId, \IPS\Member::loggedIn()->member_id ) );
Db::i()->update( 'core_saved_charts', array( 'chart_configuration' => json_encode( array_merge( $chartFilters, $custom ) ), 'chart_timescale' => Request::i()->timescale ?? $this->timescale ?? 'monthly' ), array( 'chart_id=? AND chart_member=?', Request::i()->chartId, Member::loggedIn()->member_id ) );
}
}
/* We are not viewing a saved chart */
else
{
$this->form->add( new \IPS\Helpers\Form\Text( 'custom_chart_title', NULL, TRUE ) );
$this->form->add( new Text( 'custom_chart_title', NULL, TRUE ) );
if( $values = $this->form->values() )
{
$custom = array();
foreach( \IPS\Request::i() as $key => $value )
foreach( Request::i() as $key => $value )
{
if ( \mb_substr( $key, 0, 11 ) === 'customform_' )
if ( mb_substr( $key, 0, 11 ) === 'customform_' )
{
$custom[ preg_replace( '#' . $this->identifier . '#', '', $key ) ] = $value;
}
}
$chartFilters = ( isset( \IPS\Request::i()->chartFilters ) and \IPS\Request::i()->chartFilters ) ? \IPS\Request::i()->chartFilters : array();
$chartFilters = ( isset( Request::i()->chartFilters ) and Request::i()->chartFilters ) ? Request::i()->chartFilters : array();
/* Store the new chart */
$id = \IPS\Db::i()->insert( 'core_saved_charts', array(
'chart_member' => \IPS\Member::loggedIn()->member_id,
'chart_controller' => \IPS\Request::i()->app . '_' . \IPS\Request::i()->module . '_' . \IPS\Request::i()->controller . ( \IPS\Request::i()->tab ? '_' . \IPS\Request::i()->tab : '' ),
$id = Db::i()->insert( 'core_saved_charts', array(
'chart_member' => Member::loggedIn()->member_id,
'chart_controller' => Request::i()->app . '_' . Request::i()->module . '_' . Request::i()->controller . ( Request::i()->tab ? '_' . Request::i()->tab : '' ),
'chart_configuration' => json_encode( array_merge( $chartFilters, $custom ) ),
'chart_timescale' => \IPS\Request::i()->timescale ?? $this->timescale ?? 'monthly',
'chart_timescale' => Request::i()->timescale ?? $this->timescale ?? 'monthly',
'chart_title' => $values['custom_chart_title'],
) );
/* Set some input parameters */
$this->url = $this->url->setQueryString( 'chartId', $id );
\IPS\Request::i()->chartId = $id;
\IPS\Request::i()->filters = array( $this->identifier => \IPS\Request::i()->chartFilters );
Request::i()->chartId = $id;
Request::i()->filters = array( $this->identifier => Request::i()->chartFilters );
$this->currentFilters = \IPS\Request::i()->filters;
if ( isset( \IPS\Request::i()->filters[ $this->identifier ] ) )
$this->currentFilters = Request::i()->filters;
if ( isset( Request::i()->filters[ $this->identifier ] ) )
{
$this->url = $this->url->setQueryString( 'filters', array( $this->identifier => $this->currentFilters ) );
}
/* Reset form, since template looks for it and it should not be set for a saved chart */
$this->form = new \IPS\Helpers\Form;
$this->form->class = 'ipsForm_vertical';
$this->form->add( new \IPS\Helpers\Form\Text( 'custom_chart_title', $values['custom_chart_title'], TRUE ) );
$this->form = new Form;
$this->form->class = 'ipsForm--vertical ipsForm--chart-title';
$this->form->add( new Text( 'custom_chart_title', $values['custom_chart_title'], TRUE ) );
/* And then return the output we need */
\IPS\Output::i()->json( array(
Output::i()->json( array(
'tabHref' => $this->url->stripQueryString( 'filters' ),
'chartId' => $id,
'tabId' => md5( $this->url->acpQueryString() ),
@@ -506,27 +541,27 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
else
{
$output = \IPS\Member::loggedIn()->language()->addToStack('chart_no_results');
$output = Member::loggedIn()->language()->addToStack('chart_no_results');
}
/* Display */
if ( \IPS\Request::i()->noheader )
if ( Request::i()->noheader )
{
return $output;
}
else
{
$chartOutput = \IPS\Theme::i()->getTemplate( 'global', 'core', 'global' )->dynamicChart( $this, $output );
$chartOutput = Theme::i()->getTemplate( 'global', 'core', 'global' )->dynamicChart( $this, $output );
/* If we're not showing filter tabs, just return here. */
if ( !$this->showFilterTabs )
{
return $chartOutput;
}
if( !\IPS\Request::i()->isAjax() OR ( \IPS\Request::i()->tab AND !\IPS\Request::i()->chartId ) )
if( !Request::i()->isAjax() OR ( Request::i()->tab AND !Request::i()->chartId ) )
{
return \IPS\Theme::i()->getTemplate( 'global', 'core' )->tabs( $this->getChartTabs(), ( isset( \IPS\Request::i()->chartId ) ) ? \IPS\Request::i()->chartId : NULL, $chartOutput, $this->url, 'chartId', 'ipsTabs_small ipsTabs_contained' );
return Theme::i()->getTemplate( 'global', 'core' )->tabs( $this->getChartTabs(), ( isset( Request::i()->chartId ) ) ? Request::i()->chartId : NULL, $chartOutput, $this->url, 'chartId', 'ipsTabs_small ipsTabs_contained' );
}
else
{
@@ -534,37 +569,34 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
}
}
catch ( \Exception $e )
catch ( Exception|Throwable $e )
{
\IPS\IPS::exceptionHandler( $e );
}
catch ( \Throwable $e )
{
\IPS\IPS::exceptionHandler( $e );
IPS::exceptionHandler( $e );
return '';
}
}
/**
* @brief Show filter tabs
*/
public $showFilterTabs = TRUE;
public bool $showFilterTabs = TRUE;
/**
* @brief Cached tab data
*/
protected $availableChartTabs = NULL;
protected ?array $availableChartTabs = NULL;
/**
* @Brief Extension
*/
public $extension = NULL;
public ?StatisticsChart $extension = NULL;
/**
* Retrieve tabs based on saved charts
*
* @return array
*/
protected function getChartTabs()
protected function getChartTabs(): array
{
$tabs = array( '_default' => 'dynamic_chart_overview' );
@@ -579,49 +611,49 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
/**
* Load and return available chart tabs
*
* @return array
* @return array|null
*/
protected function loadAvailableChartTabs()
protected function loadAvailableChartTabs() : ?array
{
if( $this->availableChartTabs === NULL )
if ( $this->availableChartTabs === null )
{
if ( $this->extension !== NULL )
if ( $this->extension !== null )
{
$this->availableChartTabs = iterator_to_array( \IPS\Db::i()->select( '*', 'core_saved_charts', array( 'chart_member=? AND chart_controller=?', \IPS\Member::loggedIn()->member_id, $this->extension->controller ) ) );
$this->availableChartTabs = iterator_to_array( Db::i()->select( '*', 'core_saved_charts', ['chart_member=? AND chart_controller=?', Member::loggedIn()->member_id, $this->extension->controller] ) );
}
else
{
$this->availableChartTabs = iterator_to_array( \IPS\Db::i()->select( '*', 'core_saved_charts', array( 'chart_member=? AND chart_controller=?', \IPS\Member::loggedIn()->member_id, \IPS\Request::i()->app . '_' . \IPS\Request::i()->module . '_' . \IPS\Request::i()->controller . ( \IPS\Request::i()->tab ? '_' . \IPS\Request::i()->tab : '' ) ) ) );
$this->availableChartTabs = iterator_to_array( Db::i()->select( '*', 'core_saved_charts', ['chart_member=? AND chart_controller=?', Member::loggedIn()->member_id, Request::i()->app . '_' . Request::i()->module . '_' . Request::i()->controller . ( Request::i()->tab ? '_' . Request::i()->tab : '' )] ) );
}
}
return $this->availableChartTabs;
}
/**
* Set extension
*
* @param \IPS\core\Statistics\Chart $ext Extension
* @param StatisticsChart $ext Extension
* @return void
*/
public function setExtension( \IPS\core\Statistics\Chart $ext )
public function setExtension( StatisticsChart $ext ) : void
{
$this->extension = $ext;
$this->availableChartTabs = NULL;
}
/**
* Flip URL Filter
*
* @param string $filter The Filter
* @return \IPS\Http\Url
* @param string $filter The Filter
* @return Url
*/
public function flipUrlFilter( $filter )
public function flipUrlFilter( string $filter ): Url
{
$filters = $this->currentFilters;
if ( \in_array( $filter, $filters ) )
if ( in_array( $filter, $filters ) )
{
unset( $filters[ array_search( $filter, $filters ) ] );
}
@@ -638,7 +670,7 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
*
* @return array
*/
protected function initData()
protected function initData(): array
{
/* Init data */
$data = array();
@@ -652,13 +684,13 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
case 'hourly':
$data[ $date->format( 'Y-n-j-h-i-s' ) ] = array();
$date->add( new \DateInterval( 'PT1H' ) );
$date->add( new DateInterval( 'PT1H' ) );
break;
case 'daily':
$data[ $date->format( 'Y-n-j' ) ] = array();
$date->add( new \DateInterval( 'P1D' ) );
$date->add( new DateInterval( 'P1D' ) );
break;
case 'weekly':
@@ -666,13 +698,13 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
@see http://php.net/manual/en/function.date.php#106974 */
$data[ $date->format( 'o-W' ) ] = array();
$date->add( new \DateInterval( 'P7D' ) );
$date->add( new DateInterval( 'P7D' ) );
break;
case 'monthly':
$data[ $date->format( 'Y-n' ) ] = array();
$date->add( new \DateInterval( 'P1M' ) );
$date->add( new DateInterval( 'P1M' ) );
break;
}
}
@@ -684,16 +716,16 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
/**
* Custom filter form
*
* @return \IPS\Helpers\Form
* @return Form
*/
public function getCustomFiltersForm()
public function getCustomFiltersForm(): Form
{
$customForm = new \IPS\Helpers\Form('filter_form', 'chart_customfilters_save');
$customForm->class = 'ipsForm_vertical';
$customForm = new Form('filter_form', 'chart_customfilters_save');
$customForm->class = 'ipsForm--vertical ipsForm--custom-filter-form';
if ( isset( \IPS\Request::i()->chartId ) and \IPS\Request::i()->chartId != '_default' )
if ( isset( Request::i()->chartId ) and Request::i()->chartId != '_default' )
{
$customForm->hiddenValues['chartId'] = \IPS\Request::i()->chartId;
$customForm->hiddenValues['chartId'] = Request::i()->chartId;
}
foreach( $this->customFiltersForm['form'] as $field )
@@ -702,26 +734,29 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
{
$langKey = $field->name;
$field->name = $this->identifier . $field->name;
\IPS\Member::loggedIn()->language()->words[ $field->name ] = \IPS\Member::loggedIn()->language()->get( $langKey );
if( Member::loggedIn()->language()->checkKeyExists( $field->name ) )
{
Member::loggedIn()->language()->words[ $field->name ] = Member::loggedIn()->language()->get( $langKey );
}
}
$customForm->add( $field );
}
return $customForm;
}
/**
* Download as CSV
*
* @param array|NULL $headers Headers, or NULL to use headers defined by this object.
* @param array|NULL $rows Rows, or NULL to use rows defined by this object.
* @param string|NULL $fileName File Name, or NULL to use the title defined by this object.
* @return void
* @param array|null $rawHeaders
* @param array|null $rawRows
* @param string|NULL $fileName File Name, or NULL to use the title defined by this object.
* @return void
*/
public function download( ?array $rawHeaders = NULL, ?array $rawRows = NULL, ?string $fileName = NULL )
public function download( ?array $rawHeaders = NULL, ?array $rawRows = NULL, ?string $fileName = NULL ) : void
{
/* Compile the data */
$file = tempnam( \IPS\TEMP_DIRECTORY, 'IPS' );
$file = tempnam( TEMP_DIRECTORY, 'IPS' );
$fh = fopen( $file, 'w' );
/* Set headers */
@@ -751,7 +786,6 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
fputcsv( $fh, $headers );
/* Set Rows */
if ( $rawRows === NULL )
{
$rawRows = $this->rows;
@@ -774,12 +808,12 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
case 'date':
case 'datetime':
case 'timeofday':
$save[] = ( new \IPS\DateTime( $row[$i] ) )->fullYearLocaleDate();
$save[] = ( new DateTime( $row[$i] ) )->fullYearLocaleDate();
break;
/* Anything else can just save as-is */
default:
if ( \is_array( $row[$i] ) )
if ( is_array( $row[$i] ) )
{
/* GeoCharts use arrays so we need to use the value rather */
$save[] = $row[$i]['value'];
@@ -796,7 +830,7 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
fclose( $fh );
$csv = \file_get_contents( $file );
$csv = file_get_contents( $file );
if ( $fileName )
{
$name = $fileName;
@@ -807,10 +841,10 @@ abstract class _Dynamic extends \IPS\Helpers\Chart
}
else
{
$name = \IPS\Output::i()->title;
$name = Output::i()->title;
}
\IPS\Member::loggedIn()->language()->parseOutputForDisplay( $name );
\IPS\Member::loggedIn()->language()->parseOutputForDisplay( $csv );
\IPS\Output::i()->sendOutput( $csv, 200, 'text/csv', array( 'Content-Disposition' => \IPS\Output::getContentDisposition( 'attachment', "{$name}.csv" ) ), FALSE, FALSE, FALSE );
Member::loggedIn()->language()->parseOutputForDisplay( $name );
Member::loggedIn()->language()->parseOutputForDisplay( $csv );
Output::i()->sendOutput( $csv, 200, 'text/csv', array( 'Content-Disposition' => Output::getContentDisposition( 'attachment', "{$name}.csv" ) ), FALSE, FALSE, FALSE );
}
}