soap_api.inc

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

class SOAP_Api extends Asset
{

    public static $string_non_optional      = Array (
                                                'type'      => 'string',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $string_optional          = Array (
                                                'type'      => 'string',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $string_optional_unbounded= Array (
                                                'type'      => 'string',
                                                'min'       => 0,
                                                'max'       => 'unbounded',
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $boolean_non_optional     = Array (
                                                'type'      => 'boolean',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $boolean_optional         = Array (
                                                'type'      => 'boolean',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $int_non_optional         = Array (
                                                'type'      => 'int',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    public static $int_optional             = Array (
                                                'type'      => 'int',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              );
    private $simple_types   = NULL;

    function __construct($assetid=0)
    {
        $this->_ser_attrs = TRUE;
        parent::__construct($assetid);

    }//end constructor


    protected function _preCreateCheck(Array &$link)
    {
        if (!parent::_preCreateCheck($link)) return FALSE;

        // if the short name hasn't been set then short and long names are the same to begin with
        $name = trim($this->attr('name'));
        if (trim($this->attr('short_name')) == '') {
            $this->setAttrValue('short_name', $name);
        }//end if

        return TRUE;

    }//end _preCreateCheck()


    protected function _getName($short_name=FALSE, $contextid=NULL)
    {
        // No context specified, using the current context
        if ($contextid === NULL) {
            $contextid = $GLOBALS['SQ_SYSTEM']->getContextId();
        }//end if

        // Obtain the attribute value for Name from the specified Context
        $attr = ($short_name) ? 'short_name' : 'name';
        $values = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName($attr, $this->type(), Array($this->id), $contextid);
        if (empty($values) === TRUE) {
            return parent::_getName($short_name, $contextid);
        } else {
            return $values[$this->id];
        }

    }//end _getName()


    public function getFunctionList()
    {
        return Array();

    }//end getFunctionList()


    public static function getArgType($type, $min=0, $max=1, $nillable=FALSE, $mixed=FALSE)
    {
        $arg_type   = Array (
                        'type'      => $type,
                        'min'       => $min,
                        'max'       => $max,
                        'nillable'  => $nillable,
                        'mixed'     => $mixed,
                      );
        return $arg_type;

    }//end getArgType()


    public static function getComplexElements($complex_elements=Array())
    {
        $complex_elements_available = Array();
        if (empty($func_list)) {
            // So sick, this is dodgy, it wouldnt hurt performance though.
            $func_list = $complex_elements;
        }//end if
            foreach ($func_list as $func_name => $switch) {
                if (isset($complex_elements[$func_name])) {
                    if ($switch) {
                        $complex_elements_available = array_merge($complex_elements_available, $complex_elements[$func_name]);
                    }//end if
                }//end if
            }//end foreach

        return $complex_elements_available;

    }//end getComplexElements()


    public static function processSimpleRestrictedTypes($simple_types=Array())
    {
        $simple_types_available = Array();
        if (empty($func_list)) {
            // So sick, this is dodgy, it wouldnt hurt performance though.
            $func_list = $simple_types;
        }//end if
            foreach ($func_list as $func_name => $switch) {
                if (isset($simple_types[$func_name])) {
                    if ($switch) {
                        $simple_types_available = array_merge($simple_types_available, $simple_types[$func_name]);
                    }//end if
                }//end if
            }//end foreach
        return $simple_types_available;

    }//end getSimpleRestrictedTypes()


    public static function getSimpleRestrictedTypes($simple_types=Array())
    {
        return Array();

    }//end getSimpleRestrictedTypes()

    public static function getComplexTypes($func_list=Array())
    {
        return Array();

    }//end getComplexTypes()


    public static function getBooleanIndex($array, $index, $default_val)
    {
        $val    = array_get_index($array, $index, $default_val);
        if (empty($val)) {
            $val    = FALSE;
        } else if ($val == 1) {
            $val    = TRUE;
        }//end else

        return $val;

    }//end getBooleanIndex()


    public static function getNullIndex($array, $index, $default_val)
    {
        $val    = array_get_index($array, $index, $default_val);
        if (empty($val)) {
            $val    = NULL;
        }//end if
        return $val;

    }//end getNullIndex()


    public function array_get_index_restricted_value($array, $index, $default_val)
    {
        $val    = array_get_index($array, $index, $default_val);
        if (empty($this->simple_types)) {
            $this->simple_types = $this->getSimpleRestrictedTypes();
        }//end if

        if (!empty($this->simple_types) && isset($this->simple_types[$index])) {
            if (!in_array($val, $this->simple_types[$index]['enumeration'])) {
                throw new SoapFault('Server', 'The input value is not a valid value for '.$index.'. Valid values include: '.implode(', ', $this->simple_types[$index]['enumeration']));
            }//end if
        }//end if
        return $val;

    }//end array_get_index_restricted_value()

    
    public function updateLookupsforAsset($assetid)
    {
        require_once SQ_SYSTEM_ROOT.'/core/hipo/jobs/hipo_job_update_lookups.inc';
        $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();

        $vars = Array('assetids' => Array($assetid));
        $hh->freestyleHipo('hipo_job_update_lookups', $vars);

    }//end updateLookupsforAsset()
    
}//end class
?>