Actions

Difference between revisions of "How to create a stand-alone application using the Joomla! Platform"

From Joomla! Documentation

(Updated with example step-by-step example after Joomla!Day Chicago and information from Louis Landry, with assistance by Joe LeBlanc.)
(Building a Web Application on the Platform)
(29 intermediate revisions by 8 users not shown)
Line 13: Line 13:
 
'''Step 3:  Create a new file'''
 
'''Step 3:  Create a new file'''
  
Create a folder named ‘examples’ within the root directory where you extracted the Joomla Platform. Using your favorite text/code editor, copy/paste code from the following examples (one at a time) into a new file.
+
Create a folder named ‘examples’ within the root directory where you extracted the Joomla Platform. Using your favorite text/code editor, copy/paste code from the following examples (one at a time) into a new file. (Name the file as: ‘helloworld.php‘ or other name that you prefer).
  
 
'''Step 4: Execute your application from the command line interface (CLI)'''
 
'''Step 4: Execute your application from the command line interface (CLI)'''
Line 25: Line 25:
 
Tell the world that you just made your first successful Joomla Platform app by tweeting the following:  “OMG, I just wrote a #jplatform app! #joomla”
 
Tell the world that you just made your first successful Joomla Platform app by tweeting the following:  “OMG, I just wrote a #jplatform app! #joomla”
  
 +
'''Step 7:  Add to the collection'''
 +
 +
