Phase I (1 weeks)
Finalize the project specifications
Phase II (2 weeks)
- Backend workflow list view
- Backend workflow creation view
- Core plugin
- “com_content” component handler
Phase III (2 weeks)
- “Comments” custom field
- “File attachment” custom field
- Frontend task view
- Backend task view
Phase IV (2 weeks)
- ACL handling for “com_content”
Any remaining time before GSoC 2009 end will be used for debugging and stabilization
The following is a briefing of the specifications of my GSoC 2009 Project
The workflow extension I'll be working on will support the core content component and have the capacity to support other components (Content Types)
Document workflow will be broken down into a set of "stations" ,An item will be passed from one station to another in a particular order until reaching its final station after which an arbitrary operation will be preformed "e.g. Publish article".
MVC based, the core will act as a central controller for the whole extension, it is composed of two parts:
1. A conventional component
2. Core plugin: A system plugin that captures J! Triggers related to content saving and passes them down to “Component handlers” (See below)
Hooks will be implemented to allow developers to perform arbitrary actions when certain events occur, initially one hook will be implemented, this hook will be invoked upon transition from one station to the next.
They handle the rendering and storage of the “station” fields (e.g. comment fields, file attachments, etc...)
All component specific code will be placed here, these handlers act as a layer between the extension and the component whose content is being workflowed (e.g. com_content),
Each handler is composed of 2 files
1. An XML file that contains Meta data about the handler and a other parameters, among which is the “onSaveItem trigger name” which defines the name of the “J! Event” that is triggered when an item of the handler type is saved. (E.g. onAfterSave in com_content), the file also contains a list of supported “Final Actions”, which are the actions that can be taken when the item reaches its final destination (e.g. publish, delete, archive, etc…)
2. A php file containing implementation of the handler, it must implement the following methods ( Subject to change as needed )
• lockElement (id)
• unlockElement (id, gid)
• onItemEdit ()
• getItemRevision(id, rev)
More on getItemRevision()
If the component in question (e.g. com_content) does support version control, the method returns the requested version, if it doesn't, then the method simply ignores the $rev parameter and returns whatever stored in the DB.
The above list of methods is a preliminary list and is subject to change as development progresses
When the workflow is saved, the component’s onSaveItem trigger is registered with core plugin so that when the event is triggered the core plugin captures it and loads the correct component handler.
When working with workflows content is likely to be edited several times before reaching its final form, which raises the question of “versioning” , This extension will NOT handle version control of content elements that are being workflowed but will have internal support for version control should it be included in future versions of the content management.
This internal support will be provided through “component handler” plugins which allows each component to have its own way of dealing with version control if it supports it, and to ignore it if it doesn’t support it.
The Administrator wants to create a new workflow for publishing content in a particular set of categories.
The Administrator will use a backend screen to create that workflow; he can specify the categories/sections he wants to be workflowed.
The Administrator defines the “stations” and the custom fields for each station and saves the workflow.
User xyz posted an article, the onAfterSave event is triggered, the core plugin captures this event and loads the component handler that corresponds to the content type (com_content handler in this case)
The component handler for “com_content” locks the article for all groups of users and unlocks it for the ACL group of station 2.
In the process of transition between two stations, A hook is invoked, calling all registered handlers, One of these handlers will send an E-mail to station users about the item that waits processing.
Station 2 user logs into J! And accesses the “pending items” view (Accessible via frontend or backend), station 2 fills the custom fields assigned to the station (comment and file attachment) and passes the article up to station 3.
The core locks the article for everybody except station 3, the article proceeds in similar manner until it reaches its final destination where the “final action” will be decided, supported final actions will be "component handler" dependent, for com_content, I cannot think of anything aside from "publish, delete, move to category/section".
A word about the "views" :
My name is Mostafa Muhammad, I was born in Cairo on May the 4th , 1985, I’m an Egyptian Muslim, living in Cairo, I’m a final year Medical student at Al-Azhar university in Cairo. I was introduced to Mambo shortly before the Mambo/Joomla! Transition and have been developing for Joomla! ever since. I also served as a moderator of the Arabic forum for a period of time, I’m a 2008 GSoC Alumnus, My project in 2008 was a WYSIWYG Forms extensions for J! 1.5.
My project aims to provide a simple extensible workflow extension for Joomla! that will support the core content component and have the capacity to support other components, Workflow systems can become handy to a Joomla! administrator in certain scenarios , specially those that involve online magazines or community websites where content comes from different sources and content approval is multi-stepped.
Latest Blogs on Mostafa's Project
Mostafa's Project Links