Bug fixes.

Author: judgej

Academe/SugarRestApi/Api/Api.php

@@ -637,7 +637,10 @@ public function parseRelationshipList($entry_list)
                     // No 'link_list' in the wrapper wrapper here.
                     // The format of the linked list data varies depending on whether we are
                     // fetching for a single entry or multiple entries.
-                    $master_sequence = 0;
+                    // And it also varies according to which API function is called. Th lack of
+                    // documentation is infuriating.
+
+                    //$master_sequence = 0;
                     foreach($link_list_wrapper as $list_sequence => $list) {
                         if (!empty($list['records']) && is_array($list['records'])) {
                             $relationship_name = $list['name'];
@@ -656,7 +659,7 @@ public function parseRelationshipList($entry_list)
                                     ? $this->relationship_aliases[$relationship_name]
                                     : $relationship_name
                                 );
-                                $linked_data[$master_sequence][$alias][] = $record_data;
+                                $linked_data[$list_sequence][$alias][] = $record_data;
                             }
                         }
                     }
@@ -702,6 +705,9 @@ public function arrayToMultiSelectValue($value)
         return '^' . implode('^,^', $value) . '^';
     }
 
+    // TODO: rather than newFoo(), perhaps we need makeFoo().
+    // We are making a model object, and not necessarily a new record at this point.
+
     // Return a new entry object.
 
     public function newEntry($module)
@@ -735,6 +741,9 @@ public function newModule($module)
     // Create a generic object.
     // constructor_args is an array of arguments that are passed into the constructor
     // of the class as separate argumens.
+    // TBH The constructor args are pretty useless ATM, as the first argument on all
+    // of the models is the API anyway. Perhaps here we can pass it in as the first of
+    // the $constructor_args rather than through setApi()?
 
     protected function newObject($module, $class_name, $constructor_args = array())
     {

Academe/SugarRestApi/Api/v4.php

@@ -463,11 +463,23 @@ public function getRelationships(
             'limit' => $limit,
         );
 
+        //var_dump($this->apiPost('get_relationships', $parameters));
         return $this->apiPost('get_relationships', $parameters);
     }
 
     // Set a single relationship between two beans. The items are related by module name and id.
-    public function setRelationship($moduleName, $beanId, $linkFieldName, $relatedIds, $data, $delete = 0)
+    // To remove the links instead of adding them, set $delete to 1.
+    // Relationship links are added and removed in a cumulative manner, i.e. only those
+    // relatedIds supplied will be touched.
+
+    public function setRelationship(
+        $moduleName,
+        $beanId,
+        $linkFieldName,
+        $relatedIds,
+        $data,
+        $delete = 0
+    )
     {
         $parameters = array(
             'session' => $this->getSessionId(),
@@ -484,7 +496,15 @@ public function setRelationship($moduleName, $beanId, $linkFieldName, $relatedId
 
     // Set a single relationship between two beans. The items are related by module name and id.
     // @todo Description is wrong.
-    public function setRelationships($moduleNames, $beanIds, $linkFieldNames, $relatedIds, $data, $delete = array())
+
+    public function setRelationships(
+        $moduleNames,
+        $beanIds,
+        $linkFieldNames,
+        $relatedIds,
+        $data,
+        $delete = array()
+    )
     {
         $parameters = array(
             'session' => $this->getSessionId(),

Academe/SugarRestApi/Model/Entry.php

@@ -108,6 +108,8 @@ public function getRelationshipFields($relationship_name = null)
     }
 
     // Get a single relationship as an array.
+    // TODO: name this relationshipToArray() for a little more consistency.
+    // Also similar renaming in EntryList would be good.
 
     public function getRelationshipAsArray($relationship_name = null)
     {
@@ -231,6 +233,7 @@ public function setField($name, $value)
 
     // Update the values of multiple fields.
     // Supply a key=>value array.
+    // TODO: maybe change this to "fill()"?
 
     public function updateFields($fields)
     {
@@ -245,13 +248,21 @@ public function getFields()
         return $this->getAsArray();
     }
 
+    // Get the Entry properties as an array.
+    // CHECKME: it would be great if we could catch get_object_vars() and feed it through
+    // this method, but I cannot see a way to do that yet.
+    // ** DEPRECATED ** use toArray() instead.
     public function getAsArray()
+    {
+        return $this->toArray();
+    }
+    public function toArray()
     {
         // Add in any relationship data if there is any.
         if (!empty($this->_relationships)) {
             return array_merge(
                 $this->_fields,
-                array('_relationships' => $this->getRelationshipFields())
+                array('_relationships' => $this->getRelationshipAsArray())
             );
         } else {
             return $this->_fields;

Academe/SugarRestApi/Model/EntryList.php

@@ -142,7 +142,18 @@ public function __construct($api = null, $entry_list = array())
     public function setEntryList($entry_list) {
         if (empty($entry_list) || !is_array($entry_list)) return;
 
-        // xxx
+        // Set the entry data.
+        $this->parseEntryList($entry_list);
+
+        // Set this data set as complete so we don'y attempt to fetch more
+        // from the CRM.
+        $this->list_complete = true;
+
+        // Set the total count.
+        $this->total_count = count($this->entry_list);
+        $this->result_count = $this->total_count;
+
+        return $this;
     }
 
     // Return the first Entry on the EntryList.
@@ -343,8 +354,14 @@ public function getFields($id = null)
     }
 
     // Get a single entry or all entries as an array.
+    // Actually, this should be toArray()
 
     public function getAsArray($id = null)
+    {
+        return $this->toArray($id);
+    }
+
+    public function toArray($id = null)
     {
         $result = array();
 
@@ -385,23 +402,17 @@ public function parseEntryList($entry_list)
 
         // Take each entry returned from the API, and turn them into a separate entry class.
         if (!empty($entry_list['entry_list'])) {
-            // Keep a count of the entries, as it is the only way to match them up to 
-            // the relationship records.
-            $entry_count = 0;
-
-            foreach ($entry_list['entry_list'] as $entry) {
+            foreach ($entry_list['entry_list'] as $record_sequenec => $entry) {
                 $Entry = new $this->api->entry_classname($this->api, $entry);
                 $Entry->setModule($this->module);
 
                 // If there is relationshnip data for this entry, then add it to the object.
-                if (!empty($linked_data[$entry_count])) {
-                    $Entry->setRelationshipFields($linked_data[$entry_count]);
+                if (!empty($linked_data[$record_sequenec])) {
+                    $Entry->setRelationshipFields($linked_data[$record_sequenec]);
                 }
 
                 //$this->entry_list[$Entry->id] = $Entry;
                 $this->addEntry($Entry->id, $Entry);
-
-                $entry_count++;
             }
         } elseif (is_array($entry_list)) {
             // Not API data - just arrays of entry arrays.