• ⌂ collection
• Methods
  • Constructor
  • as_array()
  • clear_objects()
  • delete()
  • get()
  • get_common_content_type()
  • get_common_display_fields()
  • get_first()
  • get_query_info()
  • get_row()
  • get_rows()
  • in_collection()
  • merge()
  • remove_object()
  • remove_objects()

collection::remove_object()

Remove a specific object, or object at a specific offset from the collection.  To remove a specific object, pass the object itself.  To remove an object at a specific offset, pass the offset.

If the collection represents an object field, and the parent object is subsequently stored, saved or approved, the removed object will be eliminated from the field.  If the field contains embedded objects, the object itself will also be removed.  If the object field references the object, then the object will only be removed from the field, and not removed from the repository.

Prototype

array remove_object(mixed $object_or_offset)

Parameters

• object_or_offset - An Object to remove, or index of the object in the collection to remove.

Return

Returns an associative array with one item that represents the removed object where the key is the index of the removed object and the value is the object itself.

Example

// Remove the first relative from all contact's Relatives field.
$contacts = $repo->get("FROM Contact WHERE !ISNULL(Relatives)");
foreach($contacts as $contact) {
    $contact->Relatives->remove_object(0);
    $contact->approve();
}

• < merge()
• remove_objects() >