class CiviCRMEntityDefaultViewsController in CiviCRM Entity 7

@TODO Document this class.

Hierarchy

• class \EntityDefaultViewsController
  • class \CiviCRMEntityDefaultViewsController

1 string reference to 'CiviCRMEntityDefaultViewsController'

civicrm_entity_entity_info in ./civicrm_entity.module

Here we declare selected CiviCRM entities to Drupal.

File

./civicrm_entity_default_views_controller.inc, line 6

class CiviCRMEntityDefaultViewsController extends EntityDefaultViewsController {

  /**
   * Defines the result for hook_views_data().
   */
  public function views_data() {
    $data = array();
    $this->relationships = array();
    if (!empty($this->info['base table'])) {
      $table = $this->info['base table'];

      // Define the base group of this table. Fields that don't
      // have a group defined will go into this field by default.
      $data[$table]['table']['group'] = drupal_ucfirst($this->info['label']);
      $data[$table]['table']['entity type'] = $this->type;

      // If the plural label isn't available, use the regular label.
      $label = isset($this->info['plural label']) ? $this->info['plural label'] : $this->info['label'];
      $data[$table]['table']['base'] = array(
        'field' => $this->info['entity keys']['id'],
        'title' => drupal_ucfirst($label),
        'help' => isset($this->info['description']) ? $this->info['description'] : '',
      );
      $data[$table]['table']['entity type'] = $this->type;
      $data[$table] += $this
        ->schema_fields();

      // Add in any reverse-relationships which have been determined.
      $data += $this->relationships;
    }
    return $data;
  }

  /**
   * Find views fields using schema & entity property information.
   */
  protected function schema_fields() {

    // We are not using the 'normal' schema function here due to the
    // problems discussed in the readme.
    if (empty($this->info['base table'])) {
      return array();
    }
    $schema = civicrm_entity_get_schema($this->info['base table']);
    $properties = entity_get_property_info($this->type) + array(
      'properties' => array(),
    );
    $data = array();

    // We will take out the reliance on other schema related checks
    // here, ideally we would 'read' getfields output to determine if
    // we are looking at a DB field or a custom / pseudofield.
    foreach ($properties['properties'] as $name => $property_info) {
      if (!empty($property_info['schema field']) && !empty($schema['fields']) && isset($schema['fields'][$property_info['schema field']])) {
        if ($views_info = $this
          ->map_from_schema_info($name, $schema['fields'][$property_info['schema field']], $property_info)) {
          $data[$name] = $views_info;
        }
      }
    }
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CiviCRMEntityDefaultViewsController::schema_fields	protected	function	Find views fields using schema & entity property information. Overrides EntityDefaultViewsController::schema_fields
CiviCRMEntityDefaultViewsController::views_data	public	function	Defines the result for hook_views_data(). Overrides EntityDefaultViewsController::views_data
EntityDefaultViewsController::$type	protected	property
EntityDefaultViewsController::getRelationshipHandlerClass	public	function	Determines the handler to use for a relationship to an entity type.
EntityDefaultViewsController::map_from_schema_info	protected	function	Comes up with views information based on the given schema and property info.
EntityDefaultViewsController::optionsListCallback	public static	function	A callback returning property options, suitable to be used as views options callback.
EntityDefaultViewsController::schema_revision_fields	protected	function	Try to come up with some views fields with the help of the revision schema and the entity property information.
EntityDefaultViewsController::__construct	public	function