modules/cck_fullname/cck_fullname.module

<?php
/**
 * This is the cck_fullname module for use with CCK.
 * 
 * <p>This file contains information on the cck_fullname module. The module adds to
 * the field types available for inclusion in a content type definition. This field
 * is made up of five standard html form text fields - prefix, first name, middle,
 * last, and suffix - times two; one set for legal names and one for preferred.
 * See the README for more details.</p>
 * TODO it looks like the stars for the required fields might not work on small screens so
 * instead, maybe use outlines - yellow for required on required fields, blue for required
 * on optional field?
 *  
 * @version $Id$;
 * @package CCK_Fullname
 * @category NeighborForge
 * @author Ryan Constantine
 * @filesource
 * @license http://www.gnu.org/licenses/gpl.txt GNU_GENERAL_PUBLIC_LICENSE
 * @link none yet
 */


//-----------------------------------------CCK hooks--------------------------------------------------
//-----------------------------------------CCK hooks--------------------------------------------------
//-----------------------------------------CCK hooks--------------------------------------------------
 
/**
 * Implementation of hook_field_info().
 * 
 * @return
 *   An array keyed by field type name. Each element of the array is an associative
 *   array with these keys and values:
 *   - "label": The human-readable label for the field type.
 */
function cck_fullname_field_info() {
  return array(
    'cck_fullname' => array('label' => 'Full Name'),
  );
} // function cck_fullname_field_info()

/**
 * Implementation of hook_field_settings().
 * 
 * @param $op
 *   The operation to be performed.
 * @param $field
 *   The field on which the operation is to be performed.
 * @return
 *   This varies depending on the operation.
 *   - "form": an array of form elements to add to
 *     the settings page.
 *   - "validate": no return value. Use form_set_error().
 *   - "save": an array of names of form elements to
 *     be saved in the database.
 *   - "database columns": an array keyed by column name, with arrays of column 
 *     information as values.
 *   - "filters": an array whose values are 'filters'
 *     definitions as expected by views.module (see Views Documentation).
 *   - "callbacks": an array describing the field's behaviour regarding hook_field 
 *     operations. The array is keyed by hook_field operations ('view', 'validate'...)
 *     and has the following possible values : 
 *       CONTENT_CALLBACK_NONE     : do nothing for this operation 
 *       CONTENT_CALLBACK_CUSTOM   : use the behaviour in hook_field(operation)
 *       CONTENT_CALLBACK_DEFAULT  : use content.module's default bahaviour
 *     Note : currently only the 'view' operation implements this feature. 
 *     All other field operation implemented by the module _will_ be executed 
 *     no matter what.
 */
