class CivicrmEntityUIController in CiviCRM Entity 7.2

Hierarchy

• class \EntityDefaultUIController
  • class \EntityContentUIController
    • class \CivicrmEntityUIController

1 string reference to 'CivicrmEntityUIController'

civicrm_entity_entity_info in ./civicrm_entity.module

Here we declare selected CiviCRM entities to Drupal.

File

./civicrm_entity_ui_controller.inc, line 3

class CivicrmEntityUIController extends EntityContentUIController {
  public $overviewPagerLimit = 25;

  /**
   * Always use the same civicrm_entity_form
   * @return mixed
   */
  public function hook_forms() {
    $forms = parent::hook_forms();
    foreach ($this->entityInfo['bundles'] as $bundle => $bundle_info) {
      if (isset($bundle_info['admin'])) {
        $form_id = !isset($bundle) || $bundle == $this->entityType ? $this->entityType . '_form' : $this->entityType . '_edit_' . $bundle . '_form';
        $forms[$form_id] = array(
          'callback' => 'civicrm_entity_form',
        );
      }
    }
    return $forms;
  }
  public function overviewTable($conditions = array()) {

    /*
        $query = new EntityFieldQuery();
        $query->entityCondition('entity_type', $this->entityType);

        // Add all conditions to query.
        foreach ($conditions as $key => $value) {
          $query->propertyCondition($key, $value);
        }

        if ($this->overviewPagerLimit) {
          $query->pager($this->overviewPagerLimit);
        }

        $results = $query->execute();

        $ids = isset($results[$this->entityType]) ? array_keys($results[$this->entityType]) : array();
        $entities = $ids ? entity_load($this->entityType, $ids) : array();
        ksort($entities);

        $rows = array();
        foreach ($entities as $entity) {
          $rows[] = $this->overviewTableRow($conditions, entity_id($this->entityType, $entity), $entity);
        }

        $render = array(
          '#theme' => 'table',
          '#header' => $this->overviewTableHeaders($conditions, $rows),
          '#rows' => $rows,
          '#empty' => t('None.'),
        );
        return $render;
    */
  }
  public function hook_menu() {

    /* add menu items for all entities, will display with id as argument to url
     * for example goto <drupal_root>/civicrm_contact/1, in the example id =1
     */
    $civicrm_entities = _civicrm_entity_enabled_entities();
    foreach ($civicrm_entities as $key => $value) {
      $dashkey = str_replace('_', '-', $key);
      $titlename = ucwords(str_replace('_', ' ', $key));
      $items[$dashkey . '/add'] = array(
        'title' => 'Create ' . $key,
        'page callback' => 'entity_ui_get_form',
        'page arguments' => array(
          $key,
          array(),
          'create',
        ),
        'access callback' => 'civicrm_entity_op_access',
        'access arguments' => array(
          'create',
          $key,
        ),
        'type' => MENU_CALLBACK,
      );
      $items[$dashkey . '/' . '%civicrm_entity_loader'] = array(
        //'title' => 'Title',
        'title callback' => $key . '_page_title',
        'title arguments' => array(
          1,
        ),
        'page callback' => 'civicrm_entity_page_view',
        'page arguments' => array(
          1,
          $key,
        ),
        'access callback' => 'civicrm_entity_op_access',
        'access arguments' => array(
          'view',
          $key,
          1,
        ),
        'load arguments' => array(
          $key,
        ),
      );
      $items[$dashkey . '/%civicrm_entity_loader/view'] = array(
        'title' => 'View',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => -10,
        'load arguments' => array(
          $key,
        ),
      );
      $items[$dashkey . '/' . '%civicrm_entity_loader/edit'] = array(
        'title' => 'Edit',
        'page callback' => 'entity_ui_get_form',
        'page arguments' => array(
          $key,
          1,
          'edit',
        ),
        'access callback' => 'civicrm_entity_op_access',
        'access arguments' => array(
          'edit',
          $key,
          1,
        ),
        'type' => MENU_LOCAL_TASK,
        'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
        'load arguments' => array(
          $key,
        ),
      );
      $items[$dashkey . '/' . '%civicrm_entity_loader/delete'] = array(
        'title' => 'Delete',
        'page callback' => 'entity_ui_get_form',
        'page arguments' => array(
          $key,
          1,
          'delete',
        ),
        'access callback' => 'civicrm_entity_op_access',
        'access arguments' => array(
          'delete',
          $key,
          1,
        ),
        'type' => MENU_LOCAL_TASK,
        'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
        'weight' => 10,
        'load arguments' => array(
          $key,
        ),
      );
    }
    return $items;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CivicrmEntityUIController::$overviewPagerLimit	public	property	Defines the number of entries to show per page in overview table. Overrides EntityDefaultUIController::$overviewPagerLimit
CivicrmEntityUIController::hook_forms	public	function	Always use the same civicrm_entity_form Overrides EntityDefaultUIController::hook_forms
CivicrmEntityUIController::hook_menu	public	function	Provides definitions for implementing hook_menu(). Overrides EntityContentUIController::hook_menu
CivicrmEntityUIController::overviewTable	public	function	Generates the render array for a overview table for arbitrary entities matching the given conditions. Overrides EntityDefaultUIController::overviewTable
EntityContentUIController::operationFormSubmit	public	function	Operation form submit callback. Overrides EntityDefaultUIController::operationFormSubmit
EntityDefaultUIController::$entityInfo	protected	property
EntityDefaultUIController::$entityType	protected	property
EntityDefaultUIController::$id_count	protected	property
EntityDefaultUIController::applyOperation	public	function	Applies an operation to the given entity.
EntityDefaultUIController::entityFormSubmitBuildEntity	public	function	Entity submit builder invoked via entity_ui_form_submit_build_entity().
EntityDefaultUIController::operationCount	protected	function	Returns the operation count for calculating colspans.
EntityDefaultUIController::operationForm	public	function	Builds the operation form.
EntityDefaultUIController::operationFormValidate	public	function	Operation form validation callback.
EntityDefaultUIController::overviewForm	public	function	Builds the entity overview form.
EntityDefaultUIController::overviewFormSubmit	public	function	Overview form submit callback.
EntityDefaultUIController::overviewFormValidate	public	function	Overview form validation callback.
EntityDefaultUIController::overviewTableHeaders	protected	function	Generates the table headers for the overview table.
EntityDefaultUIController::overviewTableRow	protected	function	Generates the row for the passed entity and may be overridden in order to customize the rows.
EntityDefaultUIController::__construct	public	function