/models/PodioItemField.php

<?php
/**
 * @see https://developers.podio.com/doc/items
 */
class PodioItemField extends PodioObject {
  public function __construct($attributes = array(), $force_type = null) {
    $this->property('field_id', 'integer', array('id' => true));
    $this->property('type', 'string');
    $this->property('external_id', 'string');
    $this->property('label', 'string');
    $this->property('values', 'array');
    $this->property('config', 'hash');

    $this->init($attributes);

    $this->set_type_from_class_name();
  }

  /**
   * Saves the value of the field
   */
  public function save($options = array()) {
    if (!$this->__belongs_to) {
      throw new PodioMissingRelationshipError('{"error_description":"Field is missing relationship to item"}', null, null);
    }
    if (!$this->id) {
      throw new PodioDataIntegrityError('Field must have id set.');
    }
    $attributes = $this->as_json(false);
    return self::update($this->__belongs_to['instance']->id, $this->id, $attributes, $options);
  }

  /**
   * Adds a relationship to an item.
   */
  function add_relationship($item) {
    $this->__belongs_to = array('property' => 'fields', 'instance' => $item);
  }

  /**
   * Overwrites normal as_json to use api_friendly_values
   */
  public function as_json($encoded = true) {
    $result = $this->api_friendly_values();
    return $encoded ? json_encode($result) : $result;
  }

  /**
   * Set the value of the field
   */
  public function set_value($values) {
    if (!$values) {
      $this->values = array();
    }
    else {
      switch ($this->type) {
        case 'contact': // profile_id
        case 'app': // item_id
        case 'image': // file_id
        case 'video': // file_id
        case 'file': // file_id
        case 'question': // id
        case 'category': // id

          $list = array();
          $id_key = 'file_id';
          if (in_array($this->type, array('category', 'question'))) {
            $id_key = 'id';
          }
          elseif ($this->type == 'app') {
            $id_key = 'item_id';
          }
          elseif ($this->type == 'contact') {
            $id_key = 'profile_id';
          }

          // Ensure that we have an array of values
          if (!is_array($values) || (is_array($values) && !empty($values[$id_key]))) {
            $values = array($values);
          }

          $this->values = array_map(function($value) use ($id_key) {
            if (is_object($value)) {
              return array('value' => array($id_key => (int)$value->{$id_key}));
            }
            elseif (is_array($value)) {
              return array('value' => array($id_key => (int)$value[$id_key]));
            }
            else {
              return array('value' => array($id_key => (int)$value));
            }
          }, $values);
          break;
        // Single value fields with integer value
        case 'progress':
        case 'duration':
          $this->values = is_array($values) ? array(array('value' => (int)$values[0])) : array(array('value' => (int)$values));
          break;
        // Single value fields with string value
        case 'text':
        case 'number':
        case 'money':
        case 'state':
        case 'calculation':
        default:
          $this->values = is_array($values) ? array(array('value' => $values[0])) : array(array('value' => $values));
          break;
      }
    }
  }

  /**
   * Returns API friendly values for item field for use when saving item
   */
  public function api_friendly_values() {
    if (!$this->values) {
      return array();
    }
    switch ($this->type) {
      case 'contact': // profile_id
      case 'app': // item_id
      case 'question': // id
      case 'category': //id
      case 'image': // file_id
      case 'video': // file_id
      case 'file': // file_id
        $list = array();
        foreach ($this->values as $value) {
          if (!empty($value['value']['id'])) {
            $list[] = $value['value']['id'];
          }
          elseif (!empty($value['value']['file_id'])) {
            $list[] = $value['value']['file_id'];
          }
          elseif (!empty($value['value']['item_id'])) {
            $list[] = $value['value']['item_id'];
          }
          elseif (!empty($value['value']['profile_id'])) {
            $list[] = $value['value']['profile_id'];
          }
        }
        return $list;
        break;
      case 'embed':
        $list = array();
        foreach ($this->values as $value) {
          $list[] = array('embed' => $value['embed']['embed_id'], 'file' => (!empty($value['file']) ? $value['file']['file_id'] : null) );
        }
        return $list;
        break;
      case 'location':
        $list = array();
        foreach ($this->values as $value) {
          $list[] = $value['value'];
        }
        return $list;
        break;
      case 'date':
        return array('start' => $this->values[0]['start'], 'end' => $this->values[0]['end']);
        break;
      case 'text':
      case 'number':
      case 'money':
      case 'progress':
      case 'state':
      case 'duration':
      case 'calculation':
      default:
        return $this->values;
        break;
    }
  }

  /**
   * Displays a human-friendly value for the field
   */
  public function humanized_value() {
    return $this->values[0]['value'];
  }

  /**
   * @see https://developers.podio.com/doc/items/update-item-field-values-22367
   */
  public static function update($item_id, $field_id, $attributes = array(), $options = array()) {
    $url = Podio::url_for_post_with_options("/item/{$item_id}/value/{$field_id}", $options);
    return Podio::put($url, $attributes)->json_body();
  }

