View source for CC PHP-AJAX Chooser

The CC PHP-AJAX Chooser is a simple way to add a license chooser to your PHP-based web application.  It contains the following components:

* PHP Web Services client code
* PHP Web Service proxy (to accommodate browser security)
* Javascript and PHP for running the chooser itself

The Javascript bundles the [http://jquery.org jQuery] library for event handling and communication with the web service proxy.

The PHP-AJAX Chooser is licensed under the [http://opensource.org/licenses/mit-license.php MIT License] and is used in the [[WpLicense]] [http://wordpress.org WordPress] extension.

== Getting the Code ==

The code is available from Subversion as part of the [http://sf.net/projects/cctools cctools project] at SourceForge.  You can retrieve the code using the Subversion command-line client using the following command:

 $ svn co https://svn.sourceforge.net/svnroot/cctools/api_client/php/cc_ajax_chooser

Additional information: [http://subversion.tigris.org/ Subversion]

== Configuring ==

Before deployment you '''must''' configure the Javascript portion of the chooser to point to the web services proxy.  The <code>WS_ROOT_URL</code> variable in <code>js/chooser.js</code> must point to the URL <code>ws_proxy.php</code> is served from on your server.

The PHP Chooser code can optionally be configured in two ways:

* to use a particular version of the web services
* to use a proxy for web service calls

For information on available versions of the web services, see the [http://api.creativecommons.org API documentation].  The code in Subversion defaults to the 1.5 version of the web services.  To change the version, update the <code>$WS_ROOT</code> variable in <code>ws_client.php</code>.

To configure a proxy for web service calls, edit the the <code>$PROXY</code> and <code>$USE_PROXY</code> variables in <code>ws_client.php</code>  The proxy server, <code>$PROXY</code>, should be specified without the <code>http://</code> prefix.

== Creating the Chooser ==

The <code>index.php</code> provided with the chooser demonstrates how to create the chooser.  There are two functions provided by <code>html_ui.php</code> which are used in conjunction to create the chooser.

# <code>scriptHeader($base)</code><br/>Call this in the header to insert <code>&lt;script&gt;</code> tags for AJAX support.  The $base parameter specifies the relative path from the calling page to the <code>cc_ajax_chooser</code> installation.
# <code>licenseChooser($base, $defaults)</code><br/>This function inserts the HTML necessary for the chooser and connects the event handlers.  <code>$base</code> has the same meaning as for scriptHeader; <code>$defaults</code> is an optional hash of the default license name and URI.

[[Category:Developer]]
[[Category:Developer:WebServices]]
[[Category:Technology]]