/app/Plugin/DebugKit/Lib/DebugPanel.php

 1<?php
 2/**
 3 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 4 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 5 *
 6 * Licensed under The MIT License
 7 * Redistributions of files must retain the above copyright notice.
 8 *
 9 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
10 * @link          http://cakephp.org CakePHP(tm) Project
11 * @since         DebugKit 0.1
12 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
13 */
14
15/**
16 * Base class for debug panels.
17 *
18 * @since         DebugKit 0.1
19 */
20class DebugPanel {
21
22/**
23 * Defines which plugin this panel is from so the element can be located.
24 *
25 * @var string
26 */
27	public $plugin = 'DebugKit';
28
29/**
30 * Defines the title for displaying on the toolbar. If null, the class name will be used.
31 * Overriding this allows you to define a custom name in the toolbar.
32 *
33 * @var string
34 */
35	public $title = null;
36
37/**
38 * Panel's css files
39 *
40 * @var array
41 */
42	public $css = array();
43
44/**
45 * Panel's javascript files
46 *
47 * @var array
48 */
49	public $javascript = array();
50
51/**
52 * Provide a custom element name for this panel. If null, the underscored version of the class
53 * name will be used.
54 *
55 * @var string
56 */
57	public $elementName = null;
58
59/**
60 * Empty constructor
61 */
62	public function __construct() {
63	}
64
65/**
66 * startup the panel
67 *
68 * Pull information from the controller / request
69 *
70 * @param \Controller|object $controller Controller reference.
71 * @return void
72 */
73	public function startup(Controller $controller) {
74	}
75
76/**
77 * Prepare output vars before Controller Rendering.
78 *
79 * @param \Controller|object $controller Controller reference.
80 * @return void
81 */
82	public function beforeRender(Controller $controller) {
83	}
84}