sspmod_statistics_Graph_GoogleCharts Class Reference

Collaboration diagram for sspmod_statistics_Graph_GoogleCharts:

Public Member Functions
	__construct ($x=800, $y=350)
	Constructor. More...
	show ($axis, $axispos, $datasets, $maxes)
	Generate a Google Charts URL which points to a generated image. More...
	showPie ($axis, $datasets)

Static Public Member Functions
static	extEncode ($values)
static	roof ($max)
	Takes a input value, and generates a value that suits better as a max value on the Y-axis. More...

Private Member Functions
	encodeaxis ($axis)
	encodedata ($datasets)

Private Attributes
	$x
	$y

Detailed Description

Definition at line 9 of file GoogleCharts.php.

Constructor & Destructor Documentation

__construct()

sspmod_statistics_Graph_GoogleCharts::__construct	(		$x = 800,
			$y = 350
	)

Constructor.

Takes dimension of graph as parameters. X and Y.

Parameters

integer	$x	X dimension. Default 800.
integer	$y	Y dimension. Default 350.

Definition at line 29 of file GoogleCharts.php.

References $x, and $y.

    {
        $this->x = $x;
        $this->y = $y;
    }

Member Function Documentation

encodeaxis()

sspmod_statistics_Graph_GoogleCharts::encodeaxis (   $axis )

private

Definition at line 35 of file GoogleCharts.php.

References $axis.

Referenced by show(), and showPie().

    {
        return join('|', $axis);
    }

Here is the caller graph for this function:

encodedata()

sspmod_statistics_Graph_GoogleCharts::encodedata (   $datasets )

private

Definition at line 41 of file GoogleCharts.php.

References $datasets.

Referenced by show(), and showPie().

    {
        $setstr = array();
        foreach ($datasets as $dataset) {
            $setstr[] = self::extEncode($dataset);
        }
        return 'e:' . join(',', $setstr);
    }

Here is the caller graph for this function:

extEncode()

static sspmod_statistics_Graph_GoogleCharts::extEncode (   $values )

static

Definition at line 50 of file GoogleCharts.php.

References $size, and $values.

    {
        $extended_table = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.';
        $chardata = '';
        $delta = 4095;
        $size = (strlen($extended_table));

        foreach ($values as $k => $v) {
            if ($v >= 0 && $v <= 100) {
                $first = substr($extended_table, intval(($delta * $v / 100) / $size), 1);
                $second = substr($extended_table, intval(($delta * $v / 100) % $size), 1);
                $chardata .= "$first$second";
            } else { 
                $chardata .= '__'; // Value out of max range; 
            } 
        }
        return($chardata); 
    }

roof()

static sspmod_statistics_Graph_GoogleCharts::roof (   $max )

static

Takes a input value, and generates a value that suits better as a max value on the Y-axis.

In example 37.6 will not make a good max value, instead it will return 40. It will always return an equal or larger number than it gets as input.

Here is some test code: $foo = array(0, 2, 2.3, 2.6, 6, 10, 15, 98, 198, 256, 487, 563, 763, 801, 899, 999, 987, 198234.485, 283746); foreach ($foo AS $f) { echo '

' . $f . ' => ' . sspmod_statistics_Graph_GoogleCharts::roof($f); }

Parameters

$max	Input value.

Definition at line 144 of file GoogleCharts.php.

References $c, and $t.

Referenced by sspmod_statistics_StatDataset\calculateMax().

    {
        $mul = 1;

        if ($max < 1) {
            return 1;
        }

        $t = intval(ceil($max));
        while ($t > 100) {
            $t /= 10;
            $mul *= 10;
        }

        $maxGridLines = 10;
        $candidates = array(1, 2, 5, 10, 20, 25, 50, 100);

        foreach ($candidates as $c) {
            if ($t / $c < $maxGridLines) {
                $tick_y = $c * $mul;
                $target_top = intval(ceil($max / $tick_y) * $tick_y);
                return $target_top;
            }
        }
    }

Here is the caller graph for this function:

show()

sspmod_statistics_Graph_GoogleCharts::show	(		$axis,
			$axispos,
			$datasets,
			$maxes
	)

Generate a Google Charts URL which points to a generated image.

More documentation on Google Charts here: http://code.google.com/apis/chart/

Parameters

$axis	Axis
$axpis	Axis positions
$datasets	Datasets values
$max	Max value. Will be the topmost value on the Y-axis.

Definition at line 79 of file GoogleCharts.php.

References $axis, $datasets, $maxes, $url, encodeaxis(), and encodedata().

    {
        $labeld = '&chxt=x,y' . '&chxr=0,0,1|1,0,' . $maxes[0];
        if (count($datasets) > 1) {
            if (count($datasets) !== count($maxes)) {
                throw new Exception('Incorrect number of max calculations for graph plotting.');
            }
            $labeld = '&chxt=x,y,r' . '&chxr=0,0,1|1,0,' . $maxes[0] . '|2,0,' . $maxes[1];
        }

        $url = 'https://chart.apis.google.com/chart?' .
            // Dimension of graph. Default is 800x350
            'chs=' . $this->x . 'x' . $this->y . 

            // Dateset values
            '&chd=' . $this->encodedata($datasets) .

            // Fill area...
            '&chco=ff5c00,cca600' . 
            '&chls=1,1,0|1,6,3' .

            // chart type is linechart
            '&cht=lc' .
            $labeld .
            '&chxl=0:|' . $this->encodeaxis($axis) . # . $'|1:||top' .
            '&chxp=0,' . join(',', $axispos) .
            '&chg=' . (2400/(count($datasets[0])-1)) . ',-1,3,3';   // lines

        return $url;
    }

Here is the call graph for this function:

showPie()

sspmod_statistics_Graph_GoogleCharts::showPie	(		$axis,
			$datasets
	)

Definition at line 110 of file GoogleCharts.php.

References $axis, $datasets, $url, encodeaxis(), and encodedata().

    {
        $url = 'https://chart.apis.google.com/chart?' .

        // Dimension of graph. Default is 800x350
        'chs=' . $this->x . 'x' . $this->y . 

        // Dateset values.
        '&chd=' . $this->encodedata(array($datasets)) .

        // chart type is linechart
        '&cht=p' .

        '&chl=' . $this->encodeaxis($axis);

        return $url;
    }

Here is the call graph for this function:

Field Documentation

$x

sspmod_statistics_Graph_GoogleCharts::$x

private

Definition at line 14 of file GoogleCharts.php.

Referenced by __construct().

$y

sspmod_statistics_Graph_GoogleCharts::$y

private

Definition at line 19 of file GoogleCharts.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/statistics/lib/Graph/GoogleCharts.php