Changeset 158 for Dev/trunk

Timestamp:

11/18/11 11:07:07 (13 years ago)

Author:

jkraaijeveld

Message:

Refactored queries / cleaned up some code.

Location:

Dev/trunk/classes

Files:

• AnswerConnector.php (modified) (3 diffs)
• AnswerSetConnector.php (modified) (3 diffs)
• Application.php (modified) (2 diffs)
• ApplicationConnector.php (modified) (4 diffs)
• QuestionConnector.php (modified) (5 diffs)
• ResearchToolObject.php (modified) (1 diff)
• Respondent.php (modified) (2 diffs)
• RespondentConnector.php (modified) (7 diffs)
• SessionConnector.php (modified) (5 diffs)
• SurveyConnector.php (modified) (4 diffs)
• UserConnector.php (modified) (3 diffs)

Dev/trunk/classes/AnswerConnector.php

@@ -46 +46 @@
     
         /**
-         * Function get()
-         * Get the answers corresponding to the arguments
-         * 'Question' argument is supposed to be the question ID
-         * 'Values' has to be an array to make sure multiple answers can be selected.
+         * function get()
+         * @param type $arguments: An array having one or more of the following elements:
+         * 'uid', 'question', 'values'.
          */
     public function get($arguments)
@@ -99 +98 @@
         }
         /**
-         * Gets the values that belong to the answer
-         * specified by the UID
+         * function getValues()
+         * @param type $uid : The uid of the Answer for which the values should be gotten.
          */
         private function getValues($uid)
@@ -127 +126 @@
 
     /**
-     * Saves the answer Object to the RDF file.
-     * @param type $rToolObject
+         * function set()
+     * @param type $rToolObject : The ResearchToolObject to be saved.
      */
     public function set($rToolObject)

Dev/trunk/classes/AnswerSetConnector.php

@@ -44 +44 @@
 
         /**
-         * Get the AnswerSets corresponding to the arguments
-         * Arguments can be one or more of the following:
-         * uid, survey, respondent, answers
-         * Where answers is an array of answer ids
+         * function get()
+         * @param type $arguments : An array having one ore more of the following elements:
+         * 'uid', 'survey', 'respondent', 'answers'.
          */
         public function get($arguments)
@@ -102 +101 @@
         /**
          * function getAnswers()
-         * Gets the answers corresponding to the given answerset uid
+         * @param type $uid : the uid for which the answers should be retrieved.
          */
         private function getAnswers($uid)
@@ -130 +129 @@
 
         /**
-         * Save the given AnswerSet in the file.
-         * @param type $rToolObject
+         * function set()
+         * @param type $rToolObject : The ResearchToolObject to be saved.
          */
         public function set($rToolObject)

Dev/trunk/classes/Application.php

@@ -4 +4 @@
  * Description of Application
  *