function cck_fullname_field_settings($op, $field) {
  switch ($op) {
    case 'form':
      $form = array();
      
      //borrowed from namefield module
      //----------allow content type creator to determine which fields are required-----------
      $required_default = array();
      if (is_array($field['required_parts'])) {
        foreach ($field['required_parts'] as $part => $required) {
          if ($required) { $required_default[] = $part; }
        } // foreach possibly-required part
      } else {
        $required_default = array('legal_first', 'legal_last');
      } // if we can make up our own defaults
        
      $form['required'] = array(
        '#type' => 'fieldset',
        '#weight' => 3,
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#title' => t("Required Parts"),
      );
      $form['required']['required_parts'] = array(
        '#type' => 'checkboxes',
        '#title' => t("Required Parts"),
        '#description' => t("Choose which of these components should be required.
        Only applies if you chose the field in the above <em>Legal name</em> or <em>Preferred name</em> sections,
        either <strong>Required</strong>, or <strong>Optional</strong>. (Ex. 1) If you <strong>Require</strong>
        Legal names, then the fields checked here will be a part of that requirement. Unchecked fields will be optional
        if you elected to use them above.
        (Ex. 2) If Preferred names are <strong>Optional</strong>, then all fields are optional until one is filled in,
        then those checked here are required. Unchecked fields would still be optional. This will
        prevent the entering of partial/incomplete names."),
        '#default_value' => $required_default,
        '#options' => array(
          'legal_prefix' => t("Legal Prefix"),
          'legal_first'  => t("Legal First"),
          'legal_middle' => t("Legal Middle"),
          'legal_last'   => t("Legal Last"),
          'legal_suffix' => t("Legal Suffix"),
          'preferred_prefix' => t("Preferred Prefix"),
          'preferred_first'  => t("Preferred First"),
          'preferred_middle' => t("Preferred Middle"),
          'preferred_last'   => t("Preferred Last"),
          'preferred_suffix' => t("Preferred Suffix"),
        ),
      );

      //----------allow content type creator to determine which legal name fields to use-----------
      $legal_default = array();
      if (is_array($field['legalname'])) {
        foreach ($field['legalname'] as $part => $legal) {
          if ($legal) { $legal_default[] = $part; }
        } // foreach possibly-legal part
      } else {
        $legal_default = array('legal_first', 'legal_middle', 'legal_last');
      } // if we can make up our own default
  
      $form['legal_name'] = array(
        '#type' => 'fieldset',
        '#weight' => 2,
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#title' => t('Legal Name'),
      );
      $form['legal_name']['use_legalname'] = array(
        '#type' => 'radios',
        '#title' => t('Use legal name?'),
        '#description' => t("Check how legal names should be used. The legal name is the default name when only one is needed."),
        '#required' => TRUE,
        '#default_value' => isset($field['use_legalname']) ? $field['use_legalname'] : 'legal_require',
        '#options' => array(
          'legal_require' => t("Required"),
          'legal_optional'  => t("Optional"),
        ),
      );
      $form['legal_name']['legalname'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Legal name'),
        '#description' => t("Check which of these fields should be available for legal names."),
        '#required' => TRUE,
        '#default_value' => $legal_default,
        '#options' => array(
          'legal_prefix' => t("Prefix"),
          'legal_first'  => t("First"),
          'legal_middle' => t("Middle"),
          'legal_last'   => t("Last"),
          'legal_suffix' => t("Suffix"),
        ),
      );
      //end borrowed section
      
      //similar to copied section
      //----------allow content type creator to determine which preferred name fields to use-----------
      $preferred_default = array();
      if (is_array($field['preferredname'])) {
        foreach ($field['preferredname'] as $part => $preferred) {
          if ($preferred) { $preferred_default[] = $part; }
        } // foreach possibly-legal part
      } else {
        $preferred_default = array('preferred_first', 'preferred_middle', 'preferred_last');
      } // if we can make up our own default
  
      $form['preferred_name'] = array(
        '#type' => 'fieldset',
        '#weight' => 2,
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#title' => t('Preferred Name'),          
      );
      $form['preferred_name']['use_preferredname'] = array(
        '#type' => 'radios',
        '#title' => t('Use preferred name?'),
        '#description' => t("Check how preferred names should be used."),
        '#required' => TRUE,
        '#default_value' => isset($field['use_preferredname']) ? $field['use_preferredname'] : 'preferred_optional',
        '#options' => array(
          'preferred_require' => t("Required"),
          'preferred_optional'  => t("Optional"),
          'preferred_hide'  => t("Don't use"),
        ),
      );
      $form['preferred_name']['preferredname'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Preferred Name'),
        '#description' => t("Check which of these fields should be available for preferred names."),
        '#required' => TRUE,
        '#default_value' => $preferred_default,
        '#options' => array(
          'preferred_prefix' => t("Prefix"),
          'preferred_first'  => t("First"),
          'preferred_middle' => t("Middle"),
          'preferred_last'   => t("Last"),
          'preferred_suffix' => t("Suffix"),
        ),
      );
    
      $form['note'] = array(
        '#type' => 'item',
        '#title' => t('Notes'),
        '#weight' => -1,
        '#description' => t('In the "Help text" field above, cut and paste the following: Notice the stars indicating what is required.
        If either "Legal name" or "Preferred name" have stars next to them, that means you must fill out at least the fields which have a highlighted border.
        If either "Legal name" or "Preferred name" do not have stars, then you only fill out the fields which have a highlighted border if you fill out ANY of the
        fields. If you leave all highlighted fields blank for an unstarred name, then you don\'t have to fill out ANY of them. For multiple sets of
        names, names after the first set are always optional, but their fields will follow the same rules as optional names already explained.'),
      );
      
      $form['middle_initial'] = array(//TODO remove this because with the ability to specify the field length, this is redundant
        '#type' => 'checkbox',
        '#title' => t('Use middle initial only?'),
        '#default_value' => isset($field['middle_initial']) ? $field['middle_initial'] : 1,
        '#return_value' => 1,
        '#description' => t('Do you want to store only middle initials? This is not simply a display option and should be set only once. Changing it has unpredictable results.'),
      );
      
      //-------------specify maximum lengths for each field------------------------
      $form['max_lengths_legal'] = array(
        '#type' => 'fieldset',
        '#weight' => 4,
        '#title' => t('Legal name maximum field lengths'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      $form['max_lengths_legal']['max_length_prefix_legal'] = array(
        '#type' => 'textfield',
        '#title' => t('Prefix maximum length'),
        '#size' => 1,
        '#default_value' => isset($field['max_length_prefix_legal']) ? $field['max_length_prefix_legal'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_legal']['max_length_first_legal'] = array(
        '#type' => 'textfield',
        '#title' => t('First name maximum length'),
        '#size' => 6,
        '#default_value' => isset($field['max_length_first_legal']) ? $field['max_length_first_legal'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_legal']['max_length_middle_legal'] = array(
        '#type' => 'textfield',
        '#title' => t('Middle name maximum length'),
        '#size' => 6,
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters (unless Middle Initial is used instead). Leave blank for an unlimited size.'),
      );
      if ($field['middle_initial'] == 1) {
        $form['max_lengths_legal']['max_length_middle_legal']['#default_value'] = 1;
      }
      else {
        $form['max_lengths_legal']['max_length_middle_legal']['#default_value'] = isset($field['max_length_middle_legal']) ? $field['max_length_middle_legal'] : '';
      }
      $form['max_lengths_legal']['max_length_last_legal'] = array(
        '#type' => 'textfield',
        '#title' => t('Last name maximum length'),
        '#size' => 6,
        '#default_value' => isset($field['max_length_last_legal']) ? $field['max_length_last_legal'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_legal']['max_length_suffix_legal'] = array(
        '#type' => 'textfield',
        '#title' => t('Suffix maximum length'),
        '#size' => 1,
        '#default_value' => isset($field['max_length_suffix_legal']) ? $field['max_length_suffix_legal'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      
      $form['max_lengths_preferred'] = array(
        '#type' => 'fieldset',
        '#weight' => 4,
        '#title' => t('Preferred name maximum field lengths'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      $form['max_lengths_preferred']['max_length_prefix_preferred'] = array(
        '#type' => 'textfield',
        '#title' => t('Prefix maximum length'),
        '#size' => 1,
        '#default_value' => isset($field['max_length_prefix_preferred']) ? $field['max_length_prefix_preferred'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_preferred']['max_length_first_preferred'] = array(
        '#type' => 'textfield',
        '#title' => t('First name maximum length'),
        '#size' => 6,
        '#default_value' => isset($field['max_length_first_preferred']) ? $field['max_length_first_preferred'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_preferred']['max_length_middle_preferred'] = array(
        '#type' => 'textfield',
        '#title' => t('Middle name maximum length'),
        '#size' => 6,
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters (unless Middle Initial is used instead). Leave blank for an unlimited size.'),
      );
      if ($field['middle_initial'] == 1) {
        $form['max_lengths_preferred']['max_length_middle_preferred']['#default_value'] = 1;
      }
      else {
        $form['max_lengths_preferred']['max_length_middle_preferred']['#default_value'] = isset($field['max_length_middle_preferred']) ? $field['max_length_middle_preferred'] : '';
      }
      $form['max_lengths_preferred']['max_length_last_preferred'] = array(
        '#type' => 'textfield',
        '#title' => t('Last name maximum length'),
        '#size' => 6,
        '#default_value' => isset($field['max_length_last_preferred']) ? $field['max_length_last_preferred'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      $form['max_lengths_preferred']['max_length_suffix_preferred'] = array(
        '#type' => 'textfield',
        '#title' => t('Suffix maximum length'),
        '#size' => 1,
        '#default_value' => isset($field['max_length_suffix_preferred']) ? $field['max_length_suffix_preferred'] : '',
        '#required' => FALSE,
        '#description' => t('The maximum length of the field in characters. Leave blank for an unlimited size.'),
      );
      
      return $form;

    case 'save':
      return array(
        'required_parts',
        'use_legalname',
        'legalname',
        'use_preferredname',
        'preferredname',
        'middle_initial',
        'max_length_prefix_legal',
        'max_length_first_legal',
        'max_length_middle_legal',
        'max_length_last_legal',
        'max_length_suffix_legal',
        'max_length_prefix_preferred',
        'max_length_first_preferred',
        'max_length_middle_preferred',
        'max_length_last_preferred',
        'max_length_suffix_preferred',
      );
      
    case 'database columns':
      $columns = array(
        'last' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'first' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'middle' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'prefix' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'suffix' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'last_preferred' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'first_preferred' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'middle_preferred' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'prefix_preferred' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
        'suffix_preferred' => array('type' => 'varchar', 'not null' => TRUE, 'default' => "''", 'sortable' => TRUE),
      );
      //adjust field lengths based on settings for legal names
      if ($field['max_lengths_legal']['max_length_prefix_legal'] == 0 || $field['max_lengths_legal']['max_length_prefix_legal'] > 255) {
        $columns['prefix']['type'] = 'longtext';
      }
      else {
        $columns['prefix']['length'] = $field['max_lengths_legal']['max_length_prefix_legal'];
      }
      if ($field['max_lengths_legal']['max_length_first_legal'] == 0 || $field['max_lengths_legal']['max_length_first_legal'] > 255) {
        $columns['first']['type'] = 'longtext';
      }
      else {
        $columns['first']['length'] = $field['max_lengths_legal']['max_length_first_legal'];
      }
      if (($field['max_lengths_legal']['max_length_middle_legal'] == 0 || $field['max_lengths_legal']['max_length_middle_legal'] > 255) && ($field['middle_initial'] != 1)) {
        $columns['middle']['type'] = 'longtext';
      }
      elseif ($field['middle_initial'] == 1) {
        $columns['middle']['length'] = 1;
      }
      else {
        $columns['middle']['length'] = $field['max_lengths_legal']['max_length_middle_legal'];
      }
      if ($field['max_lengths_legal']['max_length_last_legal'] == 0 || $field['max_lengths_legal']['max_length_last_legal'] > 255) {
        $columns['last']['type'] = 'longtext';
      }
      else {
        $columns['last']['length'] = $field['max_lengths_legal']['max_length_last_legal'];
      }
      if ($field['max_lengths_legal']['max_length_suffix_legal'] == 0 || $field['max_lengths_legal']['max_length_suffix_legal'] > 255) {
        $columns['suffix']['type'] = 'longtext';
      }
      else {
        $columns['suffix']['length'] = $field['max_lengths_legal']['max_length_suffix_legal'];
      }
      
      //adjust field lengths based on settings for preferred names
      if ($field['max_lengths_preferred']['max_length_prefix_preferred'] == 0 || $field['max_lengths_preferred']['max_length_prefix_preferred'] > 255) {
        $columns['prefix_preferred']['type'] = 'longtext';
      }
      else {
        $columns['prefix_preferred']['length'] = $field['max_lengths_preferred']['max_length_prefix_preferred'];
      }
      if ($field['max_lengths_preferred']['max_length_first_preferred'] == 0 || $field['max_lengths_preferred']['max_length_first_preferred'] > 255) {
        $columns['first_preferred']['type'] = 'longtext';
      }
      else {
        $columns['first_preferred']['length'] = $field['max_lengths_preferred']['max_length_first_preferred'];
      }
      if (($field['max_lengths_preferred']['max_length_middle_preferred'] == 0 || $field['max_lengths_preferred']['max_length_middle_preferred'] > 255) && ($field['middle_initial'] != 1)) {
        $columns['middle_preferred']['type'] = 'longtext';
      }
      elseif ($field['middle_initial'] == 1) {
        $columns['middle_preferred']['length'] = 1;
      }
      else {
        $columns['middle_preferred']['length'] = $field['max_lengths_preferred']['max_length_middle_preferred'];
      }
      if ($field['max_lengths_preferred']['max_length_last_preferred'] == 0 || $field['max_lengths_preferred']['max_length_last_preferred'] > 255) {
        $columns['last_preferred']['type'] = 'longtext';
      }
      else {
        $columns['last_preferred']['length'] = $field['max_lengths_preferred']['max_length_last_preferred'];
      }
      if ($field['max_lengths_preferred']['max_length_suffix_preferred'] == 0 || $field['max_lengths_preferred']['max_length_suffix_preferred'] > 255) {
        $columns['suffix_preferred']['type'] = 'longtext';
      }
      else {
        $columns['suffix_preferred']['length'] = $field['max_lengths_preferred']['max_length_suffix_preferred'];
      }
      return $columns;

   case 'filters':
     return array(
        'default' => array(
          'operator' => 'views_handler_operator_like',
          'handler' => 'views_handler_filter_like',
        ),
      );
     
    case 'callbacks'://pairs up with cck_fullname_field::view
      return array(
        'view' => CONTENT_CALLBACK_CUSTOM,
      );
  }
} // function cck_fullname_field_settings()

/**
 * Implementation of hook_field().
 * 
 * Validate the user's input. At present, only English alphabetic characters
 * are valid. Would like to add support for other languages.
 * Or present the data for viewing.
 * @param $op
 *   What kind of action is being performed.
 * @param &$node
 *   The node the action is being performed on.
 * @param $field
 *   The field the action is being performed on.
 * @param &$node_field
 *   The contents of the field in this node. Changes to this variable will
 *   be saved back to the node object.
 * @return
 *   This varies depending on the operation.
 *   - The "load" operation should return an object containing extra values
 *     to be merged into the node object.
 *   - The "view" operation should return a string containing an HTML
 *     representation of the field data.
 *   - The "insert", "update", "delete", "validate", and "submit" operations
 *     have no return value.
 */
function cck_fullname_field($op, &$node, $field, &$items, $teaser, $page) {
  switch ($op) {
    case 'submit':
      $info = content_database_info($field['field_name']);
      break;
    case 'validate':
      //validate field lengths
      //validate the legal name field lengths; TODO restructure these into one big foreach instead of several small ones - use a case statement on $data, then test field lengths in each case
      if ($field['max_lengths_legal']['max_length_prefix_legal'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_prefix = $field['field_name']. '][' .$delta. '][prefix';
          if (strlen($data['prefix']) > $field['max_lengths_legal']['max_length_prefix_legal']) {
            form_set_error($error_field_prefix, t('%label\'s Prefix Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_legal']['max_length_prefix_legal'])));
          }
        }
      }
      if ($field['max_lengths_legal']['max_length_first_legal'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_first = $field['field_name']. '][' .$delta. '][first';
          if (strlen($data['first']) > $field['max_lengths_legal']['max_length_first_legal']) {
            form_set_error($error_field_first, t('%label\'s First Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_legal']['max_length_first_legal'])));
          }
        }
      }
      if ($field['max_lengths_legal']['max_length_middle_legal'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_middle = $field['field_name']. '][' .$delta. '][middle';
          if (strlen($data['middle']) > $field['max_lengths_legal']['max_length_middle_legal']) {
            form_set_error($error_field_middle, t('%label\'s Middle Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_legal']['max_length_middle_legal'])));
          }
        }
      }
      if ($field['max_lengths_legal']['max_length_last_legal'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_last = $field['field_name']. '][' .$delta. '][last';
          if (strlen($data['last']) > $field['max_lengths_legal']['max_length_last_legal']) {
            form_set_error($error_field_last, t('%label\'s Last Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_legal']['max_length_last_legal'])));
          }
        }
      }
      if ($field['max_lengths_legal']['max_length_suffix_legal'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_suffix = $field['field_name']. '][' .$delta. '][suffix';
          if (strlen($data['suffix']) > $field['max_lengths_legal']['max_length_suffix_legal']) {
            form_set_error($error_field_suffix, t('%label\'s Suffix Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_legal']['max_length_suffix_legal'])));
          }
        }
      }
      
      //validate the preferred name field lengths  
      if ($field['max_lengths_preferred']['max_length_prefix_preferred'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_prefix_preferred = $field['field_name']. '][' .$delta. '][prefix_preferred';
          if (strlen($data['prefix_preferred']) > $field['max_lengths_preferred']['max_length_prefix_preferred']) {
            form_set_error($error_field_prefix_preferred, t('%label\'s Prefix Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_preferred']['max_length_prefix_preferred'])));
          }
        }
      }
      if ($field['max_lengths_preferred']['max_length_first_preferred'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_first_preferred = $field['field_name']. '][' .$delta. '][first_preferred';
          if (strlen($data['first_preferred']) > $field['max_lengths_preferred']['max_length_first_preferred']) {
            form_set_error($error_field_first_preferred, t('%label\'s First Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_preferred']['max_length_first_preferred'])));
          }
        }
      }
      if ($field['max_lengths_preferred']['max_length_middle_preferred'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_middle_preferred = $field['field_name']. '][' .$delta. '][middle_preferred';
          if (strlen($data['middle_preferred']) > $field['max_lengths_preferred']['max_length_middle_preferred']) {
            form_set_error($error_field_middle_preferred, t('%label\'s Middle Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_preferred']['max_length_middle_preferred'])));
          }
        }
      }
      if ($field['max_lengths_preferred']['max_length_last_preferred'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_last_preferred = $field['field_name']. '][' .$delta. '][last_preferred';
          if (strlen($data['last_preferred']) > $field['max_lengths_preferred']['max_length_last_preferred']) {
            form_set_error($error_field_last_preferred, t('%label\'s Last Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_preferred']['max_length_last_preferred'])));
          }
        }
      }
      if ($field['max_lengths_preferred']['max_length_suffix_preferred'] > 0) {
        foreach ($items as $delta => $data) {
          $error_field_suffix_preferred = $field['field_name']. '][' .$delta. '][suffix_preferred';
          if (strlen($data['suffix_preferred']) > $field['max_lengths_preferred']['max_length_suffix_preferred']) {
            form_set_error($error_field_suffix_preferred, t('%label\'s Suffix Name field is longer than %max characters.', array('%label' => $field['widget']['label'], '%max' => $field['max_lengths_preferred']['max_length_suffix_preferred'])));
          }
        }
      }
      
      //validate required-ness of fields
      foreach ($items as $delta => $data) {
        if (is_numeric($delta)) {
          //deal with legal name fields
          if (($field['use_legalname'] == 'legal_require') || ($field['use_legalname'] == 'legal_optional')) {
            $legal_empty = (empty($data['prefix']) && empty($data['first']) && empty($data['middle']) && empty($data['last']) && empty($data['suffix']));
            if (!$legal_empty) {
              if (empty($data['prefix']) && $field['required_parts']['legal_prefix'] === 'legal_prefix' && !empty($field['legalname']['legal_prefix'])) {
                $error_field_prefix = $field['field_name']. '][' .$delta. '][prefix';
                form_set_error($error_field_prefix, t('Prefix field is required.'));
              }
              if (empty($data['first']) && $field['required_parts']['legal_first'] === 'legal_first' && !empty($field['legalname']['legal_first'])) {
                $error_field_first = $field['field_name']. '][' .$delta. '][first';
                form_set_error($error_field_first, t('First name field is required.'));
              }
              if (empty($data['middle']) && $field['required_parts']['legal_middle'] === 'legal_middle' && !empty($field['legalname']['legal_middle'])) {
                $error_field_middle = $field['field_name']. '][' .$delta. '][middle';
                form_set_error($error_field_middle, t('Middle name field is required.'));
              }
              if (empty($data['last']) && $field['required_parts']['legal_last'] === 'legal_last' && !empty($field['legalname']['legal_last'])) {
                $error_field_last = $field['field_name']. '][' .$delta. '][last';
                form_set_error($error_field_last, t('Last name field is required.'));
              }
              if (empty($data['suffix']) && $field['required_parts']['legal_suffix'] === 'legal_suffix' && !empty($field['legalname']['legal_suffix'])) {
                $error_field_suffix = $field['field_name']. '][' .$delta. '][suffix';
                form_set_error($error_field_suffix, t('Suffix field is required.'));
              }
            }
            elseif ($field['use_legalname'] == 'legal_require') {
              form_set_error($field['field_name']. '][' .$delta. ']', t('Legal name field is required.'));
            }
          }
                    
          //deal with preferred name fields
          if (($field['use_preferredname'] == 'preferred_require') || ($field['use_preferredname'] == 'preferred_optional')) {
            $preferred_empty = (empty($data['prefix_preferred']) && empty($data['first_preferred']) && empty($data['middle_preferred']) && empty($data['last_preferred']) && empty($data['suffix_preferred']));
            if (!$preferred_empty) {
              if (empty($data['prefix_preferred']) && $field['required_parts']['preferred_prefix'] === 'preferred_prefix' && !empty($field['preferredname']['preferred_prefix'])) {
                $error_field_prefix_preferred = $field['field_name']. '][' .$delta. '][prefix_preferred';
                form_set_error($error_field_prefix_preferred, t('Prefix field is required.'));
              }
              if (empty($data['first_preferred']) && $field['required_parts']['preferred_first'] === 'preferred_first' && !empty($field['preferredname']['preferred_first'])) {
                $error_field_first_preferred = $field['field_name']. '][' .$delta. '][first_preferred';
                form_set_error($error_field_first_preferred, t('First name field is required.'));
              }
              if (empty($data['middle_preferred']) && $field['required_parts']['preferred_middle'] === 'preferred_middle' && !empty($field['preferredname']['preferred_middle'])) {
                $error_field_middle_preferred = $field['field_name']. '][' .$delta. '][middle_preferred';
                form_set_error($error_field_middle_preferred, t('Middle name field is required.'));
              }
              if (empty($data['last_preferred']) && $field['required_parts']['preferred_last'] === 'preferred_last' && !empty($field['preferredname']['preferred_last'])) {
                $error_field_last_preferred = $field['field_name']. '][' .$delta. '][last_preferred';
                form_set_error($error_field_last_preferred, t('Last name field is required.'));
              }
              if (empty($data['suffix_preferred']) && $field['required_parts']['preferred_suffix'] === 'preferred_suffix' && !empty($field['preferredname']['preferred_suffix'])) {
                $error_field_suffix_preferred = $field['field_name']. '][' .$delta. '][suffix_preferred';
                form_set_error($error_field_suffix_preferred, t('Suffix field is required.'));
              }
            }
            elseif ($field['use_preferredname'] == 'preferred_require') {
              form_set_error($field['field_name']. '][' .$delta. ']', t('Preferred name field is required.'));
            }
          }
        }
      }
      break;
    
    case 'view':
      $context = $teaser ? 'teaser' : 'full';
      $formatter = isset($field['display_settings'][$context]['format']) ? $field['display_settings'][$context]['format'] : 'default';
      foreach ($items as $delta => $item) {
        $items[$delta]['view'] = content_format($field, $item, $formatter, $node);
      }
      return theme('field', $node, $field, $items, $teaser, $page);
  }
} // function cck_fullname_field()

