Translations of this page?:

About Plugins

The plugin architecture was introduced with Feng Office 1.4. As at Feng Office 2.1 the plugin framework has become more mature.

To learn what a plugin does and how it is installed the corresponding wiki page (if one available) and/or the readme file that should come with every plugin.

Once uploaded (but not necessarily installed nor activated) you can check the listing in the Plugin Manager (Feng Office 2.x) Administration → Plugins to find out more about the plugin, for example, a description, author name and website, version, etc.

Note: By default the plugin manager is not enabled. To enable it edit FENGOFFICE_ROOT/config/config.php and insert the following:

  define('PLUGIN_MANAGER', true);

Installing Plugins

Always read the plugin documentation and follow the install instructions.

To install a V2.x+ plugin the usual method is to upload the plugin, its sub-folders and files to the plugins folder on your Feng Office Server (for example ftp://mydomain.com/fengoffice/plugins/myplugin). Then launch the plugin manager: Administration→Plugins. Find the your new plugin in the list and click 'Install' and then 'Activate'. Refresh your browser window (Ctrl+F5).

Developing Plugins

If you wnat to develop your own plugins, see the developers documentation here

Discussion

PLEASE NOTE: Comments to the wiki should only contain suggestions and questions that help us to improve the manual (and not the software). These comments will be deleted as soon as the information has been integrated into the manual.

Posts that do not contribute to the DOCUMENTATION of the project will be DELETED.

Ask QUESTIONS on the product here.
Report BUGS here.
Propose NEW FEATURES here.


Cristian Salamea, 2010-09-22 22:30

hi folks, i found your app and looks great i want to know if there is any paper about plugins how write them.

and if you can open an irc channel would be a better in time way to communication.

best regards,

Francisco Ponce de León, 2010-09-24 13:51

Hi Cristian, we are glad you like Feng Office! We do have an IRC channel here, but regarding the Plugins documentation, I am afraid that you will find some in the hooks/plugins that already come with the source code!

Best regards,

Francisco

lexa, 2011-03-16 07:41

Hello

The two teams of Silex and amfPHP are mutualizing their efforts to develop a simple yet powerful plugins system for web applications. This is an initiative of Silex Labs, non profit organization ( see projects.silexlabs.org )

Below is a description of the project.

A prototype is already running in Silex. It allows this ria / web application, to list the available plugins form the exchange platform ( see exchange.silexlabs.org ) and to install it in one click. The application is then able to display notifications when the installed plugins have new versions, and to update them on demand.

In the other hand, the plugin creators can package and deploy their plugins with the help of the exchange platform. The versioning and the dependencies between plugins is handled automatically.

Thechnically, the exchange platform is a wordpress plugin, which turns a wordpress blog into a platform which can communicate with the php classes developed to handle plugin installation / update.

For the plugins itself, a small API has been set up in order to allow very easy interaction with a framework, such as Silex core, or amfPHP core. Hooks and filters are used to modify/enhance default system behavior. And these classes also offer a multilingual localization mechanism.

After this prototype has proven its efficiency, we will need to make it industrial, add/remove functionalities and make it more generic for use in other web applications. If one of the Feng Office developer wants to participate in the next iteration, to be part of the discussions about the specifications or even to help developing the missing parts, let us know by email a.hoyau at silexlabs.org

Bye, lexa.

Description

Because the web applications start to have sufficient maturity and robust structures. They start to become “big” projects with a lot of code and coders. More and more projects need to keep a clean and simple core code base, putting a lot of the secondary functionnalities into plugins. It makes it easyer to maintain and deploy an application, and it lets more developpers take part to the developpment, either they have new ideas, different needs, or less skills than the core team.

Be focused on the core code and team

Projects which could be interested

  • feng office
  • amfphp
  • silex
  • piwik
  • web2project

Anyone has more ideas?

Useful links

functionalities

plugins architecture

  • instanciation
  • hooks and filters
  • activation
  • configuration
  • localisation system (optional)
  • XML description file (generator, comparison, …)
  • unit tests?

plugins distribution

  • exchange platform
  • dependences between elements
  • installation / uninstall
  • update and versioning
Enter your comment
 
plugins.txt · Last modified: 2013-02-27 18:06 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported


Terms of Service | Copyright © 2014 fengoffice.com