icingaweb2/library/Icinga/Web/Hook/GrapherHook.php

<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}

namespace Icinga\Web\Hook;

use Icinga\Exception\ProgrammingError;

/**
 * Icinga Web Grapher Hook base class
 *
 * Extend this class if you want to integrate your graphing solution nicely into
 * Icinga Web
 *
 * @copyright  Copyright (c) 2013 Icinga-Web Team <info@icinga.org>
 * @author     Icinga-Web Team <info@icinga.org>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
 */
abstract class GrapherHook
{
    /**
     * Whether this grapher provides preview images
     *
     * @var bool
     */
    protected $hasPreviews = false;

    /**
     * Constructor must live without arguments right now
     *
     * Therefore the constructor is final, we might change our opinion about
     * this one far day
     */
    final public function __construct()
    {
        $this->init();
    }

    /**
     * Whether this grapher provides preview images
     *
     * @return bool
     */
    public function hasPreviews()
    {
        return $this->hasPreviews;
    }

    /**
     * Overwrite this function if you want to do some initialization stuff
     *
     * @return void
     */
    protected function init()
    {
    }

    /**
     * Whether a graph for the given host[, service [, plot]] exists
     *
     * @param   string  $host
     * @param   string  $service
     * @param   string  $plot
     *
     * @return bool
     */
    public function has($host, $service = null, $plot = null)
    {
        return false;
    }

    /**
     * Get a preview image for the given host[, service [, plot]] exists
     *
     * @param   string  $host
     * @param   string  $service
     * @param   string  $plot
     *
     * @return  string
     *
     * @throws  ProgrammingError
     */
    public function getPreviewHtml($host, $service = null, $plot = null)
    {
        throw new ProgrammingError('This backend has no preview images');
    }

    /**
     * Whether a tiny graph for the given host[, service [, plot]] exists
     *
     * @param   string  $host
     * @param   string  $service
     * @param   string  $plot
     *
     * @return  bool
     */
    public function hasTinyPreview($host, $service = null, $plot = null)
    {
        return false;
    }

    /**
     * Get a tiny preview image for the given host[, service [, plot]] exists
     *
     * @param   string  $host
     * @param   string  $service
     * @param   string  $plot
     *
     * @return  string
     *
     * @throws  ProgrammingError
     */
    public function getTinyPreviewHtml($host, $service = null, $plot = null)
    {
        throw new ProgrammingError('This backend has no tiny preview images');
    }

    /**
     * Get URL pointing to the grapher
     *
     * WARNING: We are not sure yet whether this will remain as is
     *
     * @param   string  $host
     * @param   string  $service
     * @param   string  $plot
     *
     * @return  string
     */
    abstract function getGraphUrl($host, $service = null, $plot = null);
}