/**
 * Implementation of hook_field_formatter_info().
 */
function cck_fullname_field_formatter_info() {
  return array(
    'default' => array(
      'label' => t('Default, prefix first middle last suffix'),
      'field types' => array('cck_fullname'),
    ),
    'last_name_only' => array(
      'label' => t('Last name only'),
      'field types' => array('cck_fullname'),
    ),
    'first_name_only' => array(
      'label' => t('First name only'),
      'field types' => array('cck_fullname'),
    ),
    'last_name_first' => array(
      'label' => t('Last, first middle'),
      'field types' => array('cck_fullname'),
    ),
  );
} // function cck_fullname_field_formatter_info()

/**
 * Implemetation of hook_field_formatter().
 *
 * Here we format the data for display and make sure it is plain text. It should be as 
 * elsewhere it was validated as alphabetic characters only.
 * We also check the length of each name and if it's only one character, place a period
 * after it. Primarily this is for people who go by two initials, or who use an initial
 * for their first name, but not middle.
 * The $node argument is necessary so that filter access can be checked on
 * node preview. 
 * @param $field
 *   The field the action is being performed on.
 * @param $item
 *   An array, keyed by column, of the data stored for this item in this field.
 * @param $formatter
 *   The name of the formatter being used to display the field. In our case, we name
 *   it directly, rather than send it through content_format() and therefore we don't
 *   use hook_field_formatter_info either.
 * @param $node
 *   The node object, for context. Will be NULL in some cases.
 *   Warning : when displaying field retrieved by Views, $node will not
 *   be a "full-fledged" node object, but an object containg the data returned
 *   by the Views query (at least nid, vid, changed)
 * @return
 *   An HTML string containing the formatted item.
 */
