{

/**

var $name = 'Test';

var $code = 'evo_TEST';

var $priority = 50;

var $version = '7.2.5';

var $author = 'The b2evo Group';

var $help_url = ''; // empty URL defaults to manual wiki

/*

var $number_of_installs = 1;

var $group = 'rendering';

/**

function PluginInit( & $params )

{

$this->short_desc = T_('Test plugin');

$this->long_desc = T_('This plugin responds to virtually all possible plugin events :P');

// Trigger plugin settings instantiation (for testing).

if( $params['is_installed'] )

{

$this->Settings->get('foo');

}

}

/**

function GetDefaultSettings( & $params )

{

$r = array(

'click_me' => array(

'label' => 'Click me!',

'defaultvalue' => '1',

'type' => 'checkbox',

),

'input_me' => array(

'label' => 'How are you?',

'defaultvalue' => '',

'note' => 'Welcome to b2evolution',

),

'number' => array(

'label' => 'Number',

'defaultvalue' => '8',

'note' => '1-9',

'valid_range' => array( 'min'=>1, 'max'=>9 ),

),

'my_select' => array(

'label' => 'Selector',

'id' => $this->classname.'_my_select_id',

'class' => $this->classname.'_my_select_class',

'onchange' => 'document.getElementById("'.$this->classname.'_a_disabled_one").disabled = ( this.value == "sun" );',

'defaultvalue' => 'one',

'type' => 'select',

'options' => array( 'sun' => 'Sunday', 'mon' => 'Monday' ),

'note' => 'This combo is connected with the next field',

),

'a_disabled_one' => array(

'label' => 'This one is disabled',

'id' => $this->classname.'_a_disabled_one',

'type' => 'checkbox',

'defaultvalue' => '1',

'disabled' => true, // this can be useful if you detect that something cannot be changed. You probably want to add a 'note' then, too.

'note' => 'Change the above select input to "Monday" to enable it.',

),

'select_multiple' => array(

'label' => $this->T_( 'Multiple select' ),

'type' => 'select',

'multiple' => true,

'allow_none' => true,

'options' => array( 'sci' => $this->T_( 'Scissors' ), 'pap' => $this->T_( 'Paper' ), 'sto' => $this->T_( 'Stone') ),

'defaultvalue' => array( 'sci', 'sto' ),

'note' => $this->T_( 'This is a free style Multiple Select. You can choose zero or one or more items' )

),

/*

'blog' => array(

'label' => 'A blog',

'type' => 'select_blog', // TODO: does not scale with 500 blogs

'allow_none' => true,

),

'blogs' => array(

'label' => 'A set of blogs',

'type' => 'select_blog', // TODO: BROKEN + does not scale with 500 blogs

'multiple' => true,

'allow_none' => true,

),

'single_user' => array(

'label' => 'A single user',

'type' => 'select_user',

'users_limit' => 5,

'allow_none' => true,

'defaultvalue' => 0,

'note' => 'Allows chosing none or one user'

),

'sets' => array(

'label' => 'Multiple users',

'type' => 'select_user',

'users_limit' => 10,

'min_count' => 0,

'max_count' => 3,

'multiple' => 'true',

'allow_none' => true,

'note' => 'Allows none or one or more than one user (up to three in this example)',

'entries' => array(

'user' => array(

'label' => 'A user',

'type' => 'select_user', // TODO: does not scale with 500 users

'allow_none' => true,

),

),

),

'maxlen' => array(

'label' => 'Max',

'type' => 'textarea',

'maxlength' => 10,

'note' => 'Maximum length is 10 here.',

),

'plug_color' => array(

'label' => 'Plugin color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#F60',

),

);

if( $params['for_editing'] )

{ // we're asked for the settings for editing:

if( $this->Settings->get('my_select') == 'mon' )

{

$r['a_disabled_one']['disabled'] = false;

}

}

return $r;

}

/**

function get_custom_setting_definitions( & $params )

{

return array(

'custom' => array(

'label' => 'Custom setting',

'note' => 'Custom plugin setting for collections, private messages and newsletters.',

'defaultvalue' => 'Custom value',

),

'custom_color' => array(

'label' => 'Custom color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#033',

),

);

}

/**

function get_coll_setting_definitions( & $params )

{

$default_params = array_merge( $params,

array(

'default_comment_rendering' => 'stealth',

'default_post_rendering' => 'opt-out'

)

);

$r = array_merge( parent::get_coll_setting_definitions( $default_params ),

array(

'coll_custom' => array(

'label' => 'Collection setting',

'note' => 'Custom plugin setting ONLY for collections.',

'defaultvalue' => 'Collection value',

),

'coll_color' => array(

'label' => 'Collection color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#0C9',

),

)

);

return $r;

}

/**

function get_msg_setting_definitions( & $params )

{

// set params to allow rendering for messages by default

$default_params = array_merge( $params, array( 'default_msg_rendering' => 'stealth' ) );

$r = array_merge( parent::get_msg_setting_definitions( $default_params ),

array(

'custom_msg' => array(

'label' => 'Message setting',

'note' => 'Custom plugin setting ONLY for messages.',

'defaultvalue' => 'Message value',

),

'msg_color' => array(

'label' => 'Message color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#393',

),

)

);

return $r;

}

/**

function get_email_setting_definitions( & $params )

{

// set params to allow rendering for emails by default:

$default_params = array_merge( $params, array( 'default_email_rendering' => 'stealth' ) );

$r = array_merge( parent::get_email_setting_definitions( $default_params ),

array(

'custom_email' => array(

'label' => 'Email setting',

'note' => 'Custom plugin setting ONLY for emails.',

'defaultvalue' => 'Email value',

),

'email_color' => array(

'label' => 'Email color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#DDF',

),

)

);

return $r;

}

/**

function get_shared_setting_definitions( & $params )

{

// set params to allow rendering for shared container widgets by default:

$default_params = array_merge( $params, array( 'default_shared_rendering' => 'stealth' ) );

$r = array_merge( parent::get_shared_setting_definitions( $default_params ),

array(

'custom_shared' => array(

'label' => 'Shared setting',

'note' => 'Custom plugin setting ONLY for shared container widgets.',

'defaultvalue' => 'Shared value',

),

'shared_color' => array(

'label' => 'Shared color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#DDF',

),

)

);

return $r;

}

/**

function get_widget_param_definitions( $params )

{

$r = array(

'title' => array(

'label' => T_('Block title'),

'note' => T_('Title to display in your skin.'),

'size' => 60,

'defaultvalue' => 'Test plugin widget',

),

'widget_color' => array(

'label' => 'Widget color',

'type' => 'color',

'note' => 'Click on the field to display a color selector.',

'defaultvalue' => '#F66',

),

);

return $r;

}

/**

function get_widget_cache_keys( $widget_ID = 0 )

{

global $Blog;

return array(

'wi_ID' => $widget_ID, // Have the widget settings changed ?

'set_coll_ID' => $Blog->ID, // Have the settings of the blog changed ? (ex: new skin)

'cont_coll_ID' => empty( $this->disp_params['blog_ID'] ) ? $Blog->ID : $this->disp_params['blog_ID'], // Has the content of the displayed blog changed ?

);

}

/**

function GetDefaultUserSettings( & $params )

{

return array(

'echo_random' => array(

'label' => 'Echo a random number in AdminBeginPayload event',

'type' => 'checkbox',

'defaultvalue' => '0',

),

'deactivate' => array(

'label' => 'Deactivate',

'type' => 'checkbox',

'defaultvalue' => '0',

),

);

}

/**

function GetDependencies()

{

return array(

'recommends' => array(

'events_by_one' => array( array('Foo', 'Bar'), array('FooBar', 'BarFoo') ), // a plugin that provides "Foo" and "Bar", and one (may be the same) that provides "FooBar" and "BarFoo"

'events' => array( 'some_event', 'some_other_event' ),

'plugins' => array( array( 'some_plugin', '1' ) ), // at least version 1 of some_plugin

),

'requires' => array(

// Same syntax as with the 'recommends' class above, but would prevent the plugin from being installed.

),

);

}

/**

function GetDbLayout()

{

global $DB;

return array(

'CREATE TABLE '.$this->get_sql_table( 'test_table_name' ).' (

) ENGINE = innodb DEFAULT CHARSET = '.$DB->get_connection_charset()

);

}

/**

function GetExtraEvents()

{

return array(

// Gets "min" and "max" as params and should return a random number in between:

'test_plugin_get_random' => 'TEST event that returns a random number.',

);

}

/**

function test_plugin_get_random( & $params )

{

return rand( $params['min'], $params['max'] );

}

/**

function GetHandledDispModes()

{

return array(

'disp_test', // display our test disp

);

}

/**

function HandleDispMode( $params )

{

echo '<p>This is the test plugin handling the ['.$params['disp'].'] disp mode.</p>';

}

/**

function GetHtsrvMethods()

{

return array( 'test_action' );

}

/**

function htsrv_test_action( $params )

{

global $DB;

// To call this action use URL which is generated by code:

// $htsrv_plugin_url = $this->get_htsrv_url( 'test_action', array( 'param_1' => 'value_1' ) );

if( empty( $params['param_1'] ) )

{ // Nothing to do:

return;

}

$param2 = param( 'param2', 'string' );

$DB->query( 'INSERT INTO '.$this->get_sql_table( 'test_table_name' ).'

( test_name ) VALUES ( '.$DB->quote( 'param_1 = '.$params['param_1'].'; param2 = '.$param2 ).' ) ' );

}

/**

function GetCronJobs( & $params )

{

return array(

array(

'name' => 'TEST plugin - cron job',

'ctrl' => 'test_job',

'params' => array( 'param' => 1 ),

),

);

}

/**

function ExecCronJob( & $params )

{

if( $params['ctrl'] == 'test_job' )

{

return array( 'code' => 1, 'message' => 'Test successful.' );

}

}

// }}}

/*

// Admin/backoffice events (without events specific to Items or Comments): {{{

/**

function AdminAfterEvobarInit()

{

// The following is a tiny bit hackish and should probably be abstracted a bit, but just a little bit

// The idea is too let plugins hook pretty much anywhere into the menu structure, including Left AND Right menus.

global $topleft_Menu;

$topleft_Menu->add_menu_entries( 'tools', array(

'urls_sep' => array(

'separator' => true,

),

'urls' => array(

'text' => 'Test plugin&hellip;',

'href' => $this->get_tools_tab_url(),

),

) );

}

/**

function AdminAfterMenuInit()

{

$this->register_menu_entry( 'Test tab' );

}

/**

function AdminEndHtmlHead( & $params )

{

echo '<!-- This comment was added by the TEST plugin event "AdminEndHtmlHead" with function "echo" -->';

add_headline( '<!-- This comment was added by the TEST plugin event "AdminEndHtmlHead" with function "add_headline"-->' );

add_js_headline( 'console.log( "This JavaScript log was added by the TEST plugin event \'AdminEndHtmlHead\' with function \'add_js_headline\'" )' );

add_css_headline( '/* This CSS was added by the TEST plugin event \'AdminEndHtmlHead\' with function "add_css_headline" */' );

return true;

}