- * @author fpvanagthoven
+ * @author jkraaijeveld
  */
 class Application extends ResearchToolObject{
@@ -12 +12 @@
     public $style;
 
+        /**
+         * Constructor for an Application object
+         * @param type $uid : The uid of the Application object.
+         * @param type $title: The title of the Application.
+         * @param type $description: The description of the Application.
+         * @param type $style: The style of the Application.
+         */
     public function __construct($uid = null, $title = null, $description = null, $style = null) 
     {

Dev/trunk/classes/ApplicationConnector.php

@@ -49 +49 @@
     /**
      * function get($arguments)
-     * Gets the array of Application objects belonging to arguments supplied.
      * @param type $arguments : An array containing zero or more of the following keys:
-     *                          'uid', 'title', 'description', 'style'
+     * 'uid', 'title', 'description', 'style'
      */
     public function get($arguments) {
@@ -58 +57 @@
         $keys = array_keys($arguments);
         //Set default values for arguments
-        $uid = "?uid"; $title = "?title"; $description = "?description"; $style = "?style";
+        $uid = ""; $title = ""; $description = ""; $style = "";
         //Set the arguments if they are supplied
         if(in_array("uid", $keys))
-            $uid = "\"".$arguments["uid"]."\"";
+            $uid = "predicates:uid \"".$arguments["uid"]."\"";
         if(in_array("title", $keys))
-            $title = '\''.$arguments["title"].'\'';
+            $title = 'predicates:title \''.$arguments["title"].'\'';
         if(in_array("description", $keys))
-            $description = "\"".$arguments["description"]."\"";
+            $description = "predicates:description \"".$arguments["description"]."\"";
         if(in_array("style", $keys))
-            $style = "\"".$arguments["style"]."\"";    
+            $style = "predicates:style \"".$arguments["style"]."\"";    
 
         //Create the querystring 
@@ -80 +79 @@
                                         predicates:title ?title ;
                                         predicates:description ?description ;
-                                        predicates:style ?style ;
-                                        predicates:uid ' . $uid . ' 
-                                        predicates:title ' . $title . ' 
-                                        predicates:description ' . $description . ' 
-                                        predicates:style ' . $style . '
+                                        predicates:style ?style ; '
+                    . $uid . $title . $description . $style . ' 
             }';
 
@@ -135 +131 @@
         $this->model->add(new Statement($resourceApplication,$predicateStyle,$applicationStyle));
                 
-        $this->save();
+                $this->save();
     }
 }

Dev/trunk/classes/QuestionConnector.php

@@ -50 +50 @@
     /**
      * Get the questions corresponding to the arguments.
-     * @param type $arguments 
-     * @return type Array
+         * @param type $arguments : An array having one ore more of the following elements:
+         * 'uid', 'title', 'type', 'description', 'category', 'has_answer'.
      */
     public function get($arguments)
@@ -59 +59 @@
         $keys = array_keys($arguments);
         //Set default values for arguments
-        $uid = "?uid"; $title = "?title"; $type = "?type"; $description = "?description"; $category = "?category"; $has_answer = "";
+        $uid = ""; $title = ""; $type = ""; $description = ""; $category = ""; $has_answer = "";
         //Set the arguments if they are supplied
         if(in_array("uid", $keys))
-            $uid = '\''.$arguments["uid"].'\'';
+            $uid = 'predicates:question_code \''.$arguments["uid"].'\'';
         if(in_array("title", $keys))
-            $title = '\''.$arguments["title"].'\'';
+            $title = 'predicates:title \''.$arguments["title"].'\'';
         if(in_array("type", $keys))
-            $type = '\''.$arguments["type"].'\'';
+            $type = 'predicates:type \''.$arguments["type"].'\'';
         if(in_array("description", $keys))
-            $description = "\"".$arguments["description"]."\"";
+            $description = "predicates:description \"".$arguments["description"]."\"";
         if(in_array("category", $keys))
-                        $style = "\"".$arguments["category"]."\"";
+                        $style = "predicates:category \"".$arguments["category"]."\"";
                 if(in_array("answers", $keys))
                 {
@@ -91 +91 @@
                 predicates:description ?description ;
                 predicates:question_category ?category ;
-
-                predicates:question_code ' . $uid . '
-                predicates:title ' . $title . '
-                predicates:question_type ' . $type . '
-                predicates:description ' . $description . '
-                                predicates:question_category ' . $category . ' 
-                                ' . $has_answer . '
+                                '. $uid . $title . $type . $description . $category . $has_answer . '
             }';
         //Create the querystring 
@@ -117 +111 @@
     /**
      * Gets the answers belonging to the given uid.
-     * @param type $uid
-     * @return type Array 
+     * @param type $uid : The uid of the Question in question (haha, pun).
      */
     private function getAnswers($uid)
@@ -148 +141 @@
     /**
      * Save the given ResearchTool object
-     * @param type $rToolObject 
+     * @param type $rToolObject : The ResearchToolObject to be saved.
      */
     public function set($rToolObject)

Dev/trunk/classes/ResearchToolObject.php

