Joomla Component Development

.

Joomla Component Development
Author Prepared On Revision Approved By

Prabhu Patil

18th January, 2009

This document is solely meant for internal use of the designated programmers at “Carmel” development center and is classified as highly confidential. Please ensure that you don’t leave copies of this document on your local disk drives or circulate in any form without explicit permission. The only controlled copy of this document is the on-line version maintained on VSS server. It is the user's responsibility to ensure that any copy of the controlled version is current and complete, and that the obsolete copies are discarded.

Confidential – All rights reserved.

1

Joomla Component Development

.

Table of Content
Introduction:............................................................................................................................. 3 Section 1: The components' table in joomla's database ........................................................ 4 Section 2: The entry point....................................................................................................... 5 Section 3 – The backend tasks –The default task.................................................................. 8 Section 3.1 the default controller task (display)................................................................ 8 Section 3.2 The model - Getting the students from the DB............................................ 12 The code here it is (Model): ......................................................................................... 13 Section 3.3 - The view - Listing the students .................................................................. 24 Here’s the view code (list):........................................................................................... 24 Here it is: the view’s layout/template .......................................................................... 29 Section 4 – The backend tasks – The edit task.................................................................... 37 Section 4.1 – The controller task: edit ............................................................................. 37 Code for edit method: ................................................................................................... 37 Section 4.2 The model – Getting a student through its id............................................... 38 Section 4.3 The view – form to edit the student.............................................................. 38 Section 5: The backend tasks - Save .................................................................................... 46 Section 5.1 – The controller task: save ............................................................................ 46 Here’s the code (save() method in studentsController.php):...................................... 46 Here is the Code (saveStudent($student) method in …/models/students.php)......... 46 Section 5.2 JTABLE ......................................................................................................... 48 Section 5.3 The Model – Adding the save functionality ................................................ 50 Here is the Code (saveStudent($student) method in …/models/students.php)......... 50 Section 6: The backend tasks – The add task ...................................................................... 52 Section 6.1: The controller task: add ............................................................................... 52 Here’s the add() function in controller code: .............................................................. 52 Section 6.2: The view - Form to edit the student (revisited) .......................................... 52 Here’s the displayAdd() method in view.php code: ................................................... 53 Section 6.3: The model – New students........................................................................... 53 Here’s the getNewStudent() ..//models/students.php code:........................................ 53 Section 7: The backend tasks: The remove task.................................................................. 55 Section 7.1: The controller task: remove ......................................................................... 55 Here is remove() method code in studentsController.php.......................................... 55 Section 7.2: The model – Deleting students .................................................................... 55 Here is the deleteStudents() in ..//models/students.php.............................................. 55 Section 8: Installation............................................................................................................ 58 TEST:................................................................................................................................. 58

Confidential – All rights reserved.

2

Joomla Component Development

.

Component Development with Example: The Backend
Introduction:
This document is about a Joomla component named "Students" that manage our Students List, Add, Edit and Remove feature. This new version of Joomla (1.5) uses an approach to component development based on the Model-View-Component design pattern. So what is this of the Model View Controller pattern? Well, if you look for it in this book “Design patterns – Elements of Reusable Object Oriented Software” (Erich Gamma, et all), which is probably the most popular book about design patterns, you’ll find this: “MVC consists of three kinds of objects. The Model is the application object, the View is its screen presentation, and the Controller defines the way that the user interface reacts to the user input. Before MVC user interface designs tended to lump these objects together…” So the basic idea is that you have a Model of your data, that is unaware of the views that might exists to represent it, you have one or more views of that model that represent it, and you have a controller, which is responsible for receiving input from the views and updating the model. For creating our Joomla component we’ll have to write a model, a view and a controller for it We have to do the backend, which will allow us to manage our Students: List, Add, Edit and Remove them.

Confidential – All rights reserved.

3

Joomla Component Development

.

