Achievo/Howto/Developers/Create pim items: Difference between revisions

Revision as of 15:01, 27 May 2006

Author: Sandy Pleyte

Last modified: 17 March 2006

Complexity: Easy

Intro

In Achievo it's possible to create pip items in your own module. As of Achievo 1.2 it's possible for users to choose what pip items they want to show on they pip. This howto explains how to accomplish this.

Achievo 1.1 and below

If you want to add a pip item to your module, you should extend your module class with the following function:

   function getPimItems()
   {
     return "This is my Pim Item";
   }

If you want more then 1 pip item, you should collect the result and return it as one variable.

   function getPimItems()
   {
      $ret = "";
      $ret.= $this->getExample1();
      $ret.= $this->getExample2();
      return $ret;
   }

Achievo 1.2 and above

In Achievo 1.2 and above it's possible to specify 1 or more pip items for a module. To get this result you need to extend your module class with the following function:

   function getPimItems()
   {
     return array("example1"=>"getExample1",
                  "example2"=>"getExample2");
   }

   function getExample1()
   {
     return "Example 1 Pim item";
   }

   function getExample2()
   {
     return "Example 2 Pim item";
   }

As you can see in stead of returning the content for the pip, we now return an array with the pip item name and the function to call.