connector.api.php in Connector 7
Same filename and directory in other branches
Hooks provided by the Connector module.
File
connector.api.phpView source
<?php
/**
* @file
* Hooks provided by the Connector module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Define Connector support and options.
*
* This hook enables modules to register Connector support.
*
* @return
* An array of connectors that the module defines. Each connector's key should be a
* machine name for that connector. Each connector should contain an associative array
* that may contain the following key-value pairs, defining the connector:
* - "id callback": Required. A function that returns the external id of a connected user.
* - "button callback": A function returning an array defining a button for one-click login.
* - "connect button callback": A function returning an array defining a button for one-click connect.
* - "logout callback": A function...
* - "information callback": A function...
* - "avatar callback": A function...
* - "delete callback": A function...
* - "cache": A number defining the maximum amount of seconds to cache external data.
* - "invalidate old info": A boolean defining if old data should be considered invalid
*/
function hook_connector() {
return array(
'exampleconnector' => array(
'title' => 'Example',
'id callback' => '_exampleconnector_id',
'button callback' => '_exampleconnector_button',
'connect button callback' => '_exampleconnector_button',
'logout callback' => '_exampleconnector_logout',
'information callback' => '_exampleconnector_info',
'avatar callback' => '_exampleconnector_avatar',
'delete callback' => '_exampleconnector_delete',
'cache' => 72000,
//20 hours x 3600 seconds per hour
'invalidate old info' => TRUE,
),
);
}
/**
* Define custom actions.
*
* After a succesfull connection, these callbacks are used.
* See submodule connector_action_default_register_form
* for an example.
*/
function hook_connector_action() {
return array(
'default' => array(
'login callback' => '_connector_log_in',
'create account callback' => '_connector_create_account',
'add connection callback' => '_connector_add_connection',
'no external uid' => NULL,
),
);
}
Functions
Name | Description |
---|---|
hook_connector | Define Connector support and options. |
hook_connector_action | Define custom actions. |