  /**
   * @see https://developers.podio.com/doc/calendar/get-item-field-calendar-as-ical-10195681
   */
  public static function ical($item_id, $field_id) {
    return Podio::get("/calendar/item/{$item_id}/field/{$field_id}/ics/")->body;
  }

  /**
   * @see https://developers.podio.com/doc/calendar/get-item-field-calendar-as-ical-10195681
   */
  public static function ical_field($item_id, $field_id) {
    return Podio::get("/calendar/item/{$item_id}/field/{$field_id}/ics/")->body;
  }

  public function set_type_from_class_name() {
    switch (get_class($this)) {
      case 'PodioTextItemField':
        $this->type = 'text';
        break;
      case 'PodioEmbedItemField':
        $this->type = 'embed';
        break;
      case 'PodioLocationItemField':
        $this->type = 'location';
        break;
      case 'PodioDateItemField':
        $this->type = 'date';
        break;
      case 'PodioContactItemField':
        $this->type = 'contact';
        break;
      case 'PodioAppItemField':
        $this->type = 'app';
        break;
      case 'PodioQuestionItemField':
        $this->type = 'question';
        break;
      case 'PodioCategoryItemField':
        $this->type = 'category';
        break;
      case 'PodioImageItemField':
        $this->type = 'image';
        break;
      case 'PodioVideoItemField':
        $this->type = 'video';
        break;
      case 'PodioFileItemField':
        $this->type = 'file';
        break;
      case 'PodioNumberItemField':
        $this->type = 'number';
        break;
      case 'PodioProgressItemField':
        $this->type = 'progress';
        break;
      case 'PodioStateItemField':
        $this->type = 'state';
        break;
      case 'PodioDurationItemField':
        $this->type = 'duration';
        break;
      case 'PodioCalculationItemField':
        $this->type = 'calculation';
        break;
      case 'PodioMoneyItemField':
        $this->type = 'money';
        break;
      default:
        break;
    }
  }

}

class PodioTextItemField extends PodioItemField {
  public function humanized_value() {
    return strip_tags($this->values[0]['value']);
  }
}
class PodioEmbedItemField extends PodioItemField {
  /**
   * Provides a list list of PodioEmbed and PodioFile objects for the field.
   * This read-only. Changing the values of the PodioItem objects
   * will not update the values of the PodioItemField.
   */
  public function embeds() {
    $list = array();
    foreach ($this->values as $delta => $value) {
      $list[] = array('delta' => $delta, 'embed' => new PodioEmbed($value['embed']), 'file' => ($value['file'] ? new PodioFile($value['file']) : null));
    }
    return $list;
  }

  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['embed']['original_url'];
    }, $this->values));
  }

  public function set_value($values) {
    $this->values = array();
    if ($values) {
      // Ensure that we have an array of values
      if (is_object($values) || (is_array($values) && !empty($values['embed']))) {
        $values = array($values);
      }

      $this->values = array_map(function($value) {
        if (is_object($value)) {
          return array('embed' => array('embed_id' => $value->id), 'file' => array('file_id' => $value->files ? $value->files[0]->id : null));
        }
        return $value;
      }, $values);
    }
  }

}
class PodioLocationItemField extends PodioItemField {

  public function set_value($values) {
    $this->values = array();
    if ($values) {
      if (is_array($values)) {
        $formatted_values = array_map(function($value){
          return array('value' => $value);
        }, $values);
        $this->values = $formatted_values;
      }
      else {
        $this->values = array(array('value' => $values));
      }
    }
  }

  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value'];
    }, $this->values));
  }
}
class PodioDateItemField extends PodioItemField {

  public function __construct($attributes = array()) {
    parent::__construct($attributes, 'date');
  }

  public function set_value($values) {
    $this->values = array();
    if ($values) {
      $this->values = array($values);
    }
  }

  public function humanized_value() {
    $value = $this->values[0];
    // Remove seconds from start and end times since they are always '00' anyway.
    if (!empty($value['start_time'])) {
      $value['start_time'] = substr($value['start_time'], 0, strrpos($value['start_time'], ':'));
    }
    if (!empty($value['end_time'])) {
      $value['end_time'] = substr($value['end_time'], 0, strrpos($value['end_time'], ':'));
    }
    // Variants:

    // Same date
    // 2012-12-12
    // 2012-12-12 14:00
    // 2012-12-12 14:00 - 15:00

    // Different dates
    // 2012-12-12 - 2012-12-14
    // 2012-12-12 14:00 - 2012-12-14
    // 2012-12-12 14:00 - 2012-12-12 15:00

    if (empty($value['end_date']) || $value['start_date'] == $value['end_date']) {
      if (!empty($value['start_time']) && !empty($value['end_time']) && $value['start_time'] != $value['end_time']) {
        return "{$value['start_date']} {$value['start_time']}-{$value['end_time']}";
      }
      elseif (!empty($value['start_time']) && (empty($value['end_time']) || $value['start_time'] == $value['end_time'])) {
        return "{$value['start_date']} {$value['start_time']}";
      }
      else {
        return "{$value['start_date']}";
      }
    }
    else {
      if (!empty($value['start_time']) && !empty($value['end_time']) && $value['end_time'] != '00:00') {
        return "{$value['start_date']} {$value['start_time']} - {$value['end_date']} {$value['end_time']}";
      }
      elseif (!empty($value['end_time']) || $value['end_time'] == '00:00') {
        return "{$value['start_date']} {$value['start_time']} - {$value['end_date']}";
      }
      else {
        return "{$value['start_date']} - {$value['end_date']}";
      }
    }
  }