function cck_fullname_field_formatter($field, $item, $formatter, $node) {
  $output = '';
  if (!key_exists('prefix', $item)) {
    return '';
  }
  switch ($formatter) {
    case 'default':
      //check and clean the values for output
      if (!empty($item['prefix'])) {
        $cck_legalname['prefix'] = strip_tags($item['prefix']);
      }
      if (!empty($item['first'])) {
        $cck_legalname['first'] = strip_tags($item['first']);
      }
      if (!empty($item['middle'])) {
        $cck_legalname['middle'] = strip_tags($item['middle']);
      }
      if (!empty($item['last'])) {
        $cck_legalname['last'] = strip_tags($item['last']);
      }
      if (!empty($item['suffix'])) {
        $cck_legalname['suffix'] = strip_tags($item['suffix']);
      }
      if (!empty($cck_legalname)) {
        $output .= t('Legal name: '). theme('cck_fullname', $cck_legalname, $field);
      }
      if (!empty($item['prefix_preferred'])) {
        $cck_preferredname['prefix'] = strip_tags($item['prefix_preferred']);
      }
      if (!empty($item['first_preferred'])) {
        $cck_preferredname['first'] = strip_tags($item['first_preferred']);
      }
      if (!empty($item['middle_preferred'])) {
        $cck_preferredname['middle'] = strip_tags($item['middle_preferred']);
      }
      if (!empty($item['last_preferred'])) {
        $cck_preferredname['last'] = strip_tags($item['last_preferred']);
      }
      if (!empty($item['suffix_preferred'])) {
        $cck_preferredname['suffix'] = strip_tags($item['suffix_preferred']);
      }
      if (!empty($cck_preferredname)) {//if there is a preferred name, print it instead of the legal name (overwrite $output)
        $output = t('Preferred name: '). theme('cck_fullname', $cck_preferredname, $field);
      }
      return $output;
    case 'last_name_only'://output legal last name
      //check and clean the values for output
        if (isset($item['last'])) {
          $cck_fullname['last'] = strip_tags($item['last']);
        }
        $output .= theme('cck_fullname', $cck_fullname, $field);
      return $output;
    case 'first_name_only'://output preferred first name
      //check and clean the values for output
        if (isset($item['first_preferred'])) {
          $cck_fullname['first_preferred'] = strip_tags($item['first_preferred']);
        }
        $output .= theme('cck_fullname', $cck_fullname, $field);
      return $output;
    case 'last_name_first':
      //check and clean the values for output
      if (!empty($item['prefix'])) {
        $cck_legalname['prefix'] = strip_tags($item['prefix']);
      }
      if (!empty($item['first'])) {
        $cck_legalname['first'] = strip_tags($item['first']);
      }
      if (!empty($item['middle'])) {
        $cck_legalname['middle'] = strip_tags($item['middle']);
      }
      if (!empty($item['last'])) {
        $cck_legalname['last'] = strip_tags($item['last']);
      }
      if (!empty($item['suffix'])) {
        $cck_legalname['suffix'] = strip_tags($item['suffix']);
      }
      if (!empty($cck_legalname)) {
        $output .= t('Legal name: '). theme('cck_fullname', $cck_legalname, $field, TRUE);
      }
      if (!empty($item['prefix_preferred'])) {
        $cck_preferredname['prefix'] = strip_tags($item['prefix_preferred']);
      }
      if (!empty($item['first_preferred'])) {
        $cck_preferredname['first'] = strip_tags($item['first_preferred']);
      }
      if (!empty($item['middle_preferred'])) {
        $cck_preferredname['middle'] = strip_tags($item['middle_preferred']);
      }
      if (!empty($item['last_preferred'])) {
        $cck_preferredname['last'] = strip_tags($item['last_preferred']);
      }
      if (!empty($item['suffix_preferred'])) {
        $cck_preferredname['suffix'] = strip_tags($item['suffix_preferred']);
      }
      if (!empty($cck_preferredname)) {//if there is a preferred name, print it instead of the legal name (overwrite $output)
        $output = t('Preferred name: '). theme('cck_fullname', $cck_preferredname, $field, TRUE);
      }
      return $output;
  }
} // function cck_fullname_field_formatter()

