Create a Plugin

With new plug-in system you will be able to:

1. Add custom widgets
2. Add new action in the Seotoaster's right-side admin panel
3. Add new custom routes (one route per plugin)

A. All plug-ins should be in the "plugins" directory in the root folder of seotoaster

B. Plugin structureedit header

PLUG-IN DIRECTORY SHOULD BE NAMED IN LOWERCASE

There are couple of files that your plug-in should have:

1. Main plug-in class file. This file should be named exactly as plug-in directory The name of this file should start with capital first letter. All other letters should be in lowercase.
2. readme.txt file. This file should contain plug-in description and/or some important information about your plug-in if needed
3. "system" folder.
4. SYSTEM FOLDER should contain 2 files:
   1. install.sql - Might contain sql queries that will be executed during the plug-in installation. Each query in this file should be separated by /*~query~*/ delimiter
   2. uninstall.sql - Might contain sql queries that will be executed during the plug-in deinstallation. Each query in this file should be separated by /*~query~*/ delimiter.
5. [optional but recommended if you want to add new items in the admin panel or add new routes] "config" folder.
   Config folder should contain "config.ini" file

After all your basic plugin structure should look like:
(let's assume that we are creating plugin called "Demo"). In this case my plugin folder will looks like:

C. Main plug-in file structure

In this example bellow our main plug-in class file is Demo.php. This class should implement RCMS_Core_PluginInterface According to this file, Demo.php should contain public method run

(Seotoaster try to call this method each time when it meets the plug-in) The second public method - constructor.

Full basic plugin main file code listing

LET"S CREATE A "HELLO WORLD" WITH OUR PLUGIN

Now let's add the following line into the "run" method of our plugin:

Now your plugin code should looks like

Now go to your Seotoaster site. On the admin panel open the "OTHER" section and click "enable" under your plugin. Then go and edit any content of your site and put . Save your content. After a page refresh you will see "Hello world".

In this overview I will use the basic plugin structure that I described in the previous part.

1. Plugin configuration file config.ini

The plugin configuration file might contain any data you want/need for your plugin. For example:

But you can add special sections in your config.ini and Seotoaster will recognize and process them. This sections are:

A. [cpanel] section ---> Allows you to extend Seotoaster's right-side admin panel with your items.
Example:

B. [route] section --> Allows you to extend Seotoaster's routes with your plugin's route.
Example:

2. Install & uninstall sql files

2.1. install.sql

Seotoaster will try to execute the install.sql file during the installation process. In this file you might add any sql queries you want but with one restriction - queries should be separated by the /*~query~*/ delimiter.
Example:

2.2. uninstall.sql

Seotoaster will try to execute the uninstall.sql file during the uninstallation process. In this file you might add any sql queries you want but with one restriction - queries should be separated by the /*~query~*/ delimiter. The good way to uninstall your plugin is to remove all additional fields/table/etc... that your plugin created.
Example:

In this part I'll continue working with the basic plugin structure:

A. Working with views

et's create a new directory and call it views. Inside of this directory create a new file called demo.phtml. Now our plugin folder will look like this:

Edit demo.phtml and put in it follwing lines:

Now edit your Demo.php. We will create an instance of Zend_View and ask plugin to work with it. Now __construct method of your plugin will look like:

Now let's go to the run method and work a bit with our new view object

Now (if you didn't do it yet) go to one of your seotoaster pages and in any content put Plugin demo doesn't exists (REMEMBER that you plugin should be enabled in Seotoaster plugin management screen: OTHER -> Plugins)

Refresh your page and you will see the results:

Since we use Zend_View as view engine we can use all its powerful features such as view helpers, etc...

B. Including javascript and css files

Let's modify our plugin structure by adding css and js folders. Now plugin structure will look like this:

We will use standart Zend view helpers to add our css and js file to our views: HeadScript and HeadLink. But first we will need to assign a website URL to our view, so, go to the your plugin's __construct method and add:

$seotoasterData - array that Seotoaster pass to your plugin __construct method. This array contain a lot of useful data and we recommend to discover it.

Now your plugin's constructor will look like:

Now go and edit your demo.phtml by adding following lines:

That's it.

Working with database

In the previous part we created the following plugin structure:

So, now let's teach our plugin to work with the database. Let's create a new directory called models and create a class, which will work with the database. Let's call it DemoModel.php after all actions plugin structure will look like:

Now we will edit DemoModel.php
To make your plugin model work with the seotoaster database you do not need to set up your connetcion or so, Seotoaster will do this for you. One thing you need is to extend your model from the seotoaster base model class RCMS_Core_BaseModel. So, your DemoModel.php should look like this:

That's it. Now you can start adding methods into your model, then require your DemoModel.php in your Demo.php. For example let's get all data from the Seotoaster's 'config' table. This table has two fields 'name' and 'value', so our method will be something like this:

Now lets use our model in Demo.php. Open Demo.php and add require statement at the top

then add following lines to the 'run' method

That's it, we read the config data from the database in associative array and assigned it to the view.