Skip to content
Janrain Engage for Codeigniter
PHP
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
config
controllers
libraries
API_Ref.txt
README

README

Janrain Engage Library v2.0 Documentation
(http://codeigniter.com/wiki/Janrain_Engage)

By: Eric Siegel
NTICompass@gmail.com
http://NTICompassInc.com

0. Notes
--------
Some API calls require a Plus/Pro account.
This library requies PHP5 with cURL and JSON.
It also requires that CodeIgntier has query strings enabled.
  Set $config['enable_query_strings'] to TRUE in config/config.php.

1. Installation
---------------
Copy the included files into your application folder.
application/
  config/
    enagage_conf.php
  controllers/
    engage_login.php
  libraries/
    engage.php

Open the engage_conf.php and set your RPX URL, API Key, and Token URL (will be setup in next step).

2. Configure Token URL
----------------------
When a user uses Engage to login, rpxnow.com passes your Token URL a 'token' that is used to get the user's data.
We need to create a controller to receive this token and make the correct API calls.  A basic controller is included in this package.
rpxnow.com passes the token using POST (or GET if you wish).  CodeIgniter 2.0 can use the GET array, but POST is recommended.

Your token URL should be the location of the controller.

3. Adding Engage login box to page
----------------------------------
This library contains 3 helper functions to add the Engage login box to the page.
a) Popup login box:
To use the popup login box, use the script() and popup() functions.
Example:
// Clicking this link will make the login box popup
$this->engage->popup("Sign in"); // Prints a link with the text given
// Add this to the footer
$this->engage->script(); // Prints the javascript tags needed for the popup

b) Embed login box:
The embed() functions embeds the login box in to the page
Example:
// Embed login box as iFrame (text/html object)
$this->engage->embed(); // Prints the iFrame tag to embed login box

4. API Reference
----------------
See API_Ref.txt
Something went wrong with that request. Please try again.