function eck__properties__form in Entity Construction Kit (ECK) 7.2

Properties form callback.

1 string reference to 'eck__properties__form'

eck__bundle__menu in ./eck.bundle.inc

This function creates the menu items relevant to bundle administration.

File

./eck.properties.inc, line 129

Handles properties attached to entites created through ECK.

Code

function eck__properties__form($form, &$state, $entity_type_name) {
  if (!isset($entity_type_name)) {
    $entity_type = new EntityType();
  }
  else {
    $entity_type = EntityType::loadByName($entity_type_name);
  }
  $form['entity_type'] = array(
    '#type' => 'value',
    '#value' => $entity_type,
  );
  $form['info'] = array(
    '#markup' => "<p><strong>HELP:</strong> " . "The add property button will temporarily add a property to the entity " . "type, to finalize adding the property, click the checkbox on the left and " . "click save </p>",
  );

  // When the add button is clicked, the submit callback directs the form to
  // be rebuilt. Here we check to see if a new property was added, and keep it
  // in a a list of new properties to add them to the table on each rebuild.
  $entity_type_properties = $entity_type->properties;
  if (!array_key_exists('values', $state) || !array_key_exists('new_properties', $state['values'])) {
    $new_properties = eck_get_default_properties();
    $new_properties = array_merge($new_properties, $entity_type_properties);
  }
  else {
    $new_properties = $state['values']['new_properties'];
  }
  if (!empty($state['values']['property_name'])) {
    $property_name = $state['values']['property_name'];
    $property_type = $state['values']['property_type'];

    // OK we need to do a little bit of filtering do the oddity of modifying
    // existing properties through the add Property form #fail.
    // @todo need to get a better interface.
    // But until then, we need to keep the form from changing the
    // property_type or property_name of the already existing properties.
    if (!array_key_exists($property_name, $new_properties) || $new_properties[$property_name]['type'] == $property_type) {
      $new_properties[$property_name] = array(
        'label' => $state['values']['property_label'],
        'type' => $state['values']['property_type'],
      );
      if (array_key_exists('property_behavior', $state['values'])) {
        $new_properties[$state['values']['property_name']]['behavior'] = $state['values']['property_behavior'];
      }
    }
    else {
      drupal_set_message("Can not modify the type of {$property_name}", "error");
    }
  }
  $form['new_properties'] = array(
    '#type' => 'value',
    '#value' => $new_properties,
  );

  // This is the select table where all the new properties are shown.
  $header = array(
    'machine_name' => t('Machine Name'),
    'name' => t('Name'),
    'type' => t('Type'),
    'behavior' => t('Behaviour'),
  );
  $options = array();

  // @todo can we do this in a better way.. the only way I can think of is,
  // load all defaults, and then load all the properties in the entity type,
  // while modifying the before added default properties given the entity
  // type settings.
  $property_arrays = array(
    'new_properties',
  );
  foreach ($property_arrays as $array_name) {
    foreach (${$array_name} as $property_name => $property_info) {
      $options[$property_name] = array(
        'machine_name' => $property_name,
        'name' => $property_info['label'],
        'type' => $property_info['type'],
      );
      if (array_key_exists('behavior', $property_info)) {
        $options[$property_name]['behavior'] = $property_info['behavior'];
      }
      else {
        $options[$property_name]['behavior'] = "";
      }
    }
  }
  $form["new_properties_table_label"] = array(
    '#markup' => '<h3>Properties</h3>',
  );
  $defaults = array();
  foreach ($entity_type_properties as $property => $info) {
    $defaults[$property] = 1;
  }
  $form['new_properties_table'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $options,
    '#empty' => t('No other properties for this entity type.'),
    '#default_value' => $defaults,
  );

  // Add a new property.
  $types[t('Generic')] = eck_property_types();
  $form["add_new_property"] = array(
    '#markup' => '<h3>Add new property</h3>',
  );
  $form['property_type'] = array(
    '#type' => 'select',
    '#title' => t('Type'),
    '#options' => array(
      '' => t('- Please choose -'),
    ) + $types,
    '#required' => TRUE,
    '#after_build' => array(
      'eck_deactivate_on_save',
    ),
  );
  $form["property_label"] = array(
    '#type' => 'textfield',
    '#title' => t("Name"),
    '#description' => t("A human readable name for the property."),
    '#required' => TRUE,
    '#after_build' => array(
      'eck_deactivate_on_save',
    ),
  );
  $form["property_name"] = array(
    '#type' => 'machine_name',
    '#machine_name' => array(
      'exists' => '_eck_fake_exists',
      'source' => array(
        'property_label',
      ),
    ),
    '#after_build' => array(
      'eck_deactivate_on_save',
    ),
  );
  $behavior_plugins = ctools_get_plugins('eck', 'property_behavior');
  $options = array();
  foreach ($behavior_plugins as $behavior => $info) {
    $options[$behavior] = $info['label'];
  }
  $form['property_behavior'] = array(
    '#type' => 'select',
    '#title' => t('Behavior'),
    '#options' => array(
      '' => t('- Please choose -'),
    ) + $options,
  );
  $form['property_add'] = array(
    '#type' => 'submit',
    '#value' => t('Add Property'),
  );
  $form['line_break'] = array(
    '#markup' => '<br \\><hr \\><br \\>',
  );
  $form['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}