Cold Help System: Programming: ColdC Reference Manual: Functions: Object: ancestors()

LIST ancestors([SYMBOL order])

This function returns a list of the ancestors of the current object. The order of the list is specified by sending either 'depth or 'breadth (for a depth-first or breadth-first order, respectively). If no order is specified, the order is depth-first (similar to methods). The current object is always the first element in this list. The heirarchy:

    $root
    /   \
$obj_a   |
   |     |
$obj_b $obj_c
    \   /
   $obj_d

Is used in the following examples, as called from $obj_d:

ancestors()
=> [$obj_d, $obj_b, $obj_a, $obj_c, $root]

ancestors('breadth)
=> [$obj_d, $obj_b, $obj_c, $obj_a, $root]

ancestors() | children() | chparents() | create() | data() | del_objname() | destroy() | has_ancestor() | lookup() | objname() | objnum() | parents() | set_objname()