/[drupal]/contributions/modules/combofield/combo.module

Diff of /contributions/modules/combofield/combo.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.1,
Sat Sep  5 13:41:30 2009 UTC
+revision 1.2,
Sun Oct 18 03:52:02 2009 UTC
 Line 1
  <?php
- // $Id: text.module,v 1.3 2009/02/10 03:16:15 webchick Exp $
+ // $Id: combo.module,v 1.1 2009/09/05 13:41:30 bjaspan Exp $
  /**
   * @file
 Line 129 
 function combo_atomize($atom) {
  }
  /**
+  * Implementation of hook_menu().
+  */
+ function combo_menu() {
+   $items = array();
+   $items['admin/structure/combofield'] = array(
+     'title' => 'Combo fields',
+     'page callback' => 'combo_overview_page',
+     'access arguments' => array('administer content types'),
+     'type' => MENU_NORMAL_ITEM,
+   );
+   foreach (field_info_fields() as $field) {
+     if ($field['type'] == 'combo') {
+       $urlstr = str_replace('_', '-', $field['field_name']);
+       $items["admin/structure/combofield/$urlstr"] = array(
+         'title' => $field['field_name'],
+         'page callback' => 'combo_page',
+         'page arguments' => array(3),
+         'access arguments' => array('administer content types'),
+         'type' => MENU_CALLBACK,
+       );
+       $items["admin/structure/combofield/$urlstr/edit"] = array(
+         'title' => 'Edit',
+         'type' => MENU_DEFAULT_LOCAL_TASK,
+       );
+     }
+   }
+   dpm('combo menu');
+   dpm($items);
+   return $items;
+ }
+ function combo_overview_page() {
+   $output = '';
+   foreach (field_info_fields() as $field) {
+     if ($field['type'] == 'combo') {
+       $output .= "<p>".l($field['field_name'], 'admin/structure/combofield/' . str_replace('_', '-', $field['field_name']))."</p>";
+     }
+   }
+   return $output;
+ }
+ function combo_page($arg = NULL) {
+   return "Hi!: $arg";
+ }
+ /**********************************************************************
+  * Entity API
+  **********************************************************************/
+ /**
   * Implement hook_entity_info().
   */
  function combo_entity_info() {
    $return = array(
      'combo' => array(
        'label' => t('Combo field'),
+       'controller class' => 'ComboFieldController',
        'fieldable' => TRUE,
        'object keys' => array(
          'id' => 'id',
-Line 147 
 function combo_entity_info() {
+Line 200 
 function combo_entity_info() {
    );
    // Every combo field name is a combo entity bundle.
-   foreach (field_info_fields() as $field) {
+   $fields = field_read_fields(array('type' => 'combo'));
+   foreach ($fields as $field) {
      if ($field['type'] == 'combo') {
        $return['combo']['bundles'][$field['field_name']] = array(
          'label' => $field['field_name'],
+         'admin' => array(
+           'path' => 'admin/structure/combofield/'. str_replace('_', '-', $field['field_name']),
+           'access arguments' => array('administer content types'),
+         ),
        );
      }
    }
    return $return;
  }
+ function combo_load($id) {
+   return entity_load('combo', array($id => $id));
+ }
+ class ComboFieldController implements DrupalEntityControllerInterface {
+   /**
+    * Constructor.
+    *
+    * @param $entityType
+    *   The entity type for which the instance is created.
+    */
+   public function __construct($entityType) {
+   }
+   /**
+    * Reset the internal, static entity cache.
+    */
+   public function resetCache() {
+   }
+   /**
+    * Load one or more entities.
+    *
+    * @param $ids
+    *   An array of entity IDs, or FALSE to load all entities.
+    * @param $conditions
+    *   An array of conditions in the form 'field' => $value.
+    *
+    * @return
+    *   An array of entity objects indexed by their ids.
+    */
+   public function load($ids = array(), $conditions = array()) {
+     dpm('combo load');
+     dpm($ids);
+     dpm($conditions);
+     // TODO: not sure what "all entities" means here
+     $entities = array();
+     foreach ($ids as $id) {
+       // TODO: Questions: What is the vid?  And how do I find out the
+       // bundle of this entity == the combo field it is a delta of?
+       // Without it, I cannot load sub-fields...
+       $combo_entity = field_attach_create_stub_object('combo', array($id, NULL, 'combo1'));
+       $entites[$id] = $combo_entity;
+     }
+     return $entities;
+   }
+ }
+ /**********************************************************************
+  * Field Type API
+  **********************************************************************/
  /**
   * Implementation of hook_field_info().
   */
-Line 194 
 function combo_field_load($obj_type, $ob
+Line 304 
 function combo_field_load($obj_type, $ob
      // Our combo data items are loaded, but still serialized.
      foreach ($combo_items[$obj_id] as $combo_delta => &$combo_item) {
        $combo_item['deltas'] = unserialize($combo_item['deltas']);
-     }
-     // Create the combo entity for $field on $object.
+       // Create the combo entity for $field/$combo_delta on $object.
-     // TODO: Why do we need to pass $instance here?
+       $combo_entity = _combo_create_entity($obj_type, $object, $combo_field, $combo_delta);
-     list($obj_id) = field_attach_extract_ids($obj_type, $object);
-     $combo_entity = _combo_create_entity($obj_type, $object, $combo_field, $combo_instances[$obj_id]);
-     // Load field data for the combo entity, which is all the fields
+       // Load field data for the combo entity, which is all the fields
-     // attached to the combo field.
+       // attached to the combo field.
-     field_attach_load('combo', array($combo_entity->id => $combo_entity), $age, $options);
+       field_attach_load('combo', array($combo_entity->id => $combo_entity), $age, $options);
-     // Collate each $combo_entity field's data into $combo_items, which is
+       // Collate each $combo_entity field's data into $combo_items, which is
-     // what will end up on $object->{combo_field_name}.
+       // what will end up on $object->{combo_field_name}.
-     $entity_instances = field_info_instances($combo_field['field_name']);
+       $entity_instances = field_info_instances($combo_field['field_name']);
-     foreach ($entity_instances as $entity_instance) {
+       foreach ($entity_instances as $entity_instance) {
-       foreach ($combo_items[$obj_id] as $combo_delta => &$combo_item) {
          // It is possible this combo item will have no data for one of
          // the sub-fields.
          // TODO: The extra $combo_deltas here is unnecessary, a
-Line 241 
 function combo_field_update($obj_type, $
+Line 347 
 function combo_field_update($obj_type, $
    $entity_instances = field_info_instances($field['field_name']);
    foreach ($items as $combo_delta => &$combo_item) {
      // Create the combo entity for $field/$combo_delta on $object
-     $combo_entity = _combo_create_entity($obj_type, $object, $field, $instance);
+     $combo_entity = _combo_create_entity($obj_type, $object, $field, $combo_delta);
      $item_deltas = array();
-Line 276 
 function combo_field_update($obj_type, $
+Line 382 
 function combo_field_update($obj_type, $
    }
  }
+ function combo_field_is_empty($item, $field) {
+   dpm('field is empty?');
+   dpm($item);
+   return FALSE;
+ }
  /**
   * Create a combo entity whose id is based on the object the combo
   * field is attached to and whose bundle is the name of the combo
   * field.
   */
- function _combo_create_entity($obj_type, $object, $field, $instance) {
+ function _combo_create_entity($obj_type, $object, $field, $delta) {
-   list($obj_id) = field_attach_extract_ids($obj_type, $object);
-   $combo_id = _combo_get_id($obj_type, $object, $field, $instance);
-   $combo_vid = _combo_get_vid($obj_type, $object, $field, $instance);
    $combo_bundle = $field['field_name'];
-   $combo_entity = field_attach_create_stub_object('combo', array($combo_id, $combo_vid, $combo_bundle));
+   if (isset($object)) {
+     list($obj_id) = field_attach_extract_ids($obj_type, $object);
+     $combo_id = combo_atomize("{$obj_type}-{$obj_id}-{$delta}");
+     // TODO
+     $combo_vid = NULL;
+     $combo_entity = field_attach_create_stub_object('combo', array($combo_id, $combo_vid, $combo_bundle));
+   }
+   else {
+     $combo_entity = field_attach_create_stub_object('combo', array(NULL, NULL, $combo_bundle));
+   }
    return $combo_entity;
  }
- /**
-  * Create or retrieve a unique id for the combo entity for a combo
-  * field on an object type.
-  */
- function _combo_get_id($obj_type, $object, $field, $instance) {
-   list($obj_id) = field_attach_extract_ids($obj_type, $object);
-   return combo_atomize("{$obj_type}-id-{$obj_id}");
- }
- /**
-  * Create or retrieve a unique revision id for the combo entity for a combo
-  * field on an object type.
-  */
- function _combo_get_vid($obj_type, $object, $field, $instance) {
-   // TODO
-   return NULL;
- }
  /**********************************************************************
   * Field Type API: Formatters
   **********************************************************************/
-Line 339 
 function combo_theme() {
+Line 440 
 function combo_theme() {
   * Theme function for 'default' text field formatter.
   */
  function theme_field_formatter_combo_default($element) {
-   return 'combo field';
+   return '<pre>'.print_r($element,1).'</pre>';
  }
  /**********************************************************************
-Line 368 
 function combo_field_widget_info() {
+Line 469 
 function combo_field_widget_info() {
   * 'rgb' form element.
   */
  function combo_field_widget(&$form, &$form_state, $field, $instance, $langcode, $items, $delta = 0) {
-   return array();
+   $form[$field['field_name']] = array(
+     '#type' => 'fieldset',
+     '#title' => $instance['label'],
+     '#description' => 'Combofield widget!',
+     '#tree' => TRUE,
+   );
+   $delta = 0;
+   foreach ($items as $delta => $item) {
+     // Create the combo entity for $field/$combo_delta on $object.
+     // WTF is $object? The object this form is being created to edit.
+     // Do I get that info in $form_state? If not, I can/should store
+     // it in the combo field's columns, so it will be included in $item.
+     // TODO: Pass $item so $combo_entity gets default values (?)
+     $combo_entity = _combo_create_entity($obj_type, $object, $field, $delta);
+     dpm($combo_entity);
+     field_attach_form('combo', $combo_entity, $form[$field['field_name']][$langcode][$delta], $form_state, $langcode);
+   }
+   $combo_entity = _combo_create_entity(NULL, NULL, $field, $delta);
+   field_attach_form('combo', $combo_entity, $form[$field['field_name']][$langcode][$delta], $form_state, $langcode);
+   // TODO: Problem. Widgets assume their field and instance are
+   // accessible via $form['#fields'][field_name].  I can copy them
+   // there now, but this makes me realize that it is possible to
+   // attach the same field to an object twice via different combo
+   // fields, so $form['#fields'][field_name] will no longer be
+   // unique.  Also, something is clearly going to be bite me soon
+   // regarding widgets looking for their form elements in the wrong
+   // place... perhaps I am re-inventing logic needed for fieldgroups?
+   $form['#fields'] = array_merge($form['#fields'], $form[$field['field_name']][$langcode][$delta]['#fields']);
+   return $form;
  }

 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.2
 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.2
-Removed from v.1.1
+Added in v.1.2

	ViewVC Help
Powered by ViewVC 1.1.2