How JConnect ExApp API is Organized

This is the place where we are going to say about how ExApp API is organized and what are things(Classes,Files) you need to consider about.

Folder Stucture

• jconnect_api
• xmlrpc
• aes-lib.php
• Joomla.php
• jconnect.php
• settings.php
• lib.php
• server.php
• reciever.php
• api.php

we are only using directly bolded files only.

API Inside

let's have a look at that bolded files...

server.php

This is the actual server for communication and you should point the path of this file when configuring ExApp in the JConnect Management Console.

eg:-if this file resides in http://host/mod/jconnect_api/server.php ; then the path is /mod/jconnect_api/server.php.

and this is one of the very important place in the API.

lib.php

This is the files which contains the most-important class(JCFactory) you will be used and the skeleton of methods you are going to implement...

Classes

• JCFactory -

this is the class you'll be used always in the application to get the references of both Joomla and JConnect, plus all the configuration stuff is done on this..

• JCUserSunc -

this is the class you'll be extend and implement methods for allow Joomla to do user-sync (part of the Joomla Requesting Communication).

• JCMisc -

this is the class will be extends and implement it's methods for Joomla to send some communication info for exApp and get the views for Activity Module.

• JCAuth -

this is the class will be extends and implement it's methods for successfully done the Authentication and SSO

• NonceManger -

extend and implement methods of this class is Optional. This will help you do authentication more securely.

setting.php

This is the place all you done the configuration stuff. They'll be

1. put secret-key and other connect infomation
2. assign implemented methods into API

examples:-

• adding secret key

  JCFactory::register('secKey','YO1iSVUL3rRf2d3lls5OAlxyyP4332Lwd::91WxORBfNLnuYWx3SdMssXVx4'));
 JCFactory::register('appName','FakeExApp');

• assign implmented method's of JCUserSync class

include_once dirname(dirname(__FILE__)).'/impl/userSync.php';
/**
 JCElggUserSync is the extended class of JCUserSync and above line will include that class
*/
JCFactory::register('userSync',new JCElggUserSync());

api.php

This is file you are including to your application and get the references of JConnect and Joomla.

Other files and folders

The following files and folders are containing some external libraries and some core files of the API. And you never won't those files directly.

• xmlrpc - this folder contains the xmlrpc library which you use to established the communication with Joomla!
• aes-lib.php - This is the Encryption Library for AES algorithm
• reciever.php - this is used to authentication and SSO by the API.