This tutorial series, Joomla 3 component development, is currently in progress...

How to add a new model

  1. Create the models folder

    If you haven't already, you will need to create the models folder. This is where our model files will go. In our testing, we created:
    /components/com_helloworld/models

  2. Create <view>.php within models folder

    Each component view can have a corresponding model. In this tutorial we are creating a model for our helloworld view, so we will be creating

    /components/com_helloworld/models/helloworld.php

    In this file, place the following code:

    <?php
    // No direct access to this file
    defined('_JEXEC') or die('Restricted access');
     
    // import Joomla modelitem library
    jimport('joomla.application.component.modelitem');
     
    /**
     * HelloWorld Model
     */
    class HelloWorldModelHelloWorld extends JModelItem
    {
            /**
             * @var string msg
             */
            protected $msg;
     
            /**
             * Get the message
             * @return string The message to be displayed to the user
             */
            public function getMsg() 
            {
                    if (!isset($this->msg)) 
                    {
                            $this->msg = 'This message has been brought to you by the hello world model getMsg function.';
                    }
                    return $this->msg;
            }
    }
  3. Update your view.html.php file to call the getMsg() function

    In our components/com_helloworld/views/helloworld/view.html.php file,
    we originally created the "Hello World" message via the following line:

    $this->msg = 'Hello World';

    We will replace this line of code with the following:

    $this->msg = $this->get('Msg');

    The view.html.php file will now look like the following:

    <?php
    // No direct access to this file
    defined('_JEXEC') or die('Restricted access');
     
    // import Joomla view library
    jimport('joomla.application.component.view');
     
    /**
     * HTML View class for the HelloWorld Component
     */
    class HelloWorldViewHelloWorld extends JViewLegacy
    {
            // Overwriting JView display method
            function display($tpl = null) 
            {
                    // Assign data to the view
                    $this->msg = $this->get('Msg');
                    
                    // Display the view
                    parent::display($tpl);
            }
    }

Our new model in action

As you can see in the screenshot below, our new model comes into play when our view calls one of the model's functions.

View When our view calls $this->get('Msg');
Model ... the following fuction is run in our model: getMsg()
Continued Education in Course How to create a Joomla 3 Component
You are viewing Section 8: How to add the default Model to your Joomla 3 component
Section 7: Creating a Menu Item for your Joomla 3 Component
Did you find this article helpful?

We value your feedback!

Why was this article not helpful? (Check all that apply)
The article is too difficult or too technical to follow.
There is a step or detail missing from the instructions.
The information is incorrect or out-of-date.
It does not resolve the question/problem I have.
How did you find this article?
Please tell us how we can improve this article:
Email Address
Name

new! - Enter your name and email address above and we will post your feedback in the comments on this page!

Related Questions

Here are a few questions related to this article that our customers have asked:
Ooops! It looks like there are no questions about this page.
Would you like to ask a question about this page? If so, click the button below!
Ask a Question

Joomla Community Google+ Hangout #3

June 3rd, 2014

Thank you @RustyJoomla for letting me speak on the Joomla Community Google+ Hangout!

Click here to watch!

Post a Comment

Name:
Email Address:
Phone Number:
Comment:
Submit

Please note: Your name and comment will be displayed, but we will not show your email address.

0 Questions & Comments

Post a comment

Back to first comment | top

Need more Help?

Search

Ask the Community!

Get help with your questions from our community of like-minded hosting users and InMotion Hosting Staff.

Current Customers

Chat: Click to Chat Now E-mail: support@InMotionHosting.com
Call: 888-321-HOST (4678) Ticket: Submit a Support Ticket

Not a Customer?

Get web hosting from a company that is here to help. Sign up today!