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

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

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

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

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

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

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

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

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

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

$this->getState('limitstart'). $this->_total = $this->_getListCount($query). $this->_data = $this->_getList($query. /** * 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(). Confidential – All rights reserved.Joomla Component Development function getData(){ // if data hasn't already been obtained. } . } return $this->_data. } return $this->_total. load it if (empty($this->_data)) { $query = $this->_buildQuery(). 15 . $this>getState('limit')).

pagination'). = $this->_buildContentOrderBy(). $this->_pagination = new JPagination( $this->getTotal(). 16 . } . $this>getState('limitstart').html. } return $this->_pagination. $this->getState('limit') ).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. Confidential – All rights reserved. function _buildQuery() { // Get the WHERE and ORDER BY clauses for the query $where $orderby = $this->_buildContentWhere().

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

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

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

} Confidential – All rights reserved. 'Error binding data: '. Here students is not a table name. 'Error binding data'). } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500.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').$errorMessage). . Table class name $studentTableRow =& $this->getTable('students'). } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError(). 'Invalid data'). 20 . // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500. JError::raiseError(500.

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

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

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

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

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

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

When the form is submitted and if hidemainmenu is in the request and has a value of 1. What this javascript function does is it sets a hidden field named task in the adminForm form (in this example with ‘edit’).php?option=com_students&task=edit (This is not actually true. So you see that we also have to have a hidden field named task in our form. 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. . you know that we have to do a layout/template for this view with a form named adminForm and 4 hidden fields named boxchecked. option. which are alternative versions of editList and addNew. and which task is going to be executed for that component. task and hidemainmenu. 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). joomla makes the administrator menu (Site Menus Content Components … ) inactive. We’ll also have to add a hidden field name option that contains the name of the component prefixed by “com_”. and that there are a few naming conventions that we’ll have to follow. hence the option hidden field. Finally. 27 . the buttons call a joomla javascript function named submitbutton that has one parameter called pressbutton.Joomla Component Development We used editListX (and addNewX). So now. and then submits the adminForm. because all the other buttons will be inactive. Confidential – All rights reserved. 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. hence the task hidden field). For example. because we’ll POST the form but the important thing here to remember is that joomla needs to know which component is being executed. when we press the edit button created by the JToolBarHelper::editListX the submitform will be called with the parameter edit: submitbutton(‘edit’). we’ll see all that next. You also know that we have to list the students.

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

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

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

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

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

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

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

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

id'. in the form of a link that. we’re using a trick to change the css class of every <TR>. What it does is if the checkbox is being checked it adds 1 to the boxchecked adminForm’s hidden input.Joomla Component Development . You can see the code for isChecked here: folder where you’ve installed joomla/includes/js/joomla.javascript. $row->id).4: This note is about how the boxchecked hidden field is updated. DETAIL NOTE 3. if it is being unchecked it subtracts 1. 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. Confidential – All rights reserved.js." type="checkbox"> . each student). $row->id). 36 . is something like this: <input id="cb0" name="cid[]" value="1" onclick="isChecked(this.id'. The javascript isChecked method is the one that updated boxchecked hidden input field. followed by a checkbox that was generated by JHTML::_('grid. $i.3. About the actual listing of the students (the foreach’s code). The rest is each table row displays the student’s id. $i. and then the actual student. The code generated by JHTML::_('grid. 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).checked).

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

$db = $this->getDBO(). Where. else return $student. } Section 4. So our new method for the model will do just that: get the student from the database with a specific id.$id. $student = $db->loadObject(). true). } . ' WHERE id = '.'). you’ll remember that in that list each student has a link. If you remember the code that we did for the default task (display) that displays a list of the students read from the database.php and that it is located in folder where you’ve installed joomla/administrator/components/com_students/models/students. Section 4.3 The view – form to edit the student Confidential – All rights reserved.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.php Here’s the code getStudents() method: function getStudent($id){ $query = 'SELECT * FROM #__student'.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. 'Student with ID: '. Remember that our model file is named students.php?option=com_students&task=edit&cid[]=1. Let’s call that method getStudent. $view->displayEdit($studentId).$id.' not found. in this example the 1 is the id of the student we want to edit. } $view->setLayout('studentformlayout'). 38 . $db->setQuery($query). Something like this: index.

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

?>" /> </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.php The code is here: <?php // no direct access defined('_JEXEC') or die('Restricted access'). ?>" /> </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. 40 . ?> <form action="index. ?>" /> </td> Confidential – All rights reserved.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. ?>" /> </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. 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.Joomla Component Development } } ?> .

?>" /> </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. 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> <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">Time Zone *</td> <td> <input type="text" name="students_timezone" id="students_timezone" size="32" maxlength="250" value="<?php echo $this->student->students_timezone. ?>" /> </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. ?>" /> </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> Confidential – All rights reserved. ?>" /> </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> </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. ?>" /> </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> <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. </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> </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> Confidential – All rights reserved. ?>" /> </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.Joomla Component Development .

?>" /> </td> </tr> </table> </fieldset> <input type="hidden" name="option" value="<?php echo JRequest::getVar( 'option' ).?>"/> <input type="hidden" name="id" value="<?php echo $this->student->id. Figure – 3 The Edit Form Confidential – All rights reserved. 43 .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. ?>" /> </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="task" value=""/> </form> .

There is an important detail here. . that’s why there is a hidden field named id.Joomla Component Development Remember that we used the Save and Cancel buttons in the toolbar. which is: the form has to have inputs with the same name as the fields in our jos_students table. 44 . 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. Confidential – All rights reserved.

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

Save Section 5. $model = & $this->getModel('students').1: If you’re wondering how setRedirect will redirect you to the link you pass as a parameter look at our entry point 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. That will cause the save task to be executed in the controller. $redirectTo = JRoute::_('index. That method is what actually causes the browser to redirect to the link we supply as a parameter to setRedirect.php): function save(){ $student = JRequest::get( 'POST' ).JRequest::getVar('option').php) /** * Method to store a student in the DB */ function saveStudent($student) Confidential – All rights reserved. Section 5: The backend tasks . DETAIL NOTE 5.php?option='.'&task=display').Joomla Component Development . } Here is the Code (saveStudent($student) method in …/models/students. $model->saveStudent($student). located in: folder where you’ve installed joomla/administrator/com_student/studentsController.php Here’s the code (save() method in studentsController. and you’ll see that at the end a method named redirect from the controller is executed. 'Student Saved!'). and that method has to be named save. So we need to do the method to handle that task. it is named saveStudent). So let’s add that method to our backend controller. Finally.1.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. 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. We are editing controller file. 46 . display).

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'). } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500.$errorMessage). Confidential – All rights reserved. 'Invalid data'). // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500. Table class name $studentTableRow =& $this->getTable('students'). 47 . 'Error binding data: '. 'Error binding data'). } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError(). Here students is not a table name.

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

public $students_p1_phone1 = null. public $students_p1_lastname = null. 49 . public $students_schoolstate = null.php: <?php defined('_JEXEC') or die('Restricted Access'). public $students_phone1 = null. function TableStudents(&$db){ parent::__construct('#__student'.Joomla Component Development DETAIL NOTE 5.2. public $students_timezone = null. class TableStudents extends JTable { public $id = null. public $students_p1_firstname = null. public $students_active =null. that the constructor gets as argument. public $students_state = null. public $students_lastname = null. } . public $students_p1_email = null. public $students_firstname = 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. 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.php function __construct(){ parent::__construct(array('table_path'=>JPATH_COMPONENT.DS. a parameter named table_path. public $students_p1_phone2 = null. public $students_zip = null. public $students_phone2 = null. 'id'.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_email = 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. For example. public $students_city = null. public $students_street = null. and specify in the config array. } Confidential – All rights reserved. public $students_type = null.'myTablesFolder' )). $db). public $students_gender = null. public $students_p1_relationship = null.

'Error binding data: '.php Here is the Code (saveStudent($student) method in …/models/students. I’ll show you the code and then talk a little bit about the methods we’re using from JTable. Remember. if you remember from the controller’s code. 'Invalid data'). } // Insert/update this record in the db if (!$studentTableRow->store()) { $errorMessage = $studentTableRow->getError(). Section 5.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').$errorMessage). Table class name $studentTableRow =& $this->getTable('students'). this file is located in: folder where you’ve installed joomla/administrator/com_students/models/students. 50 . 'Error binding data'). Here students is not a table name. JError::raiseError(500. This is where we’ll use the functionalities offered by JTable. // Bind the form fields to the student table if (!$studentTableRow->bind($student)) { JError::raiseError(500.3 The Model – Adding the save functionality We’re adding a new method to our model named saveStudent that.Joomla Component Development } ?> . } } Confidential – All rights reserved. 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). } // Make sure the student record is valid if (!$studentTableRow->check()) { JError::raiseError(500.

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

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

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

Joomla Component Development $studentTableRow->students_gender = ''. $studentTableRow->students_type = 0. $studentTableRow->students_p1_phone2 = ''. $studentTableRow->students_p2_phone1 = ''. 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_requirements = ''. $studentTableRow->students_p1_email = ''. $studentTableRow->students_p1_phone1 = ''. return $studentTableRow. $studentTableRow->students_p1_firstname = ''. $studentTableRow->students_phone1 = ''. $studentTableRow->students_phone2 = ''. $studentTableRow->students_created_on = ''. $studentTableRow->students_p2_email = ''. $studentTableRow->students_observedst = 0. $studentTableRow->students_p1_relationship = ''. it is like you’re editing a student with id 0. $studentTableRow->students_p2_lastname = ''. $studentTableRow->students_active =0. but when you click the save button. $studentTableRow->students_p1_lastname = ''. and the save task is executed. 54 . Confidential – All rights reserved. That’s what happening here. $studentTableRow->studetns_deleted = 0. you get a new record in the database. } . $studentTableRow->students_p2_relationship = ''. $studentTableRow->students_p1_email = ''. $studentTableRow->students_p2_firstname = ''. $studentTableRow->students_p2_phone2 = ''.

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

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

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

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

Sign up to vote on this title
UsefulNot useful