API:getChildIds

From MODx Wiki

Jump to: navigation, search

API Function Definition:

getChildIds

Versions: > 0.9.2 ?
Return Values: Success: id(s) of document's children; Fail: empty array
Data Type: Array
Object Hierarchy: DocumentParser

Array getChildIds(mixed $id[, int $depth[, array $children]]);

$id - the parent page to start from
$depth - how many levels deep to search for children
$children - ?

[edit]

Examples

Returns an array of child IDs belonging to the specified parent.

[edit]

Related Functions

[edit]

Function Source

function getChildIds($id, $depth= 10, $children= array ()) {
        $c= null;
        foreach ($this->documentMap as $mapEntry) {
            if (isset ($mapEntry[$id])) {
                $childId= $mapEntry[$id];
                $childKey= array_search($childId, $this->documentListing);
                if (!$childKey) {
                    $childKey= "$childId";
                }
                $c[$childKey]= $childId;
            }
        }
        $depth--;
        if (is_array($c)) {
            if (is_array($children)) {
                $children= $children + $c;
            } else {
                $children= $c;
            }
            if ($depth) {
                foreach ($c as $child) {
                    $children= $children + $this->getChildIds($child, $depth, $children);
                }
            }
        }
        return $children;
    }