/**
 * Theme for address display as called from cck_fullname_field_formatter().
 * 
 * @param array $cck_fullname
 * @param array $field
 * @param boolean $last_first TRUE if displayed last name first
 * @return string $output
 */
function theme_cck_fullname($cck_fullname, $field, $last_first = FALSE) {
  $output = '';
  //create the output
  if ($last_first) {
    if (isset($cck_fullname['last'])) {
      $output .= $cck_fullname['last'];
      if (strlen($cck_fullname['last']) == 1) $output .= '., ';
      else $output .= ', ';
    }
    if (isset($cck_fullname['prefix'])) {
      $output .= $cck_fullname['prefix'];
      if (strlen($cck_fullname['prefix']) < 4) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['first'])) {
      $output .= $cck_fullname['first'];
      if (strlen($cck_fullname['first']) == 1) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['middle'])) {
      $output .= $cck_fullname['middle'];
      if ($field['middle_initial'] == 1) $output .= '. ';
      else $output .= ', ';
    }
    if (isset($cck_fullname['suffix'])) {
      $output .= $cck_fullname['suffix'];
      if (strlen($cck_fullname['suffix']) < 4) $output .= '.';
    }
    $output .= '<br />';
  } 
  else {
    if (isset($cck_fullname['prefix'])) {
      $output .= $cck_fullname['prefix'];
      if (strlen($cck_fullname['prefix']) < 4) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['first'])) {
      $output .= $cck_fullname['first'];
      if (strlen($cck_fullname['first']) == 1) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['middle'])) {
      $output .= $cck_fullname['middle'];
      if ($field['middle_initial'] == 1) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['last'])) {
      $output .= $cck_fullname['last'];
      if (strlen($cck_fullname['last']) == 1) $output .= '. ';
      else $output .= ' ';
    }
    if (isset($cck_fullname['suffix'])) {
      $output .= $cck_fullname['suffix'];
      if (strlen($cck_fullname['suffix']) < 4) $output .= '.';
    }
    $output .= '<br />';
  }
  return $output;
} // function theme_cck_fullname()