/**

function AdminAfterPageFooter( & $params )

{

echo '<p class="footer">This is the TEST plugin responding to the AdminAfterPageFooter event!</p>';

return true;

}

/**

function AdminDisplayEditorButton( & $params )

{

?>

<input type="button" value="TEST" onclick="alert('Hi! This is the TEST plugin (AdminDisplayEditorButton)!');" class="btn btn-default" />

<?php

return true;

}

/**

function DisplayEditorButton( & $params )

{

?>

<input type="button" value="TEST" onclick="alert('Hi! This is the TEST plugin (DisplayEditorButton)!');" class="btn btn-default" />

<?php

return true;

}

/**

function AdminDisplayToolbar( & $params )

{

echo $this->get_template( 'toolbar_before', array( '$toolbar_class$' => $this->code.'_toolbar' ) );

echo $this->get_template( 'toolbar_title_before' );

echo 'TEST toolbar for Item:';

echo $this->get_template( 'toolbar_title_after' );

echo $this->get_template( 'toolbar_group_before' );

echo '<input type="button" class="'.$this->get_template( 'toolbar_button_class' ).'" value="TEST 1" onclick="alert(\'TEST 1\')" />';

echo '<input type="button" class="'.$this->get_template( 'toolbar_button_class' ).'" value="TEST 2" onclick="alert(\'TEST 2\')" />';

echo $this->get_template( 'toolbar_group_after' );

echo $this->get_template( 'toolbar_group_before' );

echo '<input type="button" class="'.$this->get_template( 'toolbar_button_class' ).'" value="TEST 3" onclick="alert(\'TEST 3 from second group\')" />';

echo $this->get_template( 'toolbar_group_after' );

echo $this->get_template( 'toolbar_after' );

return true;

}

/**

function AdminToolAction()

{

$this->msg( 'Hello, This is the AdminToolAction for the TEST plugin.' );

}

/**

function AdminToolPayload()

{

echo 'Hello, This is the AdminToolPayload for the TEST plugin.';

return true;

}

/**

function AdminTabAction()

{

global $Plugins;

$this->text_from_AdminTabAction = '<p>This is text from AdminTabAction for the TEST plugin.</p>'

.'<p>Here is a random number: '

.$Plugins->get_trigger_event_first_return('test_plugin_get_random', array( 'min'=>-1000, 'max'=>1000 )).'</p>';

if( $this->param_text = param( $this->get_class_id('text') ) )

{

$this->text_from_AdminTabAction .= '<p>You have said: '.$this->param_text.'</p>';

}

}

/**

function AdminTabPayload()

{

echo 'Hello, this is the AdminTabPayload for the TEST plugin.';

echo $this->text_from_AdminTabAction;

// TODO: this is tedious.. should either be a global function (get_admin_Form()) or a plugin helper..

$Form = new Form();

$Form->begin_form();

$Form->add_crumb( 'plugin_test' );

$Form->hidden_ctrl(); // needed to pass the "ctrl=tools" param

$Form->hiddens_by_key( get_memorized() ); // needed to pass all other memorized params, especially "tab"

$Form->text_input( $this->get_class_id().'_text', $this->param_text, '20', 'Text' );

$Form->button_input(); // default "submit" button

$Form->end_form();

return true;

}

/**

function AdminBeginPayload()

{

global $Plugins;

echo '<div class="panelblock center">TEST plugin: AdminBeginPayload event.</div>';

if( $this->UserSettings->get('echo_random') )

{

echo '<div class="panelblock center">TEST plugin: A random number requested by user setting: '

.$Plugins->get_trigger_event_first_return('test_plugin_get_random', array( 'min'=>0, 'max'=>1000 ) ).'</div>';

}

}

/**

function WidgetBeginSettingsForm( & $params )

{

$params['Form']->begin_fieldset( 'TEST plugin', array( 'id' => 'WidgetBeginSettingsForm' ) );

$params['Form']->info_field( 'TEST plugin', 'This is the TEST plugin responding to the WidgetBeginSettingsForm event for widget #'.$params['ComponentWidget']->ID.'.' );

$params['Form']->end_fieldset( 'Foo' );

return true;

}

/**

function WidgetEndSettingsForm( & $params )

{

$params['Form']->begin_fieldset( 'TEST plugin', array( 'id' => 'WidgetEndSettingsForm' ) );

$params['Form']->info_field( 'TEST plugin', 'This is the TEST plugin responding to the WidgetEndSettingsForm event for widget #'.$params['ComponentWidget']->ID.'.' );

$params['Form']->end_fieldset( 'Foo' );

return true;

}

// }}}

// Skin/Blog events: {{{

/**

function BeforeBlogDisplay( & $params )

{

$this->msg( 'This is the TEST plugin responding to the BeforeBlogDisplay event.' );

}

/**

function BeforeBlockableAction()

{

$this->msg( 'This is the TEST plugin responding to the BeforeBlockableAction event.' );

}

/**