Joomlapolis - The home of Community Builder - Re:CB Helloworld Plugin (part 2)

Joomlapolis Forums

home | post reply | flat view | help | rules

Re:CB Helloworld Plugin (part 2)
Date: 2006/11/13 08:08	By: nant	Status: Admin
Karma: 463

Admin

Posts: 6011

bjraines wrote:
have been reading several modules and plugins. I am trying to learn how to use the API correctly.

Great!

Now my question is
if you are pulling the message from the paramter why did you include it here. would it not pull the text of whatever was in the field in the plugin parameters? Also wouldnt it get the publish state. Why does it need to be stated?

Code:


    $is_helloworld_plug_enabled = $params->get('hwPlugEnabled', "1");

$helloworld_tab_message = $params->get('hwTabMessage', "Hello Joomlapolitans!");

The actual code is executed because the plugin is published.
The $params->get function retrieves the plugin or tab parameter specified in its first argument and if its value is null, then it gives it the default value specified in the second paramater (e.g., "1" or "Hello Joomlapolitans"). The reason this is needed is that when a plugin is initially installed the parameters are not saved in the CB plugin table. The parameters are saved if the user clicks save in the plugin parameters backend. So in order for the plugin to be safe and have all parameters with real values, all plugins should use this function and have all default values specified in XML replicated in the code. (the entire design is meant to support CB upgrades without losing plugin parameter settings)

also why is this needed at the beginning?

Code:


  
  $return = null;

I guess good practice. Always a good idea to initialize your variables.

Post edited by: nant, at: 2006/11/13 08:33

Nick A.
CB Core Team Member
Support CB Development and Get Detailed Documentation
Developer of Nant's Gallery plugin
CB Gallery Extensions Listing, Rate CB Gallery on Extensions Site
Developer of CB AutoWelcome Plugin
CB AutoWelcome Extensions Listing,Rate CB AutoWelcome on Extensions Site
People ignoring your call for help? Read this!
FAQ you
Joomlapolis Extensions Directory (new)- check it out!

The administrator has disabled public write access.

Topics

Author

Date

CB Helloworld Plugin (part 2)

beat

2006/10/29 02:45

Boardwalk :: Forum List Important Content Community Builder Article Discussions

Documentation

Download Latest Release

CB Login