/**
 * Implementation of hook_widget_info().
 * 
 * @return
 *   An array keyed by widget name. Each element of the array is an associative
 *   array with these keys and values:
 *   - "label": The human-readable label for the widget.
 *   - "field types": An array of field type names that can be edited using
 *     this widget.
 */
function cck_fullname_widget_info() {
  return array(
    'cck_fullname' => array(
      'label' => 'Full Name',
      'field types' => array('cck_fullname'),
    ),
  );
} // function cck_fullname_widget_info()

/**
 * Implementation of hook_widget_settings().
 * 
 * @param $op
 *   The operation to be performed.
 * @param $widget
 *   The widget on which the operation is to be performed.
 * @return
 *   This varies depending on the operation.
 *   - "form": an array of form elements to add to the settings page.
 *   - "validate": no return value. Use form_set_error().
 *   - "save": an array of names of form elements to be saved in the database.
 *   - "callbacks": an array describing the widget's behaviour regarding hook_widget 
 *     operations. The array is keyed by hook_widget operations ('form', 'validate'...)
 *     and has the following possible values : 
 *       CONTENT_CALLBACK_NONE     : do nothing for this operation 
 *       CONTENT_CALLBACK_CUSTOM   : use the behaviour in hook_widget(operation)
 *       CONTENT_CALLBACK_DEFAULT  : use content.module's default bahaviour
 *     Note : currently only the 'default value' operation implements this feature.
 *     All other widget operation implemented by the module _will_ be executed 
 *     no matter what.
 */
