Chapter 30. Element Object Definition

Midgard functions like mgd_get_element and mgd_list_elements return objects upon success. This section describes the contents of those objects. Most object parameters map directly to the record fields described above.

The functions listed within the object definition are the object methods that are available for the object. Usage information about those methods can be found in Object Methods.


/* Element Object Prototype */

Class element {
 var $N;   // Only in objects returned by mgd_list_element
 var $id;
 var $style;
 var $name;
 var $value;
 var $sitegroup;

 function fetch(); // Only in objects returned by mgd_list_element
 
 function create();
 function update();
 function delete();

 function createattachment();
 function updateattachment();
 function deleteattachment();
 function getattachment();
 function listattachments();
 function openattachment();
 function serveattachment();

 function listparameters();
 function parameter();
 function searchparameters();

 function getsitegroup();
 function setsitegroup();
}