  // TODO: Set start and end date and times easily
}
class PodioContactItemField extends PodioItemField {
  /**
   * Provides a list a PodioContact objects for the PodioItemField
   * This read-only. Changing the values of the PodioContact objects
   * will not update the values of the PodioItemField.
   */
  public function contacts() {
    return array_map(function($value){
      return new PodioFile($value['value']);
    }, $this->values);
  }

  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['name'];
    }, $this->values));
  }
}
class PodioAppItemField extends PodioItemField {
  /**
   * Provides a list a PodioItem objects for the PodioItemField
   * This read-only. Changing the values of the PodioItem objects
   * will not update the values of the PodioItemField.
   */
  public function items() {
    return array_map(function($value){
      return new PodioItem($value['value']);
    }, $this->values);
  }

  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['title'];
    }, $this->values));
  }
}
class PodioQuestionItemField extends PodioItemField {
  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['text'];
    }, $this->values));
  }
}
class PodioCategoryItemField extends PodioItemField {
  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['text'];
    }, $this->values));
  }
}
class PodioAssetItemField extends PodioItemField {
  /**
   * Provides a list a PodioFile objects for the PodioItemField
   * This read-only. Changing the values of the PodioFile objects
   * will not update the values of the PodioItemField.
   */
  public function files() {
    return array_map(function($value){
      return new PodioContact($value['value']);
    }, $this->values);
  }
}
class PodioImageItemField extends PodioAssetItemField {
  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['name'];
    }, $this->values));
  }
}
class PodioVideoItemField extends PodioAssetItemField {
  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['name'];
    }, $this->values));
  }
}
class PodioFileItemField extends PodioAssetItemField {
  public function humanized_value() {
    return join('; ', array_map(function($value){
      return $value['value']['name'];
    }, $this->values));
  }
}
class PodioNumberItemField extends PodioItemField {
  public function humanized_value() {
    return rtrim(rtrim(number_format($this->values[0]['value'], 4, '.', ''), '0'), '.');
  }
}
class PodioProgressItemField extends PodioItemField {
  public function humanized_value() {
    return $this->values[0]['value'].'%';
  }
}
class PodioStateItemField extends PodioItemField {}
class PodioDurationItemField extends PodioItemField {
  /**
   * Duration in seconds
   */
  public function duration() {
    return $this->values[0]['value'];
  }
  /**
   * Hours of the duration
   */
  public function hours() {
    return floor($this->values[0]['value']/3600);
  }
  /**
   * Minutes of the duration
   */
  public function minutes() {
    return (($this->values[0]['value']/60)%60);
  }
  /**
   * Seconds of the duration
   */
  public function seconds() {
    return ($this->values[0]['value']%60);
  }
}
class PodioCalculationItemField extends PodioItemField {
  public function humanized_value() {
    return rtrim(rtrim(number_format($this->values[0]['value'], 4, '.', ''), '0'), '.');
  }
}
class PodioMoneyItemField extends PodioItemField {
  /**
   * Currency part of the value
   */
  public function currency() {
    if (!empty($this->values)) {
      return $this->values[0]['currency'];
    }
  }
  /**
   * Set the currency value.
   */
  public function set_currency($currency) {
    $value = $this->values[0]['value'] ? $this->values[0]['value'] : 0;
    $this->set_attribute('values', array(array('currency' => $currency, 'value' => $value)));
  }
  /**
   * Amount part of the value
   */
  public function amount() {
    if (!empty($this->values)) {
      return $this->values[0]['value'];
    }
  }
  /**
   * Set the amount.
   */
  public function set_amount($amount) {
    $currency = $this->values[0]['currency'] ? $this->values[0]['currency'] : '';
    $this->set_attribute('values', array(array('currency' => $currency, 'value' => $amount)));
  }

  public function humanized_value() {
    $amount = number_format($this->values[0]['value'], 2, '.', '');
    switch ($this->values[0]['currency']) {
      case 'USD':
        $currency = '$';
      case 'EUR':
        $currency = '€';
        break;
      case 'GBP':
        $currency = 'ÂŁ';
        break;
      default:
        $currency = $this->values[0]['currency'].' ';
        break;
    }
    return $currency.$amount;
  }
}