@@ -5 +5 @@
  * @author jkraaijeveld
  */
-class ResearchToolObject {
+abstract class ResearchToolObject {
     public $uid;
 }

Dev/trunk/classes/Respondent.php

@@ -6 +6 @@
  * @author jkraaijeveld
  */
-class Respondent extends ResearchToolObject {
+class Respondent extends User {
    public $name;
    public $password;
@@ -12 +12 @@
    /**
     * Constructor for a Respondent object
-    * @param type $uid
+    * @param type $uid 
     * @param type $name
     * @param type $password 

Dev/trunk/classes/RespondentConnector.php

@@ -12 +12 @@
 class RespondentConnector implements IConnector{
     
-    protected $model;
     protected $fileName = 'data/users/respondents.rdf';
     
@@ -20 +19 @@
     public function __construct()
     {
-        //Ensure the required folder for this connector exists
         if (!is_dir('data/users/'))
             mkdir('data/users/');       
@@ -32 +30 @@
         //Get the Memory Model from the ModelFactory
         $this->model = ModelFactory::getDefaultModel();
-        
         //Ensure the required file exists before loading
         if(file_exists($this->fileName))
@@ -47 +44 @@
     
     /**
-     * function get($arguments)
+     * function get()
      * Gets the array of Respondent objects belonging to arguments supplied.
      * @param type $arguments : An array containing zero or more of the following keys:
@@ -57 +54 @@
         $keys = array_keys($arguments);
         //Set default values for arguments
-        $uid = "?uid"; $name = "?name"; $password = "?password";
+        $uid = ""; $name = ""; $password = "";
         //Set the arguments if they are supplied
         if(in_array("uid", $keys))
-            $uid = "\"".$arguments["uid"]."\"";
+            $uid = "predicates:uid \"".$arguments["uid"]."\"";
         if(in_array("name", $keys))
-            $name = '\''.$arguments["name"].'\'';
+            $name = 'predicates:name \''.$arguments["name"].'\'';
         if(in_array("password", $keys))
-            $password = "\"".$arguments["password"]."\"";
+            $password = "predicates:password \"".$arguments["password"]."\"";
        
         //Create the querystring 
@@ -77 +74 @@
                                         predicates:name ?name ;
                                         predicates:password ?password ;
-                                predicates:uid ' . $uid . ' 
-                                        predicates:name ' . $name . ' 
-                                        predicates:password ' . $password . ' 
+                                        ' . $uid . $name . $password . '
             }';
         //Query the model
@@ -96 +91 @@
     
     /**
-     * Save the given User object in the file.
-     * @param type $rToolObject 
+         * function set()
+     * @param type $rToolObject : The ResearchToolObject to be saved.
      */
     public function set($rToolObject)

Dev/trunk/classes/SessionConnector.php

@@ -47 +47 @@
 
         /**
-         * Get the Sessions corresponding to the arguments
-         * @ param type $arguments
-         * Arguments can be one or more of the following:
-         * uid, title, datetime, applications, surveys, answersets
-         * Where applications, surveys and answersets are arrays containing ids
+         * function get()
+         * @param type $arguments : An array containing one or more of the following elements:
+         * 'uid', 'title', 'datetime', 'applications', 'surveys', 'answersets'
          */
         public function get($arguments)
@@ -119 +117 @@
         }
         /**
-         * function getPipeline
-         * Get the application and survey objects of the Session in order
+         * function getPipeline()
+         * param type $uid : The Session uid for which the pipeline should be retrieved.
          */
         private function getPipeline($uid)
@@ -145 +143 @@
 
         /**
-         * function getAnswerSets
-         * Get the answersets belonging to the given session
+         * function getAnswerSets()
+         * @param type $uid : The Session uid for which the answerSets should be retrieved.
          */
         private function getAnswerSets($uid)
@@ -163 +161 @@
 
         /**
-         * Save the given Session object in the file.
-         * @param type $rToolObjects
+         * function set()
+         * @param type $rToolObjects : The ResearchToolObject to be saved.
          */
         public function set($rToolObject)
@@ -188 +186 @@
                 $sessionTimestamp = new Literal($rToolObject->datetime->getTimestamp());
         //      $sessionTimestamp = new Literal($rToolObject->datetime);    // Edit of above function, allows for creation of session, but still results in errors...
-                $predicateTimestamp = new Resource(DATETIME);
+        $predicateTimestamp = new Resource(DATETIME);
                 $this->model->add(new Statement($resourceSession, $predicateTimestamp, $sessionTimestamp));
 

Dev/trunk/classes/SurveyConnector.php

@@ -55 +55 @@
         $keys = array_keys($arguments);
         //Set default values for arguments
-        $uid = "?uid"; $title = "?title"; $description = "?description"; $creator = "?creator"; $questions = "";
+        $uid = ""; $title = ""; $description = ""; $creator = ""; $questions = "";
         if(in_array("uid", $keys))
-            $uid = '\''.$arguments["uid"].'\'';
+            $uid = 'predicates:uid \''.$arguments["uid"].'\'';
         if(in_array("title", $keys))
-            $title = '\''.$arguments["title"].'\'';
+            $title = 'predicates:title \''.$arguments["title"].'\'';
         if(in_array("description", $keys))
-                        $description = "\"".$arguments["description"]."\"";
+                        $description = "predicates:description \"".$arguments["description"]."\"";
                 if(in_array("creator", $keys))
-                        $creator = "\"".$arguments["creator"]."\"";
+                        $creator = "predicates:creator \"".$arguments["creator"]."\"";
         if(in_array("questions", $keys))
         {
@@ -83 +83 @@
                 predicates:uid ?uid ;
                 predicates:title ?title ;
-                predicates:description ?description ;
-                predicates:uid ' . $uid . ' 
-                predicates:title ' . $title . '
-                                predicates:description ' . $description . '
-                                predicates:creator ' . $creator . '
-                ' . $questions . '
+                                predicates:description ?description ;
+                                predicates:creator ?creator ;
+                                ' . $uid . $title . $description . $creator . $questions . '
             }';
         
@@ -111 +108 @@
     /**
      * Gets the questions corresponding to the survey
-     * @param type $uid 
+     * @param type $uid : The uid for which the questions should be gotten.
      */
     private function getQuestions($uid)
@@ -143 +140 @@
     /**
      * Saves the given Survey object.
-     * @param type $rToolObject 
+     * @param type $rToolObject : The ResearchToolObject to be saved.
      */
     public function set($rToolObject)

Dev/trunk/classes/UserConnector.php

@@ -32 +32 @@
         //Get the Memory Model from the ModelFactory
         $this->model = ModelFactory::getDefaultModel();
-        
         //Ensure the required file exists before loading
         if(file_exists($this->fileName))
@@ -57 +56 @@
         $keys = array_keys($arguments);
         //Set default values for arguments
-        $uid = "?uid"; $name = "?name"; $password = "?password";
+        $uid = ""; $name = ""; $password = "";
         //Set the arguments if they are supplied
         if(in_array("uid", $keys))
-            $uid = "\"".$arguments["uid"]."\"";
+            $uid = "predicates:uid \"".$arguments["uid"]."\"";
         if(in_array("name", $keys))
-            $name = '\''.$arguments["name"].'\'';
+            $name = 'predicates:name \''.$arguments["name"].'\'';
         if(in_array("password", $keys))
-            $password = "\"".$arguments["password"]."\"";
+            $password = "predicates:password \"".$arguments["password"]."\"";
        
         //Create the querystring 
@@ -77 +76 @@
                                         predicates:name ?name ;
                                         predicates:password ?password ;
-                                        predicates:uid ' . $uid . ' 
-                                        predicates:name ' . $name . ' 
-                                        predicates:password ' . $password . ' 
+                                        ' . $uid . $name . $password . '
             }';
         //Query the model