Section 1: The components' table in joomla's database
The first thing we’ll do is to insert a new record in the Joomla’s table that stores the installed components. By doing this you can test your component while you’re developing it, instead of coding it all. To do this you’ll have to have phpmyadmin or you can use the MySQL command line client. In phpmyadmin this is what you have to do: (I’m using version: 5.2.6 of phpmyadmin) 1. Open phpmyadmin and select the database that you’re using for your joomla installation; 2. Select the table jos_components (it might have a different prefix (jos_), you choose the prefix when you install joomla (jos is the default prefix); 3. Click on the insert tab; 4. Fill the Value column with the values: 1. name: Students 2. link: option=com_students 3. admin_menu_link: option= com_students 4. option: com_students And that’s it, the rest of the fields leave them with the default values. Note: If you want to use the MySQL command line client to do this, remember that option is a reserved keyword, so you have to write it like this `option` when you’re writing your SQL insert statement. Here’s what it should look like: INSERT INTO jos_components (name, link, admin_menu_link, `option`) VALUES (‘Students’, ‘option= com_students’, ‘option= com_students’, ‘com_students’) To use this SQL insert statement in the MySQL command line client you have to login, choose the right database (syntax: use DATABASE_NAME; to view the available databases write: show databases; ) and only then you can use it. So now, if you log in to your joomla site back end you should see, under the components tab, the “Students” component. If you click on it, you get an error (404 – Component not found). If this is what you got, everything is going well, and we can now start to build our component.

Confidential – All rights reserved.

4

Joomla Component Development

.

Section 2: The entry point
The first thing we have to do is the entry point. But for the backend the naming convention for the file that will contain the code of the entry point is different. Instead of being just the component name followed by “.php”, in the backend it’s: admin.[ComponentName].php. So in our case that will be: admin.students.php and it should be located in: Place where you’ve installed joomla/administrator/components/com_students/admin.students.php the entry’s point code in the backend is exactly the same as the frontend’s, here it is:

<?php // no direct access defined( '_JEXEC' ) or die( 'Restricted access' ); // Require the controller require_once( JPATH_COMPONENT.DS.'studentsController.php' ); // Create the controller $controller = new StudentsController(); // Perform the Request task $controller->execute( JRequest::getVar( 'task' ) ); // Redirect if set by the controller $controller->redirect(); ?>

Please note that JPATH_COMPONENT now gives you the path to the backend of our component, in this case: place where you’ve installed joomla/administrator/components/com_students Important this about this piece of code: The first line: defined(‘_JEXEC’) or die…: What this means is that if the constant ‘_JEXEC’ is not defined the application exits and the only thing you’ll see is the “Restricted Access” message.

Confidential – All rights reserved.

5

2: The JPATH_COMPONENT constant contains the frontend’s path to the component if your code is running in the frontend or it has the backend’s path to the component if your code is running in the back end. If you don’t use the setRedirect method in the controller. Second line of code.php (the method you should look for is render Component).php' ). DETAIL 2.” will load the controller we’ll do next. What you need to know about this is that JPATH_COMPONENT is a joomla constant that contains the path to where your component is.” this tells our soon to be created controller which task it should perform.php(backend) JPATH_COMPONENT: libraries/joomla/application/component/helper.1: The constant _JEXEC is defined in the index. Forth line: “$controller->execute( JRequest::getVar( 'task' ) ). What is important for you to know here is that if task is not defined in the URL the JRequest::getVar(‘task’) returns null.1.php file directly.DS. the redirect method just returns false. I’ll explain this better when we do the controller). JPATH_COMPONENT_SITE: same as above JPATH_COMPONENT_ADMINISTRATOR: same as above These last two constants contain the path to the frontend part of the component and the backend part of the component and are independent of JBASE_PATH. the JBASE_PATH constant that contains the path to the frontend if you’re in the frontend or the backend if you’re in the backend.'studentsController. Last line: “$controller->redirect(). by typing the URL: http://folder where you’ve installed joomla under apache’s htdocs folder/components/com_students/students. you’ll get that “Restricted Access” message because _JEXEC won’t be defined. and the execute method from the controller will execute the controller’s default task (the default task is display.php (frontend) and administrator/index.php file.php.” . so if you try to access the students.1.Joomla Component Development . The actual files where theses constants are defined are: JBASE_PATH: index. 6 . and DS is also a joomla constant that means “Directory Separator” (it’s defined this way to work both in windows and unix environments). This is because the JPATH_COMPONENT constant is defined using another constant. Confidential – All rights reserved. DETAIL 2. the “require_once(JPATH_COMPONENT.What you need to know about this is that you can setRedirect in the controller to the URL where the browser should redirect when this method is called.

Confidential – All rights reserved. which we will do next. it won’t work because we still have to define the controller. .Joomla Component Development And that’s the entry point. the view and the model. Don’t try this just yet. 7 .

/** * Students Component Administrator Controller */ class StudentsController extends JController { /** * Method to display the view * * @access public */ function display() { //This sets the default view (second argument) $viewName = JRequest::getVar( 'view'.php Here’s the code that handles the default task (display): <?php // no direct access defined( '_JEXEC' ) or die( 'Restricted access' ). //This sets the default layout/template for the view $viewLayout = JRequest::getVar( 'layout'. and then do the same for the models and views. and then do the other tasks (this way it is easier to test if everything is going well). edit. For example.controller'). let’s start with the controller. Confidential – All rights reserved. What I mean is that it is easier if we handle each task at a time. remove and display the list of students.Joomla Component Development . describe it. we do the code for the controller. It will have to deal with more tasks: add. 8 . jimport('joomla. I think the easiest way to do this is iteratively. So. 'list' ).1 the default controller task (display) Our backend controller will be more complex than our frontend’s. that will list the students.php we have to put it in the backend folder. It is easier to explain it this way than post all the code from the controller here. then do the model. do the view and test. We’ve called the file studentsController. Section 3 – The backend tasks –The default task Section 3. if we want to start with the display task. 'listlayout' ).component.application. so put the file here: Folder where you’ve installed joomla/administrator/components/com_students/studentsController.

$view->display(). This default JController’s display method does this: Confidential – All rights reserved.php located in libraries/joomla/application/component.php (Remember that the file name is lowercase) model file: folder where you’ve installed joomla/administrator/com_students/models/students.component. } $view->setLayout($viewLayout). that even if you name your model with uppercase character.php (Remember. so we redefine the display method. The rest is just creating the StudentsController class. What you need to know about this is that it will require_once the file named controller. “. Why did I do this? Just to tell you about the JController’s display method. true). The file and class names: • • • • • view file: folder where you’ve installed joomla/administrator/com_students/views/list/view.Joomla Component Development . To know how the classes and files for the model and view should be named (see below). // Get/Create the model if ($model = & $this->getModel('students')) { //Push the model into the view (as default) //Second parameter indicates that it is the default model for the view $view->setModel($model. $view = & $this->getView($viewName). the file name has to be all lowercase) model class name: StudentsModelStudents 2nd line of code: “jimport('joomla. 9 .application.php view class name: StudentsViewList view layout/template file: folder where you’ve installed joomla/administrator/com_students/views/list/tmpl/listlayout. that extends JController and redefining the JController’s display method to do exactly what JController’s display method does. } } The default task for the controller is display.controller'). This time we want to load a view named list and a model called students. This file contains the definition of the class JController that we are extending here.

o If there is no layout parameter in the request the default layout is called default. and all the HTML mixed with php code in the layout file. don't forget this so that you don't end up banging your head in the wall needlessly. and you forget that the layout file name has to be lowercase (so you name it listLayout. I wouldn’t call it layout or template though. So.patil@reachwell. listLayout.php Layout file name: views/[ViewNameLowercased]/tmpl/[LayoutNameLowercased]. some other important things that you also need to know about the view’s class name.php).php file name. for example. but as soon as you upload the component to your website powered by a Linux server it will stop working. I guess the people that developed the JView class(the class that we’ll extend to create our view)decided that it would be nice to have a separate file for the view class definition and the file that will have HTML that actually displays the view (with some php mixed in) . the lowercase part is really important! Because if you're working in Windows and you decide to name your layout. without HTML. you have an URL like this: index. 10 . Well. I haven’t told you about it. Gets the name of the view’s layout from the request o If the parameter layout is in the request. the view’s layout. You might be wondering right now. the view name will be ‘list’. so the view name is ‘students’. Confidential – All rights reserved.html.php About the [LayoutNameLowercased]. and you'll get an error saying the layout file is not found. In our Students component. for example you have an URL like this: index. shouldn’t that be two different views? That’s just how I see it anyway… Disagree? Feel free to email me(mailto:prabhu.php?option=com_students&view=list. the controller class name is StudentsController. and in the MVC. because it suggests that you can have two layouts for the same view. Why does this happen? Because file names in Windows environments are not case sensitive. the view’s file name and the layout’s file name that I haven’t told you: • • • The view’s class name [ControllerClassNameWithoutController]View[ViewName] The view’s file name is views/[ViewNameLowercased]/view. maybe I didn’t get it right! Now. but in Linux environments they are.net?subject=should not be two different views (MVC).php?option=com_students&view=list&layout=listlayout. What will happen is that it will work ok in your local windows machine. the view’s layout/template will be called listlayout. This way you have a view class file. o If there’s no view parameter in the request the view name will be the controller class name but without ‘Controller’. • Gets the name of the view: o If the parameter view is in the request. what is this thing.Joomla Component Development • .

php And these are the secrets behind the naming conventions in Joomla component development. it’s all defaults in this example: • . this will change all that I described earlier.Joomla Component Development In our case.php) [I don’t really know about DocumentType] View Class Name: StudentsViewStudents View Layout file: folder where you’ve installed joomla/components/com_students/views/students/tmpl/default. Note that this is the method that is called if there is no task parameter in the URL.php?option=com_students So.html. can’t really remember any reason why you want to change its default value… • default_task: remember I told you that the default task for the controller was display. that’s why if you use Confidential – All rights reserved. • • View Class file: folder where you’ve installed joomla/components/com_students/views/students/view.php View Class Name: StudentsViewList View Layout file: folder where you’ve installed joomla/components/com_students/views/list/tmpl/listlayout.[DocumentType].php (the view file name is always view. you can change that here.php Another example: index. I’ll take this chance to tell you about the default parameters that you can change. if you think there is something wrong or unclear feel free to let me know. Here you have it.2: Are you wondering why the views’ file and the layout file are under a folder called views and tmpl.html. the name you put here is used instead. Hope I didn’t forget anything. instead of parsing the name of the controller class to take out the “Controller” part.php?option=com_students&view=list&layout=listlayout • • • View Class file: folder where you’ve installed joomla/components/com_students/views/list/view. 11 the defaults you have to place your view files under this folder • . and the default folder where the views will look for layouts is tmpl. • base_path: usually has the path to the component. DETAIL 3. respectively? Well I did too. name: the controllers name. and the answer to that is: the default folder where the controller will look for the views is views.1. Because I’m describing the controller right now. in the JController’s contructor. if we have an URL like this: index. • view_path: default value is base_path/views. This is the folder where the controller will look for the models. • model_path: default value is base_path/models.

the model is named students. loads the view and model (with the rules I described above). 12 . Remember.php class name: StudentsModelStudents Confidential – All rights reserved. From now on. as ModelName. So. Remember. so you can access the model through the view as we’ll see later. if the parameter view is present in the request URL. If you use the default JController’s display method the name of the view and the name of the model have to be the same. The view gets linked to the model. So. the file that contains the definition of the model should be named [ModelName]. there’s the how the model file is loaded and how the model class should be named. the default view name is the controller’s name without “Controller” if the parameter view is not present in the URL. Next.php and be located in models/. file name: folder where you’ve installed joomla/administrator/components/com_students/models/students. I’ll refer to the model name.Getting the students from the DB Let’s create our model with a method to load all the students in the database and return them in an array. As a curiosity.2 The model . so that we can display them in the view. I still haven’t finished explaining the JController default display method that we’re using. then the view name will have the value specified in the url. the default display method. I’ll show you an alternative to using the JController’s default display method: Section 3. and in the end calls the view’s display method (we’ll look at it when we create the view). So a lot goes on in the Controller that at first glance you might not be aware of.Joomla Component Development . The class name should be [ControllerNameWithoutController]Model[ModelName]. Did I lose you? Well. whose default value is the view name or the view parameter value in the url. or.

13 . /** * Constructor Confidential – All rights reserved. /** * Pagination object * @var object */ var $_pagination = null. jimport('joomla. The code here it is (Model): <?php //No direct acesss defined('_JEXEC') or die().model').component. /** * Items total * @var integer */ var $_total = null.application.Joomla Component Development . class StudentsModelStudents extends JModel { /** * Category ata array * @var array */ var $_data = null.

14 . global $mainframe. 0. $limitstart = $mainframe->getUserStateFromRequest($option. adjust it $limitstart = ($limit != 0 ? (floor($limitstart / $limit) * $limit) : 0).Joomla Component Development * * @since 1. .limit'.'. $this->setState('limit'. $limit). 'limitstart'. 'int'). // Get pagination request variables $limit = $mainframe->getUserStateFromRequest('global.5 */ function __construct(){ parent::__construct(). 'int'). $this->setState('limitstart'. $limitstart). $option. 'limit'.limitstart'. } /** * Method to get Students item data * * @access public * @return array */ Confidential – All rights reserved. // In case limit has been changed. $mainframe->getCfg('list_limit').list.

} return $this->_total. 15 . } . } return $this->_data. $this->_data = $this->_getList($query.Joomla Component Development function getData(){ // if data hasn't already been obtained. Confidential – All rights reserved. load it if (empty($this->_data)) { $query = $this->_buildQuery(). $this>getState('limit')). $this->_total = $this->_getListCount($query). $this->getState('limitstart'). /** * Method to get the total number of student items * @access public * @return integer */ function getTotal() { // Lets load the content if it doesn't already exist if (empty($this->_total)) { $query = $this->_buildQuery().

Joomla Component Development } /** * Method to get a pagination object for the Students * * @access public * @return integer */ function getPagination() { // Lets load the content if it doesn't already exist if (empty($this->_pagination)) { jimport('joomla. function _buildQuery() { // Get the WHERE and ORDER BY clauses for the query $where $orderby = $this->_buildContentWhere(). } . 16 . Confidential – All rights reserved. } return $this->_pagination. $this->_pagination = new JPagination( $this->getTotal(). $this>getState('limitstart'). = $this->_buildContentOrderBy(). $this->getState('limit') ).pagination').html.

return $query.' Confidential – All rights reserved.'filter_order_Dir'.' '.$filter_order_Dir.'filter_order'.$filter_order_Dir. a.'filter_order_Dir'.students_firstname'.students_firstname .$orderby . } = ' ORDER BY '.$where . } else { $orderby a. function _buildContentOrderBy() { global $mainframe.'filter_order'. 'cmd' ).'.ordering '.$filter_order.'a. } return $orderby. if ($filter_order == 'a. $option. ''. } .students_firstname'. $filter_order = $mainframe->getUserStateFromRequest( $option. = ' ORDER BY a. 17 .students_firstname'){ $orderby '.Joomla Component Development $query = ' SELECT * from #__student AS a ' . 'word' ). $filter_order_Dir = $mainframe->getUserStateFromRequest( $option.

'filter_order'. if ($search) { $where[] = 'LOWER(a. false ).$db->Quote( '%'.published = 1'. ). true ).'filter_order_Dir'. 18 .students_firstname) LIKE '. 'word' ).'filter_state'. 'cmd' ). 'int' ). = $mainframe->getUserStateFromRequest( 'filter_state'.Joomla Component Development function _buildContentWhere() { global $mainframe. $search >getUserStateFromRequest( $option. $filter_order_Dir = $mainframe->getUserStateFromRequest( $option.$db->getEscaped( $search.'search'. $where = array(). ''.'%'. 'string' ). 'filter_active'. } if ( $filter_state ) { if ( $filter_state == 'P' ) { $where[] = 'a. $db $filter_state $option. $filter_order = $mainframe->getUserStateFromRequest( $option. 'filter_order'.'filter_active'.students_firstname'. ''. $option. 'filter_order_Dir'. $filter_active = $mainframe->getUserStateFromRequest( $option. = JString::strtolower( $search ). $search = $mainframe'search'. 'word' . 'a. ''. } else if ($filter_state == 'U' ) { Confidential – All rights reserved. 0. =& JFactory::getDBO().

$id. if ($student === null) JError::raiseError(500. } function getStudent($id){ $query = 'SELECT * FROM #__student'. = ( count( $where ) ? ' WHERE '. . } $where $where ) : '' ). $db = $this->getDBO(). } } if ($filter_active > 0) { $where[] = 'a. $db->setQuery($query).Joomla Component Development $where[] = 'a. $student = $db->loadObject().$id.(int) $filter_active.students_active = '. ' WHERE id = '. implode( ' AND '.published = 0'. return $where. 'Student with ID: '. else return $student. 19 .'). } /** Confidential – All rights reserved.' not found.

'Error binding data: '. Table class name $studentTableRow =& $this->getTable('students'). } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500. } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError().$errorMessage). Here students is not a table name. 'Invalid data').Joomla Component Development * Method to store a Student in the DB * @access public */ function saveStudent($student) { //Parameter not necessary because our model is named StudentsModelStudents (used to ilustrate that you can specify an alternative name to the JTable extending class) //getTable('students'). // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500. 20 . 'Error binding data'). } Confidential – All rights reserved. JError::raiseError(500. .

$studentTableRow->students_schoolname = ''. $studentTableRow->id = 0. $studentTableRow->students_city = ''. 21 . $studentTableRow->students_zip = ''. $studentTableRow->students_email = ''. $studentTableRow->students_uid = 0. Table class name $studentTableRow =& $this->getTable('students'). /** * Method that returns an empty student with id 0 * @access public */ function getNewStudent(){ //getTable('students'). $studentTableRow->students_street = ''. $studentTableRow->students_state = ''. $studentTableRow->students_grade_id = 0. $studentTableRow->students_firstname = ''. Here students is not a table name. $studentTableRow->students_schoolstate = ''.Joomla Component Development //If we get here and with no raiseErrors. then everythign went well } . $studentTableRow->students_lastname = ''. Confidential – All rights reserved.

$studentTableRow->studetns_deleted = 0. $studentTableRow->students_requirements = ''. $studentTableRow->students_p1_relationship = ''. $studentTableRow->students_p1_phone2 = ''. Confidential – All rights reserved. $studentTableRow->students_p2_phone1 = ''. $studentTableRow->students_p2_relationship = ''.Joomla Component Development $studentTableRow->students_timezone = ''. $studentTableRow->students_active =0. $studentTableRow->students_p1_email = ''. $studentTableRow->students_p1_email = ''. $studentTableRow->students_p2_lastname = ''. $studentTableRow->students_p1_phone1 = ''. $studentTableRow->students_p2_firstname = ''. . $studentTableRow->students_p2_email = ''. $studentTableRow->students_p2_phone2 = ''. $studentTableRow->students_gender = ''. 22 . $studentTableRow->students_observedst = 0. $studentTableRow->students_phone1 = ''. $studentTableRow->students_p1_firstname = ''. $studentTableRow->students_phone2 = ''. $studentTableRow->students_type = 0. $studentTableRow->students_created_on = ''. $studentTableRow->students_p1_lastname = ''.

implode('. JError::raiseError(500. $db->setQuery($query).$errorMessage). } function deleteStudents($arrayIDs) { $query = "DELETE FROM #__student WHERE id IN (". $db = $this->getDBO(). return $studentTableRow. $arrayIDs). Confidential – All rights reserved.")". } } } ?> This code included pagination & filter both we will discuss later. 'Error deleting students: '.'.Joomla Component Development . if (!$db->query()){ $errorMessage = $this->getDBO()->getErrorMsg(). 23 .

php (Remember that the view file is not called view. Confidential – All rights reserved. then make that list of students available for the view’s layout/template and then use the JView default display method to output the html generated by the layout/template.php Here’s the view code (list): <?php // no direct access defined( '_JEXEC' ) or die( 'Restricted access' ).Joomla Component Development . Section 3. Note that we will be returning from the model not a list of strings. 24 . The attributes will be id. global $mainframe. etc. the view type).view'). JToolBarHelper::deleteList().php because we use the getView method in the controller without specifying its second parameter. but a list of objects created from what was returned from the database. 'generic.application. $option. =& JFactory::getURI(). JToolBarHelper::editListX(). /** * HTML View class for the Students Component (List) * * @package Students */ class StudentsViewList extends JView { function display() { JToolBarHelper::title('Students Manager'. students_firstname. $db $uri =& JFactory::getDBO().html.component. I’ll call those objects row and you’ll see that each attribute they have corresponds to a database field from the table we’ve created for our component.Listing the students This view will access the model to get the list of students. JToolBarHelper::addNewX(). The files and classnames for the view: view file: folder where you’ve installed joomla/administrator/components/com_students/views/list/view. view class name: StudentsViewList layout file: folder where you’ve installed joomla/administrator/components/com_students/views/list/tmpl/listlayout.png').The view . jimport( 'joomla.3 .

$db->loadObjectList() ). = & $this->get( 'Total'). 'students_active'. $pagination). 'string' ). 'int' ). $search = $mainframe->getUserStateFromRequest( $option. $items). $filter_active = $mainframe->getUserStateFromRequest( $option. $filter_state JFactory::getUser()). '0'. 25 . $catlist[] = JHTML::_('select. $lists). = & $this->get( 'Pagination' ). $javascript ). 'filter_order'. $filter_order_Dir = $mainframe->getUserStateFromRequest( $option.option'. //Push data into the template $this->assignRef('user'. } } = JHTML::_('grid. 'active'.submit(). // build list of active //$javascript = 'onchange="document. $sql = 'SELECT DISTINCT students_active FROM #__student'. $lists['order'] = $filter_order.'filter_order_Dir'."'. ''. $this->assignRef('items'. 0. 'filter_state'.adminForm. $catlist = array_merge( $catlist. 'search'. $db->setQuery($sql). 'a.adminForm. // Get data $items $total $pagination from the model = & $this->get( 'Data').'id'. intval( $filter_active). // search filter $lists['search']= $search. $this->assignRef('pagination'. // build the active list $db =& JFactory::getDBO(). 'filter_order_Dir'. $catlist.state'. Confidential – All rights reserved.genericlist'. // table ordering $lists['order_Dir'] = $filter_order_Dir. 'class="inputbox" size="1" onchange="document. $filter_order = $mainframe->getUserStateFromRequest( $option.'filter_order'. $search = JString::strtolower( $search ). 'students_active' ).submit(). 'word' ). 'id'.active'.'search'. $lists['active'] = JHTML::_('select."'. $option.Joomla Component Development $filter_state = $mainframe->getUserStateFromRequest( $option. 'filter_active'. $this->assignRef('lists'. parent::display(). 'cmd' ).students_firstname'. // state filter $lists['state'] ). JText::_( 'Select Active -' ). 'filter_active'. intval( $filter_active ) ). . //$lists['active'] = JHTML::_('list. ''. ''.'filter_state'.'filter_active'. 'word' ).

}else{ hideMainMenu(). assume you have a hidden field named boxchecked that contains the number of selected items. like the button generated with editListX. JToolBarHelper::addNewX() add a delete.Joomla Component Development ?> . Some buttons.value==0){alert('Please make a selection from the list to edit'). and it will be updated automatically. submitbutton('edit')}" class="toolbar"> <span class="icon-32-edit" title="Edit"> </span> Edit </a> </td> First. For example. JToolBarHelper::editListX(). this view we’re doing right now will display a list of students. When you press these buttons some javascript is executed that will eventually submit the form we will define in layout/template file for this view. Figure 1 – Toolbar But it is not too hard to use. There are a few naming conventions used here that will become clear as soon as I show you an example of the html and javascript generated for one of those buttons. Some new things here: the toolbar code. it just has to be defined in the form. the first line (JToolBarHelper::title) sets the title you’ll see in the toolbar. in our component.adminForm. the html form (defined in the layout/template we’ll do next) has to be named adminForm. The JToolBarHelper::deleteList(). and the image (generic. The first four lines in the display method output the javascript/html that will make up the toolbar for our component (Figure 1). so boxchecked will contain the number of students selected (you don’t have to worry about updating boxchecked. This is always true for all forms that you do in the backend. 26 .png that you can find in folder where you’ve installed joomla/administrator/images). I’ll tell you how that happens when we see the form in the layout/template file). They are always assumed to be named adminForm. Confidential – All rights reserved. For example the editListX: <td class="button" id="toolbar-edit"> <a href="#" onclick="javascript:if(document. so don’t worry.boxchecked. edit and add buttons to the toolbar.

For example. This is necessary so that when the form is submitted you get an url equivalent to this (using our component as an example and the edit task): index. 27 . . We’ll also have to add a hidden field name option that contains the name of the component prefixed by “com_”. hence the option hidden field. the buttons call a joomla javascript function named submitbutton that has one parameter called pressbutton. which are alternative versions of editList and addNew. You also know that we have to list the students. when we press the edit button created by the JToolBarHelper::editListX the submitform will be called with the parameter edit: submitbutton(‘edit’). Confidential – All rights reserved. Finally.php?option=com_students&task=edit (This is not actually true. because all the other buttons will be inactive. hence the task hidden field). task and hidemainmenu. So now. So you see that we also have to have a hidden field named task in our form. because we’ll POST the form but the important thing here to remember is that joomla needs to know which component is being executed. joomla makes the administrator menu (Site Menus Content Components … ) inactive.Joomla Component Development We used editListX (and addNewX). and which task is going to be executed for that component. and that there are a few naming conventions that we’ll have to follow. This is useful when you’re adding or editing (in our case students) because the user will have to click on one of the buttons you put in the toolbar (typically Save and Cancel). When the form is submitted and if hidemainmenu is in the request and has a value of 1. The difference between them is that the X versions also calls a javascript function named hideMainMenu that will set the value of a hidden input in the form (if that input exists) named hidemainmenu to 1. we’ll see all that next. option. you know that we have to do a layout/template for this view with a form named adminForm and 4 hidden fields named boxchecked. and then submits the adminForm. What this javascript function does is it sets a hidden field named task in the adminForm form (in this example with ‘edit’).

$alt = 'Save') Fields that have to be defined in the form: task. deleteList($msg = ''.1: You can check the code of JToolBarHelper here: Joomla Component Development folder where you’ve installed joomla/administrator/includes/toolbar. DETAIL NOTE 3. publish($task = 'publish'. cancel($task = 'cancel'. $alt = 'Unpublish') Fields that have to be defined in the form: task. unpublish($task = 'unpublish'. $alt = 'Unpublish') Fields that have to be defined in the form: task.2: You can check the joomla javascript (hideMainMenu. Here’s a list of the most common button generator methods from JToolBarHelper and what they do to the form (see the toolbar code for all the buttons): back($alt = 'Back'.') – Generates a button that when you click on it makes the browser go to the previous page.php. $task = 'remove'.3. (the $alt is the text that is displayed below the button). publishList($task = 'publish'. $alt = 'Edit') Fields that have to be defined in the form: task. addNew($task = 'add'. hidemainmenu. Fields that have to be defined in the form: task. $href = 'javascript:history. editList($task = 'edit'. $alt = 'Delete'). $alt = 'New') same as above.When$msg is not empty. boxchecked. a confirm box will display the message $msg.DETAIL NOTE 3. $alt = 'Publish') Fields that have to be defined in the form: task. $alt = 'Edit') Fields that have to be defined in the form: task. save($task = 'save'. $alt = 'Publish') – Note that the task string used in this one is the same as the one above.back(). $alt = 'New') – Generates a Add button.js Confidential – All rights reserved. But causes the menu to stay inactive.3. editListX($task = 'edit'. . submitform) in here: folder where you’ve installed joomla/includes/js/joomla. 28 . addNewX($task = 'add'.javascript. Fields that have to be defined in the form: task. unpublishList($task = 'unpublish'. Fields that have to be defined in the form: task. boxchecked. boxchecked. boxchecked. submitbutton. hidemainmenu. $alt = 'Cancel') Fields that have to be defined in the form: task.

$this->lists['order_Dir'].students_lastname'.students_firstname'.form.this.sort'.Joomla Component Development .php <?php // no direct access defined('_JEXEC') or die('Restricted access').?>" class="text_area" onchange="document. 'a. ?> </th> <th> <?php echo JHTML::_('grid. 'a.value=''." /> <button onclick="this. 'Last Name'. ?></button> </td> <td nowrap="nowrap"> <?php echo $this->lists['state']. $this->lists['order_Dir']. ?> </th> <th> Confidential – All rights reserved.php" method="POST" name="adminForm"> <tr> <td align="left" width="100%"> <?php echo JText::_( 'Filter' ). $this>lists['order'] )."><?php echo JText::_( 'Go' ).this.submit(). $this>lists['order'] ). It displays the list of students read from the DB (Figure 2).submit(). The file should be here: folder where you’ve installed joomla/administrator/components/com_students/views/list/tmpl/listlayout.form. $this>lists['order'] ).value=''. echo $this->lists['active']. ?></th> <th width="10"><input type="checkbox" name="toggle" value="" onclick="checkAll(<?php echo count($this>items).sort'. ?>: <input type="text" name="search" id="search" value="<?php echo $this->lists['search']."><?php echo JText::_( 'Reset' ).form. ?> </td> </tr> <table class="adminlist"> <thead> <tr> <th width="10"><?php echo JText::_( 'NUM' ). ?>)" /></th> <th> <!--First Name--> <?php echo JHTML::_('grid. ?> </th> <th> <?php echo JHTML::_('grid.adminForm.submit(). ?></button> <button onclick="document. 'First Name'. $this->lists['order_Dir']. 'a.students_uid'. 29 . ?> <form action="index. 'User Name'.getElementById('search').getElemen tById('filter_state').sort'. Here it is: the view’s layout/template.

$this>lists['order'] ).Joomla Component Development <?php echo JHTML::_('grid. 'Phone'. ?> </th> <th> <?php echo JHTML::_('grid. 'a. ?> </th> <th> <?php echo JHTML::_('grid. $row. ?> </th> <th> <?php echo JHTML::_('grid. 'published'.php?option='.published'. $i ). ?></td> . $n=count( $this->items ). Confidential – All rights reserved. 'Email ID'. 'Active'. $this->lists['order_Dir']. ?> </th> </tr> </thead> <tfoot> <tr> <td colspan="9"> <?php echo $this->pagination>getListFooter().sort'. $row. $this->lists['order_Dir'].students_active'. $row->id).'&task=edit&cid[]='. 'Student Type'. ?> <tr class="<?php echo "row$k". $i ). 'a. $this->lists['order_Dir']. for ($i=0.sort'. $i.published'.?></td> <td><?php echo $checked. $this->lists['order_Dir']. //$checked = JHTML::_('grid. $published = JHTML::_('grid. $this->lists['order_Dir'].students_email'. $this>lists['order'] ).id'. 'a. $link = JRoute::_( 'index. 'a.ordering').students_type'. $this->lists['order'] ). 'a.JRequest::getVar('option'). $row->id.sort'. $ordering = ($this->lists['order'] == 'a.'&hidemainmenu=1' ).sort'.?>"> <!--<td><?php echo $row->id. $this->lists['order'] ).students_phone1'. $this>lists['order'] ). ?> </td> </tr> </tfoot> <tbody> <?php $k = 0. 30 .checkedout'. $i++) { $row = &$this->items[$i]. $checked = JHTML::_('grid. $i < $n. ?> </th> <th> <?php echo JHTML::_('grid.sort'.

?>"> <a href="<?php echo $link. $row->checked_out ) ) { echo $this>escape($row->students_firstname).?>"><?php echo $row->students_uid.?></a></td> <td align="center"><a href="<?php echo $link.?>"><?php echo $row->students_email.?>::<?php echo $this->escape($row->students_firstname).?>"><?php echo $row->students_active. 31 .?></a></td> <td align="center"><a href="<?php echo $link. ?>"> <?php echo $this>escape($row->students_firstname).?>"><?php echo $row->students_phone1. } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). $row->checked_out ) ) { echo $this>escape($row->students_lastname). } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ).?></a></td>--> <td> <?php echo $this>pagination->getRowOffset( $i ).Joomla Component Development <td align="center"><a href="<?php echo $link.?>"><?php echo $row->students_type. ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id').?>::<?php echo $this->escape($row->students_firstname).?></a></td> <td align="center"><a href="<?php echo $link. ?>"> <?php echo $this>escape($row->students_lastname). ?></a></span> <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id').?></a></td> <td align="center"><a href="<?php echo $link. ?>"> <a href="<?php echo $link.?></a></td> <td align="center"><a href="<?php echo $link.?>"><?php echo $row->students_lastname. ?> </td> <td> <?php echo $checked. ?></a></span> . Confidential – All rights reserved.?>"><?php echo $row->students_firstname.?></a></td> <td align="center"><a href="<?php echo $link.

?>"> <a href="<?php echo $link. Confidential – All rights reserved. ?>"> <?php echo $this>escape($row->students_email).?>::<?php echo $this->escape($row->students_firstname). ?>"> <a href="<?php echo $link. ?>"> <a href="<?php echo $link. $row->checked_out ) ) { echo $this>escape($row->students_uid).?>::<?php echo $this->escape($row->students_firstname).?>::<?php echo $this->escape($row->students_firstname). $row->checked_out ) ) { echo $this>escape($row->students_email).Joomla Component Development <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). ?></a></span> <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). ?>"> <?php echo $this>escape($row->students_phone1). } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). 32 . } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). ?></a></span> . } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). ?>"> <?php echo $this>escape($row->students_uid). ?></a></span> <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). $row->checked_out ) ) { echo $this>escape($row->students_phone1).

