topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

#mobile-ar-8-7.txt / txt


  <?php
  // Based on the Layar tutorial sample by Xuan Wang
  // Layar www.layar.com
  
  // Convert a decimal GPS latitude or longitude value to an integer by multiplying by 1000000.
  // 
  // Arguments:
  //   value_Dec ; The decimal latitude or longitude GPS value.
  //
  // Returns:
  //   int ; The integer value of the latitude or longitude.
  //
  function ChangetoIntLoc( value_Dec ) {
  
    return value_Dec * 1000000;
    
  }//ChangetoIntLoc
  
  // Change a string value to integer. 
  //
  // Arguments:
  //   string ; A string value.
  // 
  // Returns:
  //   Int ; If the string is empty, return NULL.
  //
  function ChangetoInt( string ) {
  
    if ( strlen( trim( string ) ) != 0 ) {
    
      return (int)string;
    }
    else 
            return NULL;
  }//ChangetoInt
  
  // Change a string value to float
  //
  // Arguments:
  //   string ; A string value.
  // 
  // Returns:
  //   float ; If the string is empty, return NULL.
  //
  function ChangetoFloat( string ) {
  
    if ( strlen( trim( string ) ) != 0 ) {
    
      return (float)string;
    }
    else 
            return NULL;
  }//ChangetoFloat
  
  //Convert a TinyInt value to a boolean value TRUE or FALSE
  //
  // Arguments: 
  //   value_Tinyint ; The Tinyint value (0 or 1) of a key in the database. 
  //
  // Returns:
  //         value_Bool ; The boolean value, return 'TRUE' when Tinyint is 1. Return 'FALSE' when Tinyint is 0.
  //
  function ChangetoBool( value_Tinyint ) {
  
    if ( strlen( trim( value_Tinyint ) ) != 0 ) {
    
      if ( value_Tinyint == 1 )
              value_Bool = TRUE;
            else 
              value_Bool = FALSE;
     
            return value_Bool;
    }
    else 
            return NULL;
    
  }//ChangetoBool
  
  // Prepare the search value which will be used in SQL statement. 
  // Arguments: 
  //   searchbox ; the value of SEARCHBOX parameter in the GetPOI request.
  //
  // Returns:
  //   searchbox_value ; If searchbox parameter has an empty string, return a string which is 
  //                     a combination of numbers, letters and white spaces. 
  //                     Otherwise, return the value of searchbox parameter. 
  
  function GetSearchValue ( searchbox ) {
          
          // if searchbox exists, prepare search value. 
          if ( isset(searchbox) ) {
          
            // initiate searchbox value to be any string that consists of numbers, letters and spaces. 
            searchbox_value = '[0-9a-zA-Z\s]*';
            
            // if searchbox is not an empty string, return the searchbox value. 
            if (!empty(searchbox))
                  searchbox_value = searchbox;
                  
                  return searchbox_value;
          } //if
          else { // If searchbox does not exist, throw an exception. 
                  throw new Exception("searchbox parameter is not passed in GetPOI request.");
          }//else
  
  }// GetSearchValue
  
  // Prepare radiolist value which will be used in SQL statement. In this function, we convert
  // the returned value into the ones that are stored in the database. 
  //
  // Arguments:
  // radiolist ; the integer value of RADIOLIST parameter in the GetPOI request.
  //
  // Returns:
  // radio_value ; the value that can be used to construct the right SQL statement. 
  function GetRadioValue (radiolist) {
    // if radiolist exists, prepare radio_value.         
    if( isset( radiolist ) ) {
          
      radio_value;
          // if radiolist == 1, return radio_value ="sale"; 
          // if radiolist == 2, return radio_value ="rent";
          switch (radiolist) {
            case '1':
                  radio_value = "sale" ;
                  break;
            case '2': 
                  radio_value = "rent" ;
                  break;                
            default:
                  throw new Exception( "invalid radiolist value:".radiolist );
            } //switch
          
           return radio_value;
          }//if
          else {
            throw new Exception("radiolist parameter is not passed in GetPOI request.");
          }//else
          
  }// GetRadioValue
  
  // Prepare checkbox value which will be used in SQL statement. 
  // In this function, we add all the numbers in checkboxlist parameter. If checkboxlist is empty, 
  // then we return 0.
  //
  // Arguments:
  // checkboxlist ; the value of CHECKBOXLIST parameter in the GetPOI request.
  //
  // Returns:
  // checkbox_value ; the value that can be used to construct the right SQL statement. 
  
  function GetCheckboxValue ( checkboxlist ) {
  
    // if checkboxlist exists, prepare checkbox_value.         
    if( isset( checkboxlist ) ) {
    
      // Initialize returned value to be 0 if checkboxlist is empty. 
          checkbox_value = 0;
          
          // If checkboxlist is not empty, return the added value of all the numbers splited by ','.
          if (!empty(checkboxlist)) {
          
                  if ( strstr(checkboxlist,',') ) {
                  
                          checkbox_array = explode(',', checkboxlist);
                          
                          for( i=0; i<count(checkbox_array); i++ )
                                  checkbox_value+=checkbox_array[i]; 
                                  
                  }//if
                  else 
                          checkbox_value = checkboxlist;
          }//if
          
          return checkbox_value;
    } //if
    else {
      throw new Exception("checkboxlist parameter is not passed in GetPOI request.");
    }//else
  
  }//GetCheckboxValue
  
  // Prepare custom_slider value which will be used in SQL statement. 
  // In this function, we simply return the value of customslider defined in the GetPOI request. 
  //
  // Arguments:
  // customslider ; the value of CUSTOM_SLIDER parameter in the GetPOI request.
  //
  // Returns:
  // customslider ; the value that can be used to construct the right SQL statement. 
  //
  function GetSliderValue ( customslider ) {
      
      // if customslider exists, return its value. 
          if( isset( customslider ) )
          
            return customslider;
            
          else 
            throw new Exception("custom slider parameter is not passed in GetPOI request.");
          
  }//GetSliderValue
  
  // Put received POIs into an associative array. The returned values are assigned to reponse["hotspots"].
  //
  // Arguments:
  //   db ; The handler of the database.
  //   value ; An array which contains all the needed parameters retrieved from GetPOI request.  
  //
  // Returns:
  //   array ; An array of received POIs.
  //
  function Gethotspots( db, value ) {
  
  try {
  /* Create the SQL query to retrieve POIs which meet the criterion of filter settings returned from GetPOI request. 
     Returned POIs are sorted by distance and the first 50 POIs are selected. 
     - The distance is caculated based on the Haversine formula. 
       Note: this way of calculation is not scalable for querying large database.
     - searchbox filter, find POIs with title that contains the search term. 
       If the searchbox is empty, all POIs are returned. 
     - radiolist filter, find POIs with value from "Radiolist" column that equals to the prepared
       radiolist value from GetRadioValue function. 
     - checkbox filter, find POIs which don't return 0 after comparing the value from "Checkbox" column
       and prepared checkbox value (from GetCheckboxValue function) using Bitwise operations. 
       http://en.wikipedia.org/wiki/Bitwise_operation. if CHECKBOX parameter is empty, then no POIs are returned. 
     - custom_slider filter, find POIs with value from "Custom_Slider" column that is not bigger than
       the CUSTOM_SLIDER parameter value passed in the GetPOI request. 
  */
          
    // Use PDO::prepare() to prepare SQL statement. 
    // This statement is used due to security reasons and will help prevent general SQL injection attacks.
    // ":lat1", ":lat2", ":long", ":radius" and the custom filter settings are named parameter markers for which real values 
    // will be substituted when the statement is executed. 
    // sql is returned as a PDO statement object. 
    sql = db->prepare( "
                            SELECT id,
                                   attribution, 
                                   title, 
                                   lat,
                                   lon,
                                   imageURL,
                                   line4, 
                                   line3,
                                   line2,
                                   type,
                                   dimension,
                                   (((acos(sin((:lat1 * pi() / 180)) * sin((lat * pi() / 180)) +
                               cos((:lat2 * pi() / 180)) * cos((lat * pi() / 180)) * 
                         cos((:long  - lon) * pi() / 180))
                        ) * 180 / pi()) * 60 * 1.1515 * 1.609344 * 1000) as distance
                      FROM POI_RealEstate_Table
                      WHERE title REGEXP :search 
                        AND Radiolist = :radiolist 
                        AND ( Checkbox & :checkbox )!=0 
                        AND Custom_Slider <= :slider
                      HAVING distance < :radius
                      ORDER BY distance ASC
                      LIMIT 0, 50 " );
  
    // PDOStatement::bindParam() binds the named parameter markers to the specified parameter values. 
    sql->bindParam( ':lat1', value['lat'], PDO::PARAM_STR );
    sql->bindParam( ':lat2', value['lat'], PDO::PARAM_STR );
    sql->bindParam( ':long', value['lon'], PDO::PARAM_STR );
    sql->bindParam( ':radius', value['radius'], PDO::PARAM_INT );
    
    // Custom filter settings parameters. The four Get functions can be customized. 
    sql->bindParam( ':search', GetSearchValue ( value['SEARCHBOX'] ), PDO::PARAM_STR );
    sql->bindParam( ':radiolist', GetRadioValue ( value['RADIOLIST'] ), PDO::PARAM_STR );
    sql->bindParam( ':checkbox', GetCheckboxValue ( value['CHECKBOXLIST'] ), PDO::PARAM_INT );
    sql->bindParam( ':slider', GetSliderValue ( value['CUSTOM_SLIDER'] ), PDO::PARAM_INT );
  
          
    // Use PDO::execute() to execute the prepared statement sql. 
    sql->execute();
          
    // Iterator for the response array.
    i = 0; 
    
    // Use fetchAll to return an array containing all of the remaining rows in the result set.
    // Use PDO::FETCH_ASSOC to fetch sql query results and return each row as an array indexed by column name.
    pois = sql->fetchAll(PDO::FETCH_ASSOC);
   
    /* Process the pois result */
    
    // if pois array is empty, return empty array. 
    if ( empty(pois) ) {
            
            response["hotspots"] = array ();
          
    }//if 
    else { 
            
            // Put each POI information into response["hotspots"] array.
           foreach ( pois as poi ) {
                  
                  // Use function Getactions() to return an array of actions asscociated with the current POI.
          poi["actions"] = Getactions ( poi, db );
          
         // If POI "dimension" =2 or 3, use function Getobject() to return an object associated with the current POI. 
                if (poi["dimension"] == '2' || poi["dimension"] == '3')
                        poi["object"] = Getobject ( poi, db); 
        
        // If POI "dimension" =2 or 3, use function Gettransform() to return a transform dictionary associated with the current POI. 
                if (poi["dimension"] == '2' || poi["dimension"] == '3')
                        poi["transform"] = Gettransform ( poi, db);
        
              // Store the integer value of "lat" and "lon" using predefined function ChangetoIntLoc.
              poi["lat"] = ChangetoIntLoc( poi["lat"] );
              poi["lon"] = ChangetoIntLoc( poi["lon"] );
      
                      // Change to Int with function ChangetoInt.
              poi["type"] = ChangetoInt( poi["type"] );
              poi["dimension"] = ChangetoInt( poi["dimension"] );
      
              // Change to demical value with function ChangetoFloat
              poi["distance"] = ChangetoFloat( poi["distance"] );
          
              // Put the poi into the response array.
              response["hotspots"][i] = poi;
              i++;
            }//foreach
    
    }//else
    return response["hotspots"];
  }//try
  
  //catch exception
  catch(Exception e)
  {
    echo 'Message: ' .e->getMessage();
  }
  
  }//Gethotspots
  
  // Put fetched actions for each POI into an associative array. The returned values are assigned to poi[actions].
  //
  // Arguments:
  //   poi ; The POI handler.
  //   db ; The database connection handler. 
  //
  // Returns:
  //   array ; An array of received actions for this POI.
  // 
  function Getactions( poi, db ) {
    
    // A new table called "ACTION_Table" is created to store actions, each action has a field called
    // "poiID" which shows the POI id that this action belongs to. 
    // The SQL statement returns actions which have the same poiID as the id of poi (poi['id']).
    sql_actions = db->prepare( " SELECT label, 
                                                                                    uri, 
                                                                                    autoTriggerRange,
                                                                                    autoTriggerOnly,
                                                                                    contentType,
                                                                                    method,
                                                                                    activityType,
                                                                                    params,
                                                                                    closeBiw,
                                                                                    showActivity,
                                                                                    activityMessage
                                                                  FROM ACTION_Table
                                                           WHERE poiID = :id " ); 
                                                           
    // Binds the named parameter markers ":id" to the specified parameter values "poi['id']".                                                           
    sql_actions->bindParam( ':id', poi['id'], PDO::PARAM_INT );
      
    // Use PDO::execute() to execute the prepared statement sql_actions. 
    sql_actions->execute();
    
    // Iterator for the poi["actions"] array.
    count = 0; 
      
    // Fetch all the poi actions. 
    actions = sql_actions->fetchAll( PDO::FETCH_ASSOC );
    
    /* Process the actions result */
    
    // if actions array is empty, return empty array. 
    if ( empty( actions ) ) {
    
            poi["actions"] = array();
            
    }//if 
    else {
            
            // Put each action information into poi["actions"] array.
            foreach ( actions as action ) {
              
              // Assign each action to poi["actions"] array. 
              poi["actions"][count] = action;
        
        // put 'params' into an array of strings
        paramsArray = array();
        if (substr_count(action['params'],',')) {
                paramsArray = explode(",", action['params']);
        }//if
        else if(strlen(action['params'])) {
                paramsArray[0] = action['params'];
        } 
        poi["actions"][count]['params'] = paramsArray;
        
        // Change 'activityType' to Integer.
        poi["actions"][count]['activityType'] = ChangetoInt( poi["actions"][count]['activityType'] );
        
        // Change the values of "closeBiw" into boolean value.
        poi["actions"][count]['closeBiw'] = ChangetoBool( poi["actions"][count]['closeBiw'] );
        
        // Change the values of "showActivity" into boolean value.
        poi["actions"][count]['showActivity'] = ChangetoBool( poi["actions"][count]['showActivity'] ); 
        
        // Change 'autoTriggerRange' to Integer.
        poi["actions"][count]['autoTriggerRange'] = ChangetoInt( poi["actions"][count]['autoTriggerRange'] );
        
            // Change the values of "autoTriggerOnly" into boolean value,if the value is NULL, return NULL.
            poi["actions"][count]['autoTriggerOnly'] = ChangetoBool( poi["actions"][count]['autoTriggerOnly'] );
            
        count++; 
              
      }// foreach
     
     }//else
     
     return poi["actions"];
  
  }//Getactions
  
  // Put fetched object related parameters for each POI into an associative array. The returned values are assigned to poi[object].
  //
  // Arguments:
  //   poi ; The POI handler.
  //   db ; The database connection handler. 
  //
  // Returns:
  //   array ; An array of received object related parameters for this POI.
  // 
  function Getobject( poi, db ) {
    
    // A new table called "OBJECT_Table" is created to store object related parameters, namely "baseURL", "full", "reduced", "icon" and "size". 
    // "poiID" which shows the POI id that this object belongs to. 
    // The SQL statement returns object which has the same poiID as the id of poi (poi['id']).
    sql_object = db->prepare( " SELECT baseURL, full, reduced, icon, size 
                                                                  FROM OBJECT_Table
                                                           WHERE poiID = :id 
                                                           LIMIT 0,1 " ); 
                                                           
    // Binds the named parameter markers ":id" to the specified parameter values "poi['id']".                                                           
    sql_object->bindParam( ':id', poi['id'], PDO::PARAM_INT );
      
    // Use PDO::execute() to execute the prepared statement sql_object. 
    sql_object->execute();
      
    // Fetch the poi object. 
    object = sql_object->fetchAll( PDO::FETCH_ASSOC );
    
    /* Process the object result */
    
    // if object array is empty, return NULL. 
    if ( empty( object ) ) {
    
            poi["object"] = null;
            
    }//if 
    else {
            // Since each POI only has one object. Logically, only one object should be returned. Assign the first object in the array to poi["object"]
      poi["object"] = object[0];
      
      // Change "size" type to float. 
      poi["object"]["size"] = ChangetoFloat( poi["object"]["size"] );
      
     }//else
     
     return poi["object"];
  
  }//Getobject
  
  // Put fetched transform related parameters for each POI into an associative array. The returned values are assigned to poi[transform].
  //
  // Arguments:
  //   poi ; The POI handler.
  //   db ; The database connection handler. 
  //
  // Returns:
  //   array ; An array of received transform related parameters for this POI.
  // 
  function Gettransform( poi, db ) {
    
    // A new table called "TRANSFORM_Table" is created to store transform related parameters, namely "rel", "angle" and "scale"
    // "poiID" which shows the POI id that this transform belongs to. 
    // The SQL statement returns transform which has the same poiID as the id of poi (poi['id']).
    sql_transform = db->prepare( " SELECT rel, angle, scale
                                                                  FROM TRANSFORM_Table
                                                           WHERE poiID = :id 
                                                           LIMIT 0,1 " ); 
                                                           
    // Binds the named parameter markers ":id" to the specified parameter values "poi['id']".                                                           
    sql_transform->bindParam( ':id', poi['id'], PDO::PARAM_INT );
      
    // Use PDO::execute() to execute the prepared statement sql_transform. 
    sql_transform->execute();
      
    // Fetch the poi transform. 
    transform = sql_transform->fetchAll( PDO::FETCH_ASSOC );
    
    /* Process the transform result */
    
    // if transform array is empty, return NULL. 
    if ( empty( transform ) ) {
    
            poi["transform"] = null;
            
    }//if 
    else {
            // Since each POI only has one transform. Logically, only one transform should be returned. Assign the first transform in the array to poi["transform"]
      poi["transform"] = transform[0];
      
      // Change the value of "rel" into boolean value,if the value is NULL, return NULL.
      poi["transform"]["rel"] = ChangetoBool( poi["transform"]["rel"] );
      
      // Change the values of "angle" and "scale" to demical.
      poi["transform"]["angle"] = ChangetoFloat( poi["transform"]["angle"] );
      poi["transform"]["scale"] = ChangetoFloat( poi["transform"]["scale"] );
    }//else
    
     return poi["transform"];
  
  }//Gettransform

* Main entry point **


  
  
  /* Pre-define connection to the MySQL database, please specify these fields.*/
  dbhost = 'db_hostname';
  dbdata = 'db_databasename';
  dbuser = 'db_username';
  dbpass = 'db_password';
  
  /* Put parameters from GetPOI request into an associative array named value */
  
  // Put needed parameter names from GetPOI request in an array called keys. 
  keys = array( "layerName", "lat", "lon", "radius",
                             "RADIOLIST", "CHECKBOXLIST", 
                             "CUSTOM_SLIDER", "SEARCHBOX");
  
  // Initialize an empty associative array.
  value = array(); 
  
  try {
    // Retrieve parameter values using _GET and put them in value array with parameter name as key. 
    foreach( keys as key ) {
      if ( isset(_GET[key]) )
        value[key] = _GET[key]; 
      else 
        throw new Exception(key ." parameter is not passed in GetPOI request.");
    }
  }
  catch(Exception e) {
    echo 'Message: ' .e->getMessage();
  }
   
   
  try {
          /* Connect to MySQL server. We use PDO which is a PHP extension to formalise database connection.
             For more information regarding PDO, please see http://php.net/manual/en/book.pdo.php. 
  	*/
          
          // Connect to predefined MySQl database.  
          db = new PDO( "mysql:host=dbhost; dbname=dbdata", dbuser, dbpass, array(PDO::MYSQL_ATTR_INIT_COMMAND =>  "SET NAMES utf8") );
          
          // set the error reporting attribute to Exception.
          db->setAttribute( PDO::ATTR_ERRMODE , PDO::ERRMODE_EXCEPTION );
          
          /* Construct the response into an associative array.*/
          
          // Create an empty array named response.
          response = array();
          
          // Assign cooresponding values to mandatory JSON response keys.
          response["layer"] = value["layerName"];
          
          // Use Gethotspots() function to retrieve POIs with in the search range.  
          response["hotspots"] = Gethotspots( db, value );
  
          // if there is no POI found, return a custom error message.
          if ( empty( response["hotspots"] ) ) {
                  response["errorCode"] = 20;
                   response["errorString"] = "No POI found. Please adjust the range.";
          }//if
          else {
                    response["errorCode"] = 0;
                    response["errorString"] = "ok";
          }//else
  
          /* All data is in response, print it into JSON format.*/
          
          // Put the JSON representation of response into jsonresponse.
          jsonresponse = json_encode( response );
          
          // Declare the correct content type in HTTP response header.
          header( "Content-type: application/json; charset=utf-8" );
          
          // Print out Json response.
          echo jsonresponse;
  
          /* Close the MySQL connection.*/
          
          // Set db to NULL to close the database connection.
          db=null;
  }
  catch( PDOException e )
      {
      echo e->getMessage();
      }
  
  ?>

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.