function cck_fullname_widget_settings($op, $widget) {
  switch ($op) {
    case 'callbacks':
      return array(
        'default value' => CONTENT_CALLBACK_CUSTOM,
      );
  }
} // function cck_fullname_widget_settings()

/**
 * Implementation of hook_widget().
 * 
 * Presently, we don't allow multiple values as people should only have one name.
 * Also, we intercept the default value fields and unset() them as I couldn't think
 * of a use case for pre-setting a person's name. We also use a little bit of CSS
 * to render the form fields approximately the 'size' they've been specified in 'ems'
 * as the 'size' was not being rendered in 'ems' but as some fraction thereof; this
 * because a name with mostly wide letters wasn't all fitting in the display. 
 * @param $op
 *   What kind of action is being performed.
 * @param &$node
 *   The node the action is being performed on.
 * @param $field
 *   The field the action is being performed on.
 * @param &$node_field
 *   The contents of the field in this node. Changes to this variable will
 *   be saved back to the node object.
 * @return
 *   This varies depending on the operation.
 *   - The "form" operation should return an array of form elements to display.
 *   - Other operations have no return value.
 */
function cck_fullname_widget($op, &$node, $field, &$items) {
  switch ($op) {
    case 'form':
      $form = array();
      $form[$field['field_name']] = array('#tree' => TRUE);
      $form[$field['field_name']]['#theme'] = 'cck_fullname_display';
        
      $form[$field['field_name']]['use_legalname'] = array(
        '#type' => 'value',
        '#value' => $field['use_legalname'],
      );
      $form[$field['field_name']]['use_preferredname'] = array(
        '#type' => 'value',
        '#value' => $field['use_preferredname'],
      );
      $form[$field['field_name']]['required_parts'] = array(
        '#type' => 'value',
        '#value' => $field['required_parts'],
      );
      $form[$field['field_name']]['legalname'] = array(
        '#type' => 'value',
        '#value' => $field['legalname'],
      );
      $form[$field['field_name']]['preferredname'] = array(
        '#type' => 'value',
        '#value' => $field['preferredname'],
      );
      
      $form[$field['field_name']]['#type'] = 'fieldset';
      $form[$field['field_name']]['#attributes'] = array('class' => 'cck-fullname-fieldset');
      $form[$field['field_name']]['#title'] = ucfirst(t($field['widget']['label']));
      $form[$field['field_name']]['#description'] = $field['widget']['description'];
      $form[$field['field_name']]['#weight'] = $field['widget']['weight'];
      if ($field['multiple']) {
        $delta = 0;
        foreach ($items as $data) {
          if (isset($field['legalname']['legal_prefix'])) {
            $form[$field['field_name']][$delta]['prefix'] = array(
              '#type' => 'textfield',
              '#default_value' => isset($data['prefix'])