?></a></span> <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). ?>"> <?php echo $this>escape($row->published). ?>"> <a href="<?php echo $link. ?>"> <a href="<?php echo $link.?>::<?php echo $this->escape($row->students_firstname). $row->checked_out ) ) { echo $this>escape($row->students_active). $row->checked_out ) ) { echo $this>escape($row->students_type). ?>"> <a href="<?php echo $link. } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ).?>::<?php echo $this->escape($row->students_firstname).Joomla Component Development <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). ?></a></span> <?php } ?> </td> <td> <?php if ( JTable::isCheckedOut($this->user->get ('id'). ?>"> <?php echo $this>escape($row->students_active).?>::<?php echo $this->escape($row->students_firstname). } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). } else { ?> <span class="editlinktip hasTip" title="<?php echo JText::_( 'Edit Student' ). Confidential – All rights reserved. ?>"> <?php echo $this>escape($row->students_type). ?></a></span> . 33 . $row->checked_out ) ) { echo $this>escape($row->published).

?>" /> <?php echo JHTML::_( 'form.$k. ?>" /> <input type="hidden" name="filter_order_Dir" value="<?php echo $this->lists['order_Dir']. First.Joomla Component Development <?php } ?> </td> </tr> <?php $k = 1 . ?> </form> .php and the name of the form has to be adminForm. Joomla templates have sufficient material for several tutorials. } ?> </tbody> </table> <input type="hidden" name="option" value="<?php echo JRequest::getVar( 'option' ). because we’re working in the backend. so just trust me about using that css class. If you want. the adminlist css class is defined in a backend template. The html table’s css class: adminlist is a css class name used in joomla. the form action is index. I don’t think template details are very important here. have Confidential – All rights reserved. 34 . and a few more that I’ll mention.token' ). //$i++. Figure 2 – List the students There are a few things you have to know.?>"/> <input type="hidden" name="task" value=""/> <input type="hidden" name="boxchecked" value="0"/> <input type="hidden" name="hidemainmenu" value="0"/> <input type="hidden" name="filter_order" value="<?php echo $this->lists['order']. In this case. The css classes are defined by joomla templates.

$row->id). $i. This will work if we respect joomla’s naming conventions for the checkboxes. generates that for you. There are a few things you need to know about that checkbox. JHTML is used to generate the html for several html elements DETAIL NOTE 3. $row->id).Joomla Component Development a look at the css from the default template for the backend that comes with joomla 1. and then it goes through the checkboxes with id cbX. cb1. etc. but still it’s good practice to use it because if you want to reuse some of the code in the frontend you won’t have to worry about the urls .php?option=com_students&task=edit&cid[]=ID_OF_THE_ROW_WE_WANT_TO _EDIT&hidemainmenu=1. Its behaviour is that when you click on it. that also happens when we click the edit button because we use JToolBar::editListX : the X version of editList). where X goes from 0 to the number you pass as argument to checkAll-1. This is a php thing: when you add ‘[]’ to the name of a checkbox and you have several checkboxes with that same name followed by ‘[]’ you can read an array from the request with the value of the checked checkboxes.css and general_rt. However. the files that define the class adminlist are general.5.3: If you see the actual HTML generated when you do JHTML::_('grid. But fortunately. SEF doesn’t work on the backend so you won’t see any difference in the url.id'.5 (named khepri). you don’t have to worry about that because the code: JHTML::_('grid.js. when we read cid from the request we’ll get an array that contains the values of the checked checkboxes. First.javascript. 35 .The hidemainmenu parameter is set to 1 in the url so that the joomla’s administrator menu stays disabled when editing (remember. since joomla 1. In our case. you’ll see that the name of the checkboxes is actually cid[].id'. So now you know that the checkboxes to select each individual item have to have an id: cb0. Each of the students displayed is a link. cb2. Confidential – All rights reserved. the css is in folder where you’ve installed jooma/administrator/templates/khepri/css. that when you click on it redirects you to the url: index. and what it does is that it checks to see if a checkbox named toggle inside a form named adminForm is checked or not. and checks or unchecks them depending on the of checkbox named toggle being checked or not. The checkAll javascript method is defined in folder where you’ve installed joomla/includes/js/joomla. We should do that because the ‘_’ method from JRoute rewrites the url to a Search Engine Friendly(SEF) form if SEF is enabled in Joomla (To enable SEF go to Site->Global Configuration). We’re using JRoute’s ‘_’ function to build the url. the number of items are the students). you select/deselect all items (in our case students). $i. and it’s onclick event handler has to be checkAll([Number of items listed]) (in our case. . this checkbox has to be named toggle. The table header will display something like this: # [checkbox] First Name (Figure 2).css.3.

$row->id). followed by a checkbox that was generated by JHTML::_('grid. in the form of a link that. 36 . $i. if it is being unchecked it subtracts 1. DETAIL NOTE 3.javascript. What it does is if the checkbox is being checked it adds 1 to the boxchecked adminForm’s hidden input. The javascript isChecked method is the one that updated boxchecked hidden input field. The rest is each table row displays the student’s id. when pressed will create a request for our backend’s component with the task edit and with the parameter cid (that will be an array) with the value of the id of the student we want to edit (we still have to code the edit task). $row->id).checked).4: This note is about how the boxchecked hidden field is updated.id'.Joomla Component Development .js. You can see the code for isChecked here: folder where you’ve installed joomla/includes/js/joomla.3. Confidential – All rights reserved. and then the actual student." type="checkbox"> . The code generated by JHTML::_('grid. About the actual listing of the students (the foreach’s code). each student). we’re using a trick to change the css class of every <TR>. $i.id'. The css classes row0 and row1 have different background colors making it easier for you to distinguish between each item in the list (in our case. is something like this: <input id="cb0" name="cid[]" value="1" onclick="isChecked(this.

'default'. // Get/Create the model if ($model = & $this->getModel('students')) { Confidential – All rights reserved. I’m not reading the viewname and layout from the request in this task. We’ll call a method named displayEdit in the view and pass the id of the student as a parameter to it (we’ll do the view’s displayEdit method in Section 4. Remember that our controller file is named studentsController. Code for edit method: function edit(){ //getVar(PARAMETER_NAME.2). 'array' ). } $studentId = (int)$cids[0].php. TYPE) //The HASH is where to read the parameter from: //The default is its default value: getVar will look for the parameter in //GET. Especially because if we’re just editing one student. it submits the form that has the list of student. //get the first id from the list (we can only edit one student at a time) $view = & $this->getView('studentForm'). To do that we just have to add a method named edit to our controller that will load a view named studentForm. //Reads cid as an array if($cids === null){ //Make sure the cid parameter was in the request JError::raiseError(500. and it should be located in folder where you’ve installed joomla/administrator/components/com_students/studentsController.php. Remember that when we listed the student we put a link in each one: index.Joomla Component Development . so that we could handle both cases (clicking on the link and clicking the edit button in the toolbar) the same way. HASH. When you click on it. that’s why we called the parameter with the id of the student cid[] . We will use the same model we used for listing the students although we’ll add a new method that will return an object that represents a row in the students table in the database (we’ll look at that in Section 4. 37 . DEFAULT_VALUE.php?option=com_student&task=edit&cid[]=ID. Section 4 – The backend tasks – The edit task Section 4. Where ID is the actual ID for the student we want to edit. There is a detail about reading the id from the request.3). with a layout/template named studentformlayout. You might be asking yourself right now why did I used cid[] as a parameter. So. why do we need to put it in an array? The answer to that is: it’s because of the Edit button in the toolbar. then POST and then FILE $cids = JRequest::getVar('cid'. I just make the view name and layout fixed to studentForm and studentformlayout respectively. 'cid parameter missing from the request'). In this task we’ll read the id of the student we want to edit. null. and the selected students will go in the request in the cid[] parameter.1 – The controller task: edit Now let’s do the edit task.

you’ll remember that in that list each student has a link.' not found. If you remember the code that we did for the default task (display) that displays a list of the students read from the database. $view->displayEdit($studentId). $db = $this->getDBO(). 'Student with ID: '. } . } Section 4.php?option=com_students&task=edit&cid[]=1. Where. Section 4. else return $student. Let’s call that method getStudent. $student = $db->loadObject(). true).Joomla Component Development //Push the model into the view (as default) //Second parameter indicates that it is the default model for the view $view->setModel($model. if ($student === null) JError::raiseError(500. ' WHERE id = '.$id. Something like this: index. } $view->setLayout('studentformlayout').php and that it is located in folder where you’ve installed joomla/administrator/components/com_students/models/students. in this example the 1 is the id of the student we want to edit.$id.'). 38 .php Here’s the code getStudents() method: function getStudent($id){ $query = 'SELECT * FROM #__student'. $db->setQuery($query).3 The view – form to edit the student Confidential – All rights reserved. Remember that our model file is named students. So our new method for the model will do just that: get the student from the database with a specific id.2 The model – Getting a student through its id We have to add a method to our model that gets a student from the database based on its id.

This view will have two buttons on its toolbar: Save and Cancel.component. JToolBarHelper::save(). $this->assignRef('student'.view'). JToolBarHelper::save(). This view we’re about to do will display a form that will allow us to edit a student (Figure 3) .application. /** * HTML View class for the backend of the Students Component edit task * @package Students */ class StudentsViewStudentForm extends JView { function displayEdit($studentId) { JToolBarHelper::title('Student'. jimport( 'joomla. JToolBarHelper::cancel(). parent::display(). } function displayAdd(){ JToolBarHelper::title('Student'. $student = $model->getNewStudent(). JToolBarHelper::cancel(). then we use the getStudent method from the model associated with this view to get the actual student from the database and then display it in the form in the layout/template.Joomla Component Development . Confidential – All rights reserved.php Here’s the code for the view: <?php // no direct access defined( '_JEXEC' ) or die( 'Restricted access' ). parent::display(). $this->assignRef('student'. 39 .': [<small>Edit</small>]'). $model = $this->getModel().': [<small>Add</small>]'). $student). $model = $this->getModel(). This view will have to be located in: folder where you’ve installed joomla/administrator/components/com_students/views/studentForm/view. $student).php The view’s class name is: StudentsViewStudentForm And the layout/template file: joomla/administrator/components/com_students/views/studentForm/tmpl/studentformlay out. $student = $model->getStudent($studentId). We’ll create a method named displayEdit that gets as a parameter the id of the student we want to edit.

php" method="POST" name="adminForm" id="adminForm"> <fieldset class="adminform"> <legend>Student Details</legend> <table class="admintable"> <tr> <td class="key">First Name *</td> <td> <input type="text" name="students_firstname" id="students_firstname" size="32" maxlength="250" value="<?php echo $this->student->students_firstname. 40 . ?> <form action="index. ?>" /> </td> Confidential – All rights reserved.php The code is here: <?php // no direct access defined('_JEXEC') or die('Restricted access'). Remember that the layout/template for this view is named studentformlayout and should be located in: folder where you’ve installed joomla/administrator/com_students/views/studentForm/tmpl/studentformlayout. ?>" /> </td> </tr> <tr> <td class="key">Gender *</td> <td> <input type="text" name="students_gender" id="students_gender" size="32" maxlength="250" value="<?php echo $this->student->students_gender. ?>" /> </td> </tr> <tr> <td class="key">Email ID *</td> <td> <input type="text" name="students_email" id="students_email" size="32" maxlength="250" value="<?php echo $this->student->students_email. ?>" /> </td> </tr> <tr> <td class="key">Street</td> <td> <input type="text" name="students_street" id="students_street" size="32" maxlength="250" value="<?php echo $this->student->students_street. ?>" /> </td> </tr> <tr> <td class="key">Last Name *</td> <td> <input type="text" name="students_lastname" id="students_lastname" size="32" maxlength="250" value="<?php echo $this->student->students_lastname.Joomla Component Development } } ?> .

?>" /> </td> </tr> <tr> <td class="key">Phone 2</td> <td> <input type="text" name="students_phone2" id="students_phone2" size="32" maxlength="250" value="<?php echo $this->student->students_phone2. ?>" /> </td> </tr> <tr> <td class="key">State</td> <td> <input type="text" name="students_state" id="students_state" size="32" maxlength="250" value="<?php echo $this->student->students_state. ?>" /> </td> </tr> <tr> <td class="key">School State *</td> <td> <input type="text" name="students_schoolstate" id="students_schoolstate" size="32" maxlength="250" value="<?php echo $this->student->students_schoolstate. ?>" /> </td> </tr> <tr> <td class="key">ZIP</td> <td> <input type="text" name="students_zip" id="students_zip" size="32" maxlength="250" value="<?php echo $this->student->students_zip. ?>" /> </td> Confidential – All rights reserved. ?>" /> </td> </tr> <tr> <td class="key">Phone 1</td> <td> <input type="text" name="students_phone1" id="students_phone1" size="32" maxlength="250" value="<?php echo $this->student->students_phone1.Joomla Component Development . ?>" /> </td> </tr> <tr> <td class="key">Time Zone *</td> <td> <input type="text" name="students_timezone" id="students_timezone" size="32" maxlength="250" value="<?php echo $this->student->students_timezone. 41 . </tr> <tr> <td class="key">City</td> <td> <input type="text" name="students_city" id="students_city" size="32" maxlength="250" value="<?php echo $this->student->students_city.

Joomla Component Development . ?>" /> </td> </tr> Confidential – All rights reserved. ?>" /> </td> </tr> <tr> <td class="key">Phone 1 *</td> <td> <input type="text" name="students_p1_phone1" id="students_p1_phone1" size="32" maxlength="250" value="<?php echo $this->student->students_p1_phone1. 42 . ?>" /> </td> </tr> </table> <legend>Parent/Guardian</legend> <table class="admintable"> <tr> <td class="key">First Name *</td> <td> <input type="text" name="students_p1_firstname" id="students_p1_firstname" size="32" maxlength="250" value="<?php echo $this->student>students_p1_firstname. ?>" /> </td> </tr> <tr> <td class="key">Last Name *</td> <td> <input type="text" name="students_p1_lastname" id="students_p1_lastname" size="32" maxlength="250" value="<?php echo $this->student>students_p1_lastname. </tr> <tr> <td class="key">Student Type</td> <td> <input type="text" name="students_type" id="students_type" size="32" maxlength="250" value="<?php echo $this->student->students_type. ?>" /> </td> </tr> <tr> <td class="key">Status</td> <td> <input type="text" name="students_active" id="students_active" size="32" maxlength="250" value="<?php echo $this->student->students_active. ?>" /> </td> </tr> <tr> <td class="key">Relationship</td> <td> <input type="text" name="students_p1_relationship" id="students_p1_relationship" size="32" maxlength="250" value="<?php echo $this->student>students_p1_relationship.

Joomla Component Development <tr> <td class="key">Phone 2</td> <td> <input type="text" name="students_p1_phone2" id="students_p1_phone2" size="32" maxlength="250" value="<?php echo $this->student->students_p1_phone2. 43 . ?>"/> <input type="hidden" name="task" value=""/> </form> . ?>" /> </td> </tr> <tr> <td class="key">Email Address *</td> <td> <input type="text" name="students_p1_email" id="students_p1_email" size="32" maxlength="250" value="<?php echo $this->student->students_p1_email.?>"/> <input type="hidden" name="id" value="<?php echo $this->student->id. ?>" /> </td> </tr> </table> </fieldset> <input type="hidden" name="option" value="<?php echo JRequest::getVar( 'option' ). Figure – 3 The Edit Form Confidential – All rights reserved.

. the Save button causes this form to be submitted with the hidden field task with value ‘save’ and the Cancel button submits the form with the hidden field task with value ‘cancel’. When we do the save task it will be clear why. There is an important detail here. which is: the form has to have inputs with the same name as the fields in our jos_students table. 44 .Joomla Component Development Remember that we used the Save and Cancel buttons in the toolbar. Confidential – All rights reserved. that’s why there is a hidden field named id.

45 . Confidential – All rights reserved.Joomla Component Development .

Then it will use a method in the model that will get that post data as a parameter and will use it to update the database record that corresponds to the student we’re editing (we need to add that method to our model. $this->setRedirect($redirectTo. } Here is the Code (saveStudent($student) method in …/models/students.1.php) /** * Method to store a student in the DB */ function saveStudent($student) Confidential – All rights reserved.1 – The controller task: save When we edit a student and click on the save button the form we just did before is going to be submitted with the task parameter set to save.php Here’s the code (save() method in studentsController. Finally.1: If you’re wondering how setRedirect will redirect you to the link you pass as a parameter look at our entry point file. DETAIL NOTE 5. and you’ll see that at the end a method named redirect from the controller is executed.'&task=display'). That will cause the save task to be executed in the controller. and that method has to be named save. Section 5: The backend tasks . So let’s add that method to our backend controller.php?option='.JRequest::getVar('option'). That method is what actually causes the browser to redirect to the link we supply as a parameter to setRedirect. 46 . it is named saveStudent). So we need to do the method to handle that task. located in: folder where you’ve installed joomla/administrator/com_student/studentsController. display).php): function save(){ $student = JRequest::get( 'POST' ). We are editing controller file. it will read the data posted by the form we did for the studentForm view. after using the model to save the edited student we’ll use the JController’s method setRedirect to make joomla redirect to the page where the students are listed (our components default task. $model = & $this->getModel('students').Joomla Component Development . $redirectTo = JRoute::_('index. 'Student Saved!'). $model->saveStudent($student).Save Section 5.

'Error binding data: '. 'Error binding data'). JError::raiseError(500.$errorMessage). } } . // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500.Joomla Component Development { //Parameter not necessary because our model is named StudentsModelStudents (used to illustrate that you can specify an alternative name to the JTable extending class) //getTable('students'). Here students is not a table name. 47 . } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500. } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError(). Table class name $studentTableRow =& $this->getTable('students'). Confidential – All rights reserved. 'Invalid data').

You can use a JModel’s method named getTable without parameters to get the class that extends JTABLE following JModel’s naming conventions for table classes.) Confidential – All rights reserved. If you want. Remember that the model’s class name is build by: [ControllerName]Model[ModelName]. you can specify a name in the JModel’s getTable method. etc.2 JTABLE To have our saveStudent method in the model we’re going to use an instance of a class we’ll do that extends JTABLE. The convention is: • • The class extending JTABLE should be named Table[ModelName]. Section 5. which correspond to the jos_students database table fields with the same name. We also have to specify in the constructor which of the fields is the key for the database and also the table’s name. for example getTable(‘Mytable’). To use the functionalities that JTABLE has we have to create a class that extends JTABLE and has a direct correspondence between the names of its attributes and the names of the fields in the database table we’re dealing with. students_firstname. 48 . The JModel specifies methods to get instances of JTABLE following some naming conventions.php for the backend (the same for the frontend without administrator.students_lastname. this tries to get an instance for a class named TableMyTable located in joomla/administrator/components/[COMPONENT_NAME]/tables/mytable. the class that we’re going to write that extends JTABLE has many attributes. especially if we want to update or add records to a database table. in the backend: folder where you’ve installed joomla/admistrator/components/com_students/tables. JTABLE is a class we can extend that has methods that help us interact with the database.. in the frontend it’s the same without administrator (you can change the default location in the model’s constructor). the default location for JTABLE files is. First. And should be named [ModelName]. Using our jos_students table as an example.php (the file name has to be in lowercase). for example named id.Joomla Component Development . The class that extends JTable should be located in folder where you’ve installed joomla/administrator/components/[COMPONENT_NAME]/tables where [COMPONENT_NAME] is the name of the component where our model is. where [ModelName] is the model’s name from where we’re using the JModel’s gettable method without parameters.

} .php: <?php defined('_JEXEC') or die('Restricted Access'). $db). function TableStudents(&$db){ parent::__construct('#__student'. if we want to change the tables folder in our model for the students (in the backend) we would add this code to our model file located in: folder where you’ve installed joomla/administrator/components/com_students/models/students. public $students_firstname = null. a parameter named table_path. public $students_zip = null. public $students_p1_phone1 = null. } Confidential – All rights reserved. public $students_street = null. public $students_p1_firstname = null. 49 . public $students_p1_relationship = null. public $students_p1_phone2 = null.DS. public $students_gender = null. For example. and specify in the config array. public $students_active =null. public $students_phone1 = null. public $students_p1_email = null.Joomla Component Development DETAIL NOTE 5. public $students_city = null. it has to be located in: folder where you’ve installed joomla/administrator/components/com_students/tables and the file will be named students. that the constructor gets as argument. public $students_schoolstate = null. class TableStudents extends JTable { public $id = null. 'id'.'myTablesFolder' )). public $students_p1_lastname = null. public $students_email = null.1: To change the default location of the classes that extend JTable you have to override the default constructor ofthe model class you’re using. public $students_phone2 = null. public $students_timezone = null.2. public $students_lastname = null. public $students_state = null. public $students_type = null. Here’s the code for the class that will extend JTable that we will be using to add and update students in our students’ database table.php function __construct(){ parent::__construct(array('table_path'=>JPATH_COMPONENT.

php Here is the Code (saveStudent($student) method in …/models/students. This is where we’ll use the functionalities offered by JTable.php) /** * Method to store a student in the DB */ function saveStudent($student) { //Parameter not necessary because our model is named StudentsModelStudents (used to illustrate that you can specify an alternative name to the JTable extending class) //getTable('students'). if you remember from the controller’s code. Remember. 'Invalid data'). Here students is not a table name. we’re invoking there and passing a parameter to it with the data we’re getting from the request (that will contain the values from the inputs of the from that is outputted by the studentForm view). Section 5. this file is located in: folder where you’ve installed joomla/administrator/com_students/models/students. I’ll show you the code and then talk a little bit about the methods we’re using from JTable.Joomla Component Development } ?> . 'Error binding data'). JError::raiseError(500.3 The Model – Adding the save functionality We’re adding a new method to our model named saveStudent that. Table class name $studentTableRow =& $this->getTable('students').$errorMessage). } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500. } } Confidential – All rights reserved. // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500. 'Error binding data: '. 50 . } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError().

Joomla Component Development The $student parameter will be an array that will contain the values from the input fields from the form (that we did in the studentForm view) indexed by the names of the inputs.framework:table:jtable-bind/ If you look at bind’s signature: boolean bind ( $from. What it’s for is to specify a list of attributes to be ignored in the binding process. The idea behind the check method is that you should override it when you extend JTable.org/component/option./id. It has mnay attributes: id.. What store does is it inserts a new record in the database if the attribute that represents the table key is 0 (in our case if the Tablestudent id attribute is 0 a new record is inserted). you put them in $ignore. and make it return true if the attributes are valid and false otherwise Finally. will cause an update to the student with id X). Confidential – All rights reserved. an input named id and student. no error is produced and bind still returns true. What the JTable’s check method does is … well it just returns true. 51 . TableStudent id attribute with value X not 0. students_firstname.. Also note that if an attribute is in the table class. etc. students_lastname. The JTable’s bind method we’re using ($studentTableRow->bind($student)) uses reflection to get all the attributes from the class. And remember that the form from the studentForm view has among other form inputs.3. I just put it there so I could tell you about it.references:joomla. If for some reason you have attributes in your table class that you don’t want to update with the values from $from.com_jdwiki/Itemid. .1: Doc.joomla. but not in $from. and the same for student. page for JTable::bind: http://dev. After the bind we do the check. $ignore ) you’ll notice that it has a second parameter. What bind does is it sets the attribute id with the value from the form input id. we store. and then sets them with the values from the array passed as a parameter that have a key with the same name as the attributes in the class. Imagine our TableStudents class that extends JTable. DETAIL 5. or it updates the record whose primary key has the same value as the value of the attribute we specify as key in the JTable’s class constructor (in our case. This gets really simple with an example.

$view->setLayout('studentformlayout'). $view->displayAdd().2: The view . The only difference is that we will be editing a student with id 0. We need to add method to our controller file located in folder where you’ve installed joomla/administrator/com_students/studentsController.1: The controller task: add For the add task we’re doing something very similar to the edit task. What we will do in the controller code is we will add a method named add that will get the model named students and the view named studentForm and call a method from that view named disaplyAdd that we’ll do later. it will call a method from the model named getNewStudent (that we’ll do later) that returns an “empty” student with id 0. and then it’s the same thing as we did for editing a student. What this method will do is. We’re editing the view named studentForm which is located here: Confidential – All rights reserved. if (!$model){ JError::raiseError(500. } $view->setModel($model. } Now let’s do add the displayAdd method to the view named studentForm. Section 6: The backend tasks – The add task Section 6. 'Model named students not found'). and the actual student will be an empty string. true). 52 . Section 6. This is the task that will be executed when you click on the toolbar’s Add button when our component is displaying the list of students (default display task).Joomla Component Development .Form to edit the student (revisited) We have to add a method named displayAdd that has no arguments to the view named studentForm. $model = & $this->getModel('students').php Here’s the add() function in controller code: function add(){ $view = & $this->getView('studentForm').

$studentTableRow->students_state = ''.Joomla Component Development folder where you’ve installed joomla/administrator/components/com_students/views/studentForm/view.': [<small>Add</small>]').php Here’s the getNewStudent() . $studentTableRow->students_zip = ''. $studentTableRow->students_timezone = ''. $student). Here’s the displayAdd() method in view. Here students is not a table name. Table class name $studentTableRow =& $this->getTable('students'). We’re editing the students model file located in: folder where you’ve installed joomla/administrator/components/com_students/models/students. 53 . now let’s do the model.php code: /** * Method that returns an empty student with id 0 */ function getNewStudent(){ //getTable('students'). Confidential – All rights reserved. } That’s it for the view. Section 6. $studentTableRow->students_firstname = ''. $this->assignRef('student'. $studentTableRow->students_schoolname = ''. parent::display().. $model = $this->getModel(). $studentTableRow->students_schoolstate = ''. $studentTableRow->students_email = ''. JToolBarHelper::save(). What this method will do is it will get an instance form the table class (the one that implements JTBALE) and set that instance’s id attribute to 0 and the student attribute to the empty string. JToolBarHelper::cancel(). $studentTableRow->students_city = ''. $studentTableRow->students_street = ''.//models/students. $studentTableRow->id = 0. $studentTableRow->students_uid = 0. $student = $model->getNewStudent().php . $studentTableRow->students_grade_id = 0.php code: function displayAdd(){ JToolBarHelper::title('Student'.3: The model – New students We have to add the getNewStudent method to the students model. $studentTableRow->students_lastname = ''.

it is like you’re editing a student with id 0. $studentTableRow->students_phone1 = ''. return $studentTableRow. $studentTableRow->students_active =0. $studentTableRow->students_p1_email = ''. $studentTableRow->students_p2_relationship = ''. and the save task is executed. $studentTableRow->students_observedst = 0. $studentTableRow->students_type = 0. That’s what happening here. you get a new record in the database. but when you click the save button. $studentTableRow->students_p1_relationship = ''. $studentTableRow->students_p2_lastname = ''. $studentTableRow->students_p2_phone1 = ''. $studentTableRow->students_p1_phone2 = ''. $studentTableRow->students_phone2 = ''. $studentTableRow->students_p2_phone2 = ''. Why are we doing this? Remember when I explained how the JTable’s store method worked? That when the attribute associated with the table’s primary key was 0 the store method would insert a new record in the database. $studentTableRow->students_p1_lastname = ''. } . $studentTableRow->students_p1_email = ''. $studentTableRow->students_p2_firstname = ''. $studentTableRow->students_p1_firstname = ''. $studentTableRow->students_created_on = ''. $studentTableRow->students_requirements = ''.Joomla Component Development $studentTableRow->students_gender = ''. $studentTableRow->students_p1_phone1 = ''. $studentTableRow->students_p2_email = ''. 54 . $studentTableRow->studetns_deleted = 0. Confidential – All rights reserved.

We’re editing the controller’s class located in: folder where you’ve installed joomla/administrator/com_students/studentsController. 'cid parameter missing from the request')..c’.. 'Deleted. $this->setRedirect($redirectTo. $arrayIDs).//models/students. in the edit task). and then use the JController’s setRedirect method to redirect to the list of the students. Confidential – All rights reserved.JRequest::getVar('option')).2: The model – Deleting students Where doing the deleteStudents method in our students model that gets an array with the id’s of the students to be deleted as input. We’re editing the model named students’ file. located in: folder where you’ve installed joomla/administrator/com_students/models/students.’c’)) you’d get a string like this: ‘a. We’re using php’s implode method that has two arguments. $redirectTo = JRoute::_('index. Then we’ll call a method from the model named deleteStudents to which we will supply the array with the ids of the student as a parameter (we’ll do deleteStudents later).Joomla Component Development .'. array(‘a’.').php function remove(){ $arrayIDs = JRequest::getVar('cid'. $model->deleteStudents($arrayIDs). 'default'.php?option='. 55 .. //Reads cid as an array if($arrayIDs === null){ //Make sure the cid parameter was in the request JError::raiseError(500.’b’. Imagine you use implode with arguments (‘. null. } Section 7.php function deleteStudents($arrayIDs) { $query = "DELETE FROM #__student WHERE id IN (". the separator and the array. Section 7: The backend tasks: The remove task Section 7. 'array' ).")". } $model = & $this->getModel('students').1: The controller task: remove To do the remove task we have to get the id of the student we want to remove (like we did for the student to edit.’.b.php Here is remove() method code in studentsController.implode('.php Here is the deleteStudents() in .

$db->setQuery($query). JError::raiseError(500. } } . 'Error deleting students: '. 56 . If there’s an error while the query is being executed (query method) getErrorMsg returns the SQL error that describes what happened.$errorMessage).Joomla Component Development $db = $this->getDBO(). if (!$db->query()){ $errorMessage = $this->getDBO()->getErrorMsg(). Note that we’re using the getErrorMsg method from JDatabase to get the error message. Confidential – All rights reserved.

Joomla Component Development . Confidential – All rights reserved. 57 .

(mailto:prabhu.net?subject=Joomla Queries) Thank you.\\administrator\components\ Execute jos_components.sql (sql query) Place com_students folder in joomla path .. 58 .sql and jos_Students. Find ‘Manage Student’ link. please free to mail me. Click on component.doc (Document) jos_components. TEST: Login to Joomla. If you have any queries. You will find: • • • • Com_students (component) Joomla_Component_Development . Section 8: Installation Unzip Student_Component.sql on mysql joomla database. Click on this & Explore.patil@reachwell. That’s it.Joomla Component Development . Prabhu Patil Confidential – All rights reserved.sql (sql query) jos_Students.

Sign up to vote on this title
UsefulNot useful