FeedsLdapQueryFetcher.inc in Lightweight Directory Access Protocol (LDAP) 7.2

FeedsLdapQueryFetcher.

File

ldap_feeds/FeedsLdapQueryFetcher.inc

<?php

/**
 * @file
 * FeedsLdapQueryFetcher.
 */

/**
 * FeedsLdapQueryFetcherResult.
 */
class FeedsLdapQueryFetcherResult extends FeedsFetcherResult {
  public $query_ids = [];
  public $ldap_result;

  /**
   * Constructor.
   */
  public function __construct($source_config) {
    $this->query_ids = isset($source_config['query_ids']) && is_array($source_config['query_ids']) ? $source_config['query_ids'] : [];
    parent::__construct('');
    $this->ldap_result = $this
      ->getRaw();
    return $this->ldap_result;
  }

  /**
   * Overrides parent::getRaw();.
   */
  public function getRaw() {
    $results = [];
    $count = 0;
    foreach ($this->query_ids as $i => $query_id) {
      $ldapQuery = ldap_query_get_queries($query_id, 'enabled', TRUE);
      $more_results = $ldapQuery
        ->query();
      if (is_array($more_results)) {
        $count += $more_results['count'];
        $results = array_merge($results, $more_results);
      }
    }
    if ($count) {
      $results['count'] = $count;
    }
    return $results;
  }

}

/**
 * Fetches data via LDAP Query.
 */
class FeedsLdapQueryFetcher extends FeedsFetcher {

  /**
   * Implements FeedsFetcher::fetch().
   */
  public function fetch(FeedsSource $source) {
    $source_config = $source
      ->getConfigFor($this);
    $result = new FeedsLdapQueryFetcherResult($source_config);
    return $result;
  }

  /**
   * Override parent::configDefaults().
   */
  public function configDefaults() {
    return [
      'query_ids' => [],
    ];
  }

  /**
   * Override parent::configForm().
   */
  public function configForm(&$form_state) {
    $queries = ldap_query_get_queries(NULL, 'enabled');
    $query_options = [
      0 => '--- select one or more queries ---',
    ];
    foreach ($queries as $qid => $query) {
      $query_options[$qid] = $query->name;
    }
    $form = [];
    $form['query_ids'] = [
      '#type' => 'select',
      '#title' => t('LDAP Query'),
      '#multiple' => TRUE,
      '#size' => min(10, count($query_options)),
      '#required' => TRUE,
      '#default_value' => $this->config['query_ids'],
      '#description' => t('If more than one query is selected, results from all the queries will be returned.') . ' ' . t('Queries can be added and edited at !link', [
        '!link' => l(t('LDAP Query Admin'), LDAP_QUERY_INDEX_BASE_PATH),
      ]),
      '#options' => $query_options,
    ];
    return $form;
  }

  /**
   * Override parent::sourceForm().
   */
  public function sourceForm($source_config) {
    $tokens = [
      '!edit_link' => l(t('Edit Feed'), 'admin/structure/feeds/' . $this->id),
    ];
    $form_state = [];
    $form = $this
      ->configForm($form_state);
    $form['preamble'] = [
      '#type' => 'markup',
      '#markup' => t('This import is configured at !edit_link.', $tokens),
    ];
    return $form;
  }

  /**
   * Override parent::sourceFormValidate().
   */
  public function sourceFormValidate(&$values) {

    // Could execute query and see if it returns anything for validation.
  }

}

Classes

Name	Description
FeedsLdapQueryFetcher	Fetches data via LDAP Query.
FeedsLdapQueryFetcherResult	FeedsLdapQueryFetcherResult.