duration.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset_attribute.inc';

class Asset_Attribute_Duration extends Asset_Attribute
{


    var $units = Array(
                    'days'      => 86400,
                    'hours'     => 3600,
                    'minutes'   => 60,
                    'seconds'   => 1,
                 );


    function Asset_Attribute_Duration($attributeid=0, $value=NULL)
    {
        $this->Asset_Attribute($attributeid, (int) $value);

        // Default display.
        $this->_edit_params['biggest_units'] = 86400;
        $this->_edit_params['smallest_units'] = 60;

    }//end constructor


    function setEditParams(&$node)
    {// TODO TOF TO TEST
        if (!parent::setEditParams($node)) return FALSE;
        $biggest    =  $this->units[(string)$node->attributes()->biggest_units];
        $smallest   = $this->units[(string)$node->attributes()->smallest_units];
        $this->_edit_params['biggest_units']    = max($biggest, $smallest);
        $this->_edit_params['smallest_units']   = min($biggest, $smallest);
        return TRUE;

    }//end setEditParams()


    function getUnitValues()
    {
        $unit_values = Array();
        $biggest_units  = array_get_index($this->_edit_params, 'biggest_units', $this->units['days']);
        $smallest_units = array_get_index($this->_edit_params, 'smallest_units', $this->units['minutes']);
        $remaining_value = $this->value;
        foreach ($this->units as $current_name => $current_units) {
            if ($current_units >= $smallest_units && $current_units <= $biggest_units) {
                $current_value = (int) ($remaining_value / $current_units);
                $unit_values[$current_name] = $current_value;
                $remaining_value -= $current_value * $current_units;
            }
        }
        return $unit_values;

    }//end getUnitValues()


    function paint($prefix, $read_only=FALSE)
    {
        $biggest_units  = array_get_index($this->_edit_params, 'biggest_units', $this->units['days']);
        $smallest_units = array_get_index($this->_edit_params, 'smallest_units', $this->units['minutes']);

        // moves smallest unit to the lowest unit above the smallest unit that has a value
        if ($read_only) {
            $all_values = array_reverse($this->getUnitValues(), TRUE);
            $set = FALSE;
            foreach ($all_values as $unit_name => $value) {
                if ($set) $smallest_units = $this->units[$unit_name];
                if ($this->units[$unit_name] == $smallest_units) {
                    if ($value == 0) {
                        $set = TRUE;
                    } else {
                        break;
                    }
                }
            }
        }
        require_once SQ_LIB_PATH.'/html_form/html_form.inc';
        $remaining_value = $this->value;
        $last_value = 0;
        $printed_any = FALSE;
        foreach ($this->units as $current_name => $current_units) {
            if ($current_units >= $smallest_units && $current_units <= $biggest_units) {
                $current_value = (int) ($remaining_value / $current_units);
                $remaining_value -= $current_value * $current_units;

                // modified below to only print duration units that have a value other than 0 when read-only is set
                if ($smallest_units != $biggest_units) {
                    if (!$read_only) {
                        if ($current_units == $smallest_units) {
                            echo ' and ';
                        } else if ($current_units != $biggest_units) {
                            echo ', ';
                        }
                    } else {
                        if ($current_value != 0) {
                            if ($current_units == $smallest_units && $printed_any) {
                                echo ' and ';
                            } else if ($current_units != $biggest_units && $printed_any) {
                                echo ', ';
                            }
                        }
                    }
                }
                if ($read_only) {
                    if ($current_value != 0) {
                        if ($current_value == 1) {
                            // If singular, strip the plural 's' off the name
                            $current_name = substr($current_name, 0, -1);
                        }
                        echo ' '.$current_value.' '.$current_name;
                        $printed_any = TRUE;
                    }
                } else {
                    text_box($prefix.'_'.$current_name, $current_value, 2, 0, FALSE, ' onkeypress="return checkDurationValue(this, event)" onblur="updateDurationValues(this)" style="width:4ex"');
                    echo '<label for="'.$prefix.'_'.$current_name.'"> '.$current_name.'</label>';
                    $printed_any = TRUE;
                }
            }//end if
        }//end foreach unit

    }//end paint()


    function process($prefix)
    {
        $biggest_units  = array_get_index($this->_edit_params, 'biggest_units', $this->units['days']);
        $smallest_units = array_get_index($this->_edit_params, 'smallest_units', $this->units['minutes']);

        if (!isset($_REQUEST[$prefix.'_'.array_search($biggest_units, $this->units)])) {
            return FALSE;
        }

        $res = 0;
        foreach ($this->units as $name => $number) {
            $res += array_get_index($_REQUEST, $prefix.'_'.$name, 0) * $number;
        }

        $value = (int) $res;
        if ($this->value != $value && $this->setValue($value)) {
            $this->processed = TRUE;
        } else {
            $this->processed = FALSE;
        }

    }//end process()


    function validateValue(&$value)
    {
        $value = trim($value);


        if ($value < 0) $value = $this->_default_value;

        $new_value = (int)$value;

        // we are comparing by string here, reason is that passing in a string as $value
        // becomes comparing $value with zero which is TRUE. So instead we would be comparing
        // it with a string '0', which is FALSE and what we want for it to invalidate.
        // Only genuine ints will pass through.
        if ((string)$new_value != $value) return FALSE;
        return TRUE;

    }//end validateValue()


    function exportContentsToXML()
    {
        $value_array = $this->getUnitValues();
        $value_xml = '';
        foreach ($value_array as $unit => $unit_value) {
            $value_xml .= '<'.$unit.'><![CDATA['.$unit_value.']]></'.$unit.'>';
        }
        $xml = '<value>'.$value_xml.'</value>';

        return $xml;

    }//end exportContentsToXML()


}//end class

?>