simpleads.api.php in SimpleAds 7

SimpleAds API.

File

simpleads.api.php

<?php

/**
 * @file
 * SimpleAds API.
 */

/**
 * Describe SimpleAds block order types
 */
function hook_simpleads_order_info() {
  return array(
    'delta_1' => t('Random order example'),
  );
}

/**
 * Build SQL Query to order SimpleAds in blocks.
 *
 * @param string $delta
 * @param array $term_ids
 * @param int $limit
 * @return type
 */
function hook_simpleads_order($delta, $term_ids, $limit) {
  if ($delta == 'delta_1') {
    $query = db_select('node', 'n');
    $query
      ->join('taxonomy_index', 'ti', 'n.nid = ti.nid');
    $query
      ->fields('n', array(
      'nid',
    ));
    $query
      ->condition('n.type', 'simpleads');
    $query
      ->condition('n.status', 1);
    $query
      ->condition('ti.tid', $term_ids, 'IN');
    $query
      ->orderRandom();
    $query
      ->range(0, $limit);
    return $query
      ->execute();
  }
}

/**
 * Add additional infromation to Ads listing and Ad statistics page.
 *
 * @param object $node
 * @param string $op
 *  - list
 *  - detail
 *  - ad_group
 *  - ad_status
 *  - ad_status_detail
 */
function hook_simpleads_stats_info($node, $op) {
  if ($op == 'list') {
    return array(
      'Item on the ads listing page',
    );
  }
}

/**
 * SimpleAd node status change (during cron).
 *
 * @param object $node
 * @param bolean $status
 */
function hook_simpleads_status_change($node, $status = NULL) {
}

/**
 * Alter SimpleAd output.
 *
 * @param array $data
 */
function hook_simpleads_alter(&$data) {
}

/**
 * Redirect ad to its destination
 *
 * @param string $url
 * @param string $delta
 */
function hook_simpleads_redirect($url, $delta) {
}

/**
 * Ad Clicked.
 *
 * @param string $op
 * - insert
 * - delete
 *
 * @param object $node
 */
function hook_simpleads_ad_click($op, $node) {
}

/**
 * Ad Impressed.
 *
 * @param string $op
 * - insert
 * - delete
 *
 * @param object $node
 */
function hook_simpleads_ad_impression($op, $node) {
}

Functions

Name	Description
hook_simpleads_ad_click	Ad Clicked.
hook_simpleads_ad_impression	Ad Impressed.
hook_simpleads_alter	Alter SimpleAd output.
hook_simpleads_order	Build SQL Query to order SimpleAds in blocks.
hook_simpleads_order_info	Describe SimpleAds block order types
hook_simpleads_redirect	Redirect ad to its destination
hook_simpleads_stats_info	Add additional infromation to Ads listing and Ad statistics page.
hook_simpleads_status_change	SimpleAd node status change (during cron).