97 lines
2.3 KiB
Plaintext
97 lines
2.3 KiB
Plaintext
<?php
|
|
/**
|
|
* @brief {key} Widget
|
|
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) Invision Power Services, Inc.
|
|
* @license https://www.invisioncommunity.com/legal/standards/
|
|
* @package Invision Community
|
|
{subpackage}
|
|
* @since {date}
|
|
*/
|
|
|
|
namespace IPS\{namespace}\widgets;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* {key} Widget
|
|
*/
|
|
class _{key} extends {class}
|
|
{
|
|
/**
|
|
* @brief Widget Key
|
|
*/
|
|
public $key = '{key}';
|
|
|
|
/**
|
|
* @brief App
|
|
*/
|
|
public $app = '{appkey}';
|
|
|
|
/**
|
|
* @brief Plugin
|
|
*/
|
|
public $plugin = '{pluginid}';
|
|
|
|
/**
|
|
* Initialise this widget
|
|
*
|
|
* @return void
|
|
*/
|
|
public function init()
|
|
{
|
|
// Use this to perform any set up and to assign a template that is not in the following format:
|
|
// $this->template( array( \IPS\Theme::i()->getTemplate( 'widgets', $this->app, 'front' ), $this->key ) );
|
|
// If you are creating a plugin, uncomment this line:
|
|
// $this->template( array( \IPS\Theme::i()->getTemplate( 'plugins', 'core', 'global' ), $this->key ) );
|
|
// And then create your template at located at plugins/<your plugin>/dev/html/{key}.phtml
|
|
|
|
|
|
parent::init();
|
|
}
|
|
|
|
/**
|
|
* Specify widget configuration
|
|
*
|
|
* @param null|\IPS\Helpers\Form $form Form object
|
|
* @return null|\IPS\Helpers\Form
|
|
*/
|
|
public function configuration( &$form=null )
|
|
{
|
|
if ( $form === null )
|
|
{
|
|
$form = new \IPS\Helpers\Form;
|
|
}
|
|
|
|
// $$form->add( new \IPS\Helpers\Form\XXXX( .... ) );
|
|
// return $form;
|
|
}
|
|
|
|
/**
|
|
* Ran before saving widget configuration
|
|
*
|
|
* @param array $values Values from form
|
|
* @return array
|
|
*/
|
|
public function preConfig( $values )
|
|
{
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* Render a widget
|
|
*
|
|
* @return string
|
|
*/
|
|
public function render()
|
|
{
|
|
return "";
|
|
// Use $this->output( $foo, $bar ); to return a string generated by the template set in init() or manually added via $widget->template( $callback );
|
|
// Note you MUST route output through $this->output() rather than calling \IPS\Theme::i()->getTemplate() because of the way widgets are cached
|
|
}
|
|
} |