entityconnect.api.php in Entity connect 7.2

File

entityconnect.api.php

<?php

/**
 * That file describes hooks provided by entityconnect.
 */

/**
 * hook_entityconnect_exclude_forms_alter().
 *
 * Allow modules to alter the list of exclude forms.
 * If you don't want a specific forms to be proceeded, or if Entityconnect affects
 *
 * @param $exclude_forms
 * @return array of forms that not be proceeded.
 *
 * @see entityconnect_child_form_alter()
 */
function hook_entityconnect_exclude_forms_alter(&$exclude_forms) {
  $exclude_forms = array(
    'search_block_form',
    'page_node_form',
  );
}

/**
 * hook_entityconnect_ref_fields_alter().
 *
 * Allow modules to add fields as able to be connect.
 * That will display the "add" and "edit" buttons.
 *
 * Following example shows how to add buttons for bean entity.
 *
 * @param $ref_fields
 */
function hook_entityconnect_ref_fields_alter(&$ref_fields) {

  // We are parsing all fields.
  foreach (field_info_fields() as $id => $field) {

    // We want to be sure that bean fields are provided by entityreference module.
    if ($field['type'] == 'entityreference' && $field['module'] == 'entityreference') {
      $entity_reference_info = entityreference_get_selection_handler($field);
      $entity_type = $entity_reference_info->field['settings']['target_type'];

      // Check if the module is enabled.
      if (module_exists('bean_admin_ui')) {
        $entity_info = entity_get_info($entity_type);
        if (!empty($entity_info['module']) && $entity_info['module'] == 'bean') {

          // Check user access
          if (user_access('entityconnect add button') || user_access('entityconnect edit button')) {

            // Add field to the list.
            $ref_fields[$id] = $field;
          }
        }
      }
    }
  }
}

/**
 * hook_entityconnect_return_form_alter().
 *
 * Allow modules to specify returned values by widget.
 *
 * @param $datas
 *
 *  $datas = array(
 *    'data' => $data,
 *    'widget_containter' => $widget_container,
 *    'widget_container_type' => $widget_container_type,
 *    'field_info' => $field_info,
 *    'language' => $language,
 *    'element_value' => NULL
 *    );
 *
 * @return mixed $datas['element_value'] need to be set.
 *
 */
function hook_entityconnect_return_form_alter(&$datas) {

  /**
   * $datas['data'] : The cached datas.
   * $datas['element_value'] : Defaut value to apply on field.
   */
}

/**
 * hook_entityconnect_child_form_alter().
 *
 * @param $datas
 */
function hook_entityconnect_child_form_alter(&$datas) {
}

/**
 * hook_entityconnect_child_form_submit().
 *
 * @param $datas
 */
function hook_entityconnect_child_form_submit(&$datas) {
}

/**
 * hook_entityconnect_reference_modules_list_alter().
 *
 * @param $datas
 */
function hook_entityconnect_field_type_list_alter(&$datas) {
}

/**
 * hook_entityconnect_add_alter().
 *
 * @param $output
 */
function hook_entityconnect_add_alter(&$output) {
}

/**
 * hook_entityconnect_edit_alter().
 *
 * @param $output
 */
function hook_entityconnect_edit_alter(&$output) {
}

/**
 * hook_entityconnect_add_info().
 *
 * @param $cache_id
 */
function hook_entityconnect_add_info($cache_id, $entity_type, $acceptable_types) {
}

/**
 * hook_entityconnect_add_info_alter().
 *
 * @param $add_info
 * @param $cache_id
 */
function hook_entityconnect_add_info_alter(&$info, &$context) {
}

/**
 * hook_entityconnect_edit_info().
 *
 * @param $cache_id
 */
function hook_entityconnect_edit_info($cache_id, $entity_type, $target_id) {
}

/**
 * hook_entityconnect_edit_info_alter().
 *
 * @param $add_info
 * @param $cache_id
 */
function hook_entityconnect_edit_info_alter(&$add_info, &$cache_id, &$entity_type, &$target_id) {
}

/**
 * hook_entityconnect_field_attach_form_alter().
 *
 * @param $data
 */
function hook_entityconnect_field_attach_form_alter(&$data) {
}

/**
 * hook_entityconnect_add_edit_button_submit_alter().
 *
 * @param $data
 */
function hook_entityconnect_add_edit_button_submit_alter(&$data) {
}

Functions

Name	Description
hook_entityconnect_add_alter	hook_entityconnect_add_alter().
hook_entityconnect_add_edit_button_submit_alter	hook_entityconnect_add_edit_button_submit_alter().
hook_entityconnect_add_info	hook_entityconnect_add_info().
hook_entityconnect_add_info_alter	hook_entityconnect_add_info_alter().
hook_entityconnect_child_form_alter	hook_entityconnect_child_form_alter().
hook_entityconnect_child_form_submit	hook_entityconnect_child_form_submit().
hook_entityconnect_edit_alter	hook_entityconnect_edit_alter().
hook_entityconnect_edit_info	hook_entityconnect_edit_info().
hook_entityconnect_edit_info_alter	hook_entityconnect_edit_info_alter().
hook_entityconnect_exclude_forms_alter	hook_entityconnect_exclude_forms_alter().
hook_entityconnect_field_attach_form_alter	hook_entityconnect_field_attach_form_alter().
hook_entityconnect_field_type_list_alter	hook_entityconnect_reference_modules_list_alter().
hook_entityconnect_ref_fields_alter	hook_entityconnect_ref_fields_alter().
hook_entityconnect_return_form_alter	hook_entityconnect_return_form_alter().