Add your application to the example collection at [http://joomlacode.org/gf/project/platformapps/ Platform Examples]
 
----
 
----
 +
Problems? Check [[Platform_Applications_Tips_and_Tricks | Platform Tips and Tricks]]
 +
 +
== Examples ==
  
== Example Hello World Command Line Interface (CLI) App ==
+
=== Example 1: Hello World Command Line Interface (CLI) App ===
  
 
<source lang="php">
 
<source lang="php">
 
<?php
 
<?php
define( '_JEXEC', 1 );
+
define('_JEXEC', 1);
 +
define('JPATH_BASE', dirname(__FILE__));
  
require_once ( '../libraries/import.php' );
+
require '../libraries/import.php';
jimport( 'joomla.application.cli' );
+
  
class HelloWorld extends JCli
+
class HelloWorld extends JApplicationCli
 
{
 
{
 
+
    public function execute()
public function execute( )
+
 
     {
 
     {
      $this->out( 'Hello World' );
+
        $this->out('Hello World');
 
     }
 
     }
 
}
 
}
  
JCli::getInstance( 'HelloWorld' )->execute( );
+
JApplicationCli::getInstance('HelloWorld')->execute();
 
</source>
 
</source>
  
 +
=== Example 2: Drawing cool things in the Terminal Screen ===
  
----
+
<source lang="php">
 +
<?php
 +
define('_JEXEC', 1);
 +
 +
require '../libraries/import.php';
 +
 +
class JoomlaRocks extends JApplicationCli
 +
{
 +
    public function execute()
 +
    {
 +
      $this->out('  .          .    .__      |      | ');
 +
      $this->out('  | _  _ ._ _ | _.  [__) _  _.|_/ __ | ');
 +
      $this->out('\__|(_)(_)[ | )|(_]  |  \(_)(_.| \_)  * ');
 +
    }
 +
}
 +
 +
JApplicationCli::getInstance('JoomlaRocks')->execute();
 +
</source>
  
 +
=== Example 3: Hello World using a var to save your name ===
  
'''''[Information below this point seems to be out of date, cleaning required]'''''
+
<source lang="php">
 +
<?php
 +
define('_JEXEC', 1);
  
In order to use the Joomla! Framework alone, you would have to follow the following guidelines:
+
require '../libraries/import.php';
  
*Keep this folder/files from a normal Joomla! install:
+
class HelloYou extends JApplicationCli
::*includes/
+
{
::*libraries/
+
    public function execute()
::*configuration.php
+
    {
*Edit '''configuration.php''' to match your server database/username/password/paths/etc.
+
      $this->out('What is your name?');
*Create the required tables in the database
+
      $name = $this->in();
:'''Note:''' ''Normally only the table #__session is needed, but if you want to stay safe, just use the whole structure of a Joomla! install (without the samples!)''
+
 
*Create an '''index.php''' file in the root with the following starting code:
+
      $this->out();
<source lang="php">
+
      $this->out('Hi '.$name.',');
/* Initialize Joomla framework */
+
      $this->out('Welcome to the Joomla Platform!');
define( '_JEXEC', 1 );
+
      $this->out();
define('JPATH_BASE', dirname(__FILE__) );
+
    }
define( 'DS', DIRECTORY_SEPARATOR );
+
 
/* Required Files */
+
    /**
require_once ( JPATH_BASE .DS.'includes'.DS.'defines.php' );
+
    * We don’t really need configuration for this application.
require_once ( JPATH_BASE .DS.'includes'.DS.'framework.php' );
+
    *
/* To use Joomla's Database Class */
+
    * @return  void
require_once ( JPATH_BASE .DS.'libraries'.DS.'joomla'.DS.'factory.php' );
+
    */
/* Create the Application */
+
    protected function fetchConfigurationData()
$mainframe =& JFactory::getApplication('site');
+
    {
/**************************************************/
+
      return array();
// Your code starts here...
+
    }
/**************************************************/
+
}
 +
 
 +
JApplicationCli::getInstance('HelloYou')->execute();
 
</source>
 
</source>
  
:'''Note:''' It is possible to use Joomla! framework without a database. To do that, pass a config array containing session as a key with the value of false in the call to JFactory::getApplication() like this:
+
=== Example 4: Get your recent Tweets ===
 +
 
 
<source lang="php">
 
<source lang="php">
/* Create the Application */
+
<?php
$mainframe =& JFactory::getApplication('appname', array('session' => false));
+
define('_JEXEC', 1);
</source>
+
After that, you can still use a file based authentication system if you want.
+
  
[[Category:Tips and tricks]]
+
require '../libraries/import.php';
[[Category:Development]]
+
  
 +
class TwitterFeed extends JApplicationCli
 +
{
 +
    public function execute()
 +
    {
 +
        $this->out('What is your twitter handle?');
 +
        $username = $this->in();
  
== Use Existing Joomla Configuration in External PHP file ==
+
        $this->out('How many tweets to view?');
 +
        $count = $this->in();
  
 +
        $tweets = $this->latest_tweet($username, $count);
 +
        $this->out($tweets);
 +
    }
  
This Article is written by Andy@PCinvent.Net
+
    // Get Latest Tweet
 +
    private function latest_tweet($username, $count = 5)
 +
    {
 +
        $url = 'http://twitter.com/statuses/user_timeline/'.$username.'.xml?count='.$count;
  
Sometimes you may need to write an external Php file in stead of working in Joomla files. Outside the Joomla Framework, we can not use Joomla DB libraries, such as Global object $db, loadResult(), loadResultArray, loadAssocList, loadRow() and etc.
+
        $xml = simplexml_load_file($url) or die('could not connect');
In this case, we can use the '''custom PHP code''' plugin to write the code right in the Joomla content page.
+
 
Or you can try what I do here: Include Joomla configuration and write your own MySQL queries in external php file......
+
        $text = '';
 
+
       
'''Joomla Configuration'''
+
        foreach($xml->status as $status)
If you open configuration.php, you will see that all variables inside are under the class '''JConfig()'''.
In my example here, I need the variables of $host, $db, $user and $password
+
        {
 
+
            $text .= $status->text."\n";
'''Joomla page'''
+
        }
Suppose we have a Joomla page called "jm_page.php"
+
 
in jm_page.php, I tried to POST a request variable of $user_id from "jm_page.php" to external php file called "external.php".
+
        return $text;
<source lang="php">
+
    }
<form action="external.php" method="POST">

+
}
<input type="text" name="user_id" id="user_id" value="<?php echo $user_id; ?>" />

+
 
<input type="submit" />

+
JApplicationCli::getInstance('TwitterFeed')->execute();
</form>
+
 
</source>
 
</source>
  
 +
== Building a Web Application on the Platform ==
  
'''External Page'''
+
These instructions will allow you to create a minimal web application that does not use a database.
  
In the code I wrote below, the objective is to use Jconfig Class without re-giving Database connection strings which were already defined in Joomla Configuration page.

 Having the DB established, we query and output the first value in the $result Array.

In the Query, I tried to get the result of sex of the user base on the user id from the table "jos_community_user".
+
Problems? Check [[Platform Applications Tips and Tricks|Platform Tips and Tricks]]
 +
 
 +
Download the latest version of the Joomla! platform from github.
 +
 
 +
Create an <tt>index.php</tt> file in the root with the following starting code:
 +
 
 +
<source>
 +
 
 +
define('_JEXEC', 1);
 +
 
 +
// Fix magic quotes.
 +
@ini_set('magic_quotes_runtime', 0);
 +
 
 +
// Maximise error reporting.
 +
@ini_set('zend.ze1_compatibility_mode', '0');
 +
error_reporting(E_ALL);
 +
ini_set('display_errors', 1);
 +
 
 +
/*
 +
* Ensure that required path constants are defined.
 +
*/
 +
if (!defined('JPATH_BASE'))
 +
{
 +
define('JPATH_BASE', realpath(__DIR__));
 +
}
 +
 
 +
define('JPATH_LIBRARIES', JPATH_BASE . '/libraries');
 +
 
 +
/**
 +
* Import the platform. This file is usually in JPATH_LIBRARIES
 +
*/
 +
require_once JPATH_LIBRARIES . '/import.legacy.php';
 +
 
 +
/**
 +
* Import the application.
 +
*/
 +
require_once JPATH_BASE.'/includes/application.php';
 +
 
 +
 
 +
// Instantiate the application.
 +
$web = MyWebApp::getInstance('MyWebApp');
 +
 
 +
// Run the application
 +
$web->execute();
  
How to read $jconfig->host?
 

$Jconfig is now the instance of the Jconfig class. host is the variable $host inside the class.
 
<source lang="php">
 
<?php
#### The following codes is written by Andy Ng
 
<http://www.pcinvent.net>
 
####
#### Please keep the above credit line to the Autor ####


 
//get POST

 
$user_id = $_POST["user_id"];

 
echo $user_id;


 
//use joomla db class
 

require_once("configuration.php");

 
$jconfig = new JConfig();


 
//db establish

 
$db_error = "I am sorry! We are maintenaning the website, please try again later.";
 

$db_config = mysql_connect( $jconfig->host, $jconfig->user, $jconfig->password ) or die( $db_error );

 
mysql_select_db( $jconfig->db, $db_config ) or die( $db_error );


 
//db query result

 
$query = "SELECT user_sex FROM jos_community_user WHERE user_id = $user_id";
 
//get user_sex

 
$query_execute = mysql_query($query);

 
$result = mysql_fetch_row($query_execute);

 
echo $result[0];


 
mysql_close($db_config);//andy:close db for security reason

 
?>
 
 
</source>
 
</source>
 +
 +
Now create a folder <tt>includes</tt> in the root and inside it a file <tt>application.php</tt> with the following code:
 +
<source>
 +
/**
 +
* Override the doExecute method from JApplicationWeb. Here you define what your application does.
 +
*/
 +
class MyWebApp extends JApplicationWeb
 +
{
 +
/**
 +
* Display the application.
 +
*/
 +
protected function doExecute(){
 +
 +
$this->setBody(
 +
'<h1>My Web Application</h1>'.
 +
'The current URL is '.JUri::current().'<br/>'.
 +
'The date is '. JFactory::getDate('now')
 +
                );
 +
}
 +
}
 +
</source>
 +
 +
If you browse to the web page you should see the heading followed by the two sentences, including the url and the date.
 +
 +
[[Category:Platform]][[Category:Development]][[Category:Tutorials]]

Revision as of 05:04, 5 April 2012

Contents

How to Build Your First Joomla Platform Application

This article will allow you to create your first Joomla Platform application, following a step-by-step process outlined below. We’ll assume you’re in an environment that has access to PHP (Mac OS X has this by default), and that you’ve got a connection to the Internet to download the platform project.

Step 1: Download the latest Joomla Platform

Simply point your Web browser to http://github.com/joomla/joomla-platform and then click on the “Downloads” button. In the pop-up window that appears, click on either the “Download .tar.gz” button or the “Download .zip” button, depending on your preference.

Step 2: Extract the Joomla Platform in your own environment

After you’ve downloaded the file, extract it in the location of your choosing.

Step 3: Create a new file

Create a folder named ‘examples’ within the root directory where you extracted the Joomla Platform. Using your favorite text/code editor, copy/paste code from the following examples (one at a time) into a new file. (Name the file as: ‘helloworld.php‘ or other name that you prefer).

Step 4: Execute your application from the command line interface (CLI)

Using your favorite CLI (maybe Terminal on the Mac, or PuTTy on Windows), navigate to the ‘examples’ folder where you saved your file. Type “php helloword.php” (or whatever you named your file) and click the enter key on your keyboard.

Step 5: Read the result on your screen, savor the moment

Step 6: Tweet your success

Tell the world that you just made your first successful Joomla Platform app by tweeting the following: “OMG, I just wrote a #jplatform app! #joomla”

Step 7: Add to the collection

Add your application to the example collection at Platform Examples


Problems? Check Platform Tips and Tricks

Examples

Example 1: Hello World Command Line Interface (CLI) App

<?php
define('_JEXEC', 1);
define('JPATH_BASE', dirname(__FILE__));
 
require '../libraries/import.php';
 
class HelloWorld extends JApplicationCli
{
    public function execute()
    {
        $this->out('Hello World');
    }
}
 
JApplicationCli::getInstance('HelloWorld')->execute();

Example 2: Drawing cool things in the Terminal Screen

<?php
define('_JEXEC', 1);
 
require '../libraries/import.php';
 
class JoomlaRocks extends JApplicationCli
{
    public function execute()
    {
       $this->out('   .           .     .__       |      | ');
       $this->out('   | _  _ ._ _ | _.  [__) _  _.|_/ __ | ');
       $this->out('\__|(_)(_)[ | )|(_]  |  \(_)(_.| \_)  * ');
    }
}
 
JApplicationCli::getInstance('JoomlaRocks')->execute();

Example 3: Hello World using a var to save your name

<?php
define('_JEXEC', 1);
 
require '../libraries/import.php';
 
class HelloYou extends JApplicationCli
{
    public function execute()
    {
       $this->out('What is your name?');
       $name = $this->in();
 
       $this->out();
       $this->out('Hi '.$name.',');
       $this->out('Welcome to the Joomla Platform!');
       $this->out();
    }
 
    /**
    * We don’t really need configuration for this application.
    *
    * @return  void
    */
    protected function fetchConfigurationData()
    {
       return array();
    }
}
 
JApplicationCli::getInstance('HelloYou')->execute();

Example 4: Get your recent Tweets

<?php
define('_JEXEC', 1);
 
require '../libraries/import.php';
 
class TwitterFeed extends JApplicationCli
{
    public function execute()
    {
        $this->out('What is your twitter handle?');
        $username = $this->in();
 
        $this->out('How many tweets to view?');
        $count = $this->in();
 
        $tweets = $this->latest_tweet($username, $count);
        $this->out($tweets);
    }
 
    // Get Latest Tweet
    private function latest_tweet($username, $count = 5)
    {
        $url = 'http://twitter.com/statuses/user_timeline/'.$username.'.xml?count='.$count;
 
        $xml = simplexml_load_file($url) or die('could not connect');
 
        $text = '';
 
        foreach($xml->status as $status)
        {
            $text .= $status->text."\n";
        }
 
        return $text;
    }
}
 
JApplicationCli::getInstance('TwitterFeed')->execute();

Building a Web Application on the Platform

These instructions will allow you to create a minimal web application that does not use a database.

Problems? Check Platform Tips and Tricks

Download the latest version of the Joomla! platform from github.

Create an index.php file in the root with the following starting code:

define('_JEXEC', 1);
 
// Fix magic quotes.
@ini_set('magic_quotes_runtime', 0);
 
// Maximise error reporting.
@ini_set('zend.ze1_compatibility_mode', '0');
error_reporting(E_ALL);
ini_set('display_errors', 1);
 
/*
 * Ensure that required path constants are defined.
 */
if (!defined('JPATH_BASE'))
{
        define('JPATH_BASE', realpath(__DIR__));
}
 
define('JPATH_LIBRARIES',               JPATH_BASE . '/libraries');
 
/**
 * Import the platform. This file is usually in JPATH_LIBRARIES 
 */
require_once JPATH_LIBRARIES . '/import.legacy.php';
 
/**
 * Import the application.
 */
require_once JPATH_BASE.'/includes/application.php';
 
 
// Instantiate the application.
$web = MyWebApp::getInstance('MyWebApp');
 
// Run the application
$web->execute();

Now create a folder includes in the root and inside it a file application.php with the following code:

/**
 * Override the doExecute method from JApplicationWeb. Here you define what your application does. 
 */
class MyWebApp extends JApplicationWeb
{
                /**
                 * Display the application.
                 */
                protected function doExecute(){
 
                        $this->setBody(
                                '<h1>My Web Application</h1>'.
                                'The current URL is '.JUri::current().'<br/>'.
                                'The date is '. JFactory::getDate('now')
                        );
                }
}

If you browse to the web page you should see the heading followed by the two sentences, including the url and the date.