workflow_schema_edit_fns.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/folder/folder_edit_fns.inc';
require_once SQ_FUDGE_PATH.'/general/datetime.inc';

class Workflow_Schema_Edit_Fns extends Folder_Edit_Fns
{


    function __construct()
    {
        parent::__construct();
        $this->static_screens['details']['force_unlock'] = FALSE;
        $this->static_screens['details']['lock_type'] = 'content';
        unset($this->static_screens['workflow']);
        unset($this->static_screens['metadataSchemas']);
        unset($this->static_screens['metadata']);


    }//end constructor


    public function paintWorkflowStreams(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        $write_access = (boolean)$asset->writeAccess('links');
        $stream_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'workflow_stream', TRUE);
        $streamids = Array();

        hidden_field($prefix.'_new_selected_stream', '');
        if ($write_access === FALSE) {
            $selected_stream = NULL;
        } else {
            $selected_stream = $this->getCurrentStream($prefix);
            if ($selected_stream !== NULL) {
                $selected_stream = (string)$selected_stream->id;
                hidden_field($prefix.'_selected_stream', $selected_stream);
            }
        }

        foreach ($stream_links as $stream_link) {
            if ($stream_link['value'] == 'default_stream') {
                // Push the default stream into the front
                array_unshift($streamids, $stream_link['minorid']);
            } else {
                // Push any other streams into the back, so the default will
                // always be at the "front"
                array_push($streamids, $stream_link['minorid']);
            }
        }

        $streams_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($streamids);

        ?>
            <table class="sq-backend-table">
            <thead>
                <colgroup>
                    <col width="70" />
                    <col />
                    <col />
                    <?php
                    if ($write_access === TRUE) {
                        ?><col width="70" /><?php
                    }
                    ?>
                </colgroup>
                <tr>
                    <th><p><?php echo translate('edit_question'); ?></p></th>
                    <th><?php echo translate('stream_name'); ?></th>
                    <th><?php echo translate('workflow_summary'); ?></th>
                    <?php
                    if ($write_access === TRUE) {
                        ?><th align="center"><b><?php echo translate('delete_question'); ?></b></th><?php
                    }
                    ?>
                </tr>
            </thead>
            <tbody>
            <?php
            // The default stream is the first one on the list
            $alt_stream_num = 0;
            foreach ($streamids as $streamid) {
                $stream_info = $streams_info[$streamid];
                $streamid = (string)$streamid;

                // Get an abbreviated summary of steps - less full than that
                // of an edit order
                ob_start();
                $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($streamid, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);

                if (count($current_links) > 0) {
                    echo '<table width="100%" style="border-collapse: collapse">';
                    echo '<thead><colgroup>';
                    echo '<col width="200" /><col width="*" /><col width="250"/>';
                    echo '</colgroup></thead><tbody>';
                    $current_step_num = 0;
                    foreach ($current_links as $link) {
                        $step_assetid = $link['minorid'];

                        // Okay, now at current depth, so increment step number;
                        $current_step_num++;

                        $step_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($step_assetid);

                        echo '<tr>';

                        $border_style = '';
                        if ($current_step_num === count($current_links)) {
                            $border_style = ' style="border-bottom: 0;"';
                        }

                        echo '<td'.$border_style.'>';
                        echo '<strong>'.$current_step_num.'.</strong> '.$step_asset->name.'</strong></td>';

                        echo '<td'.$border_style.'>';
                        $conditions = $GLOBALS['SQ_SYSTEM']->am->getLinks($step_assetid, SQ_LINK_TYPE_2, 'workflow_step_condition', TRUE, 'major', NULL, TRUE);

                        if (count($conditions) === 0) {
                            echo '<span class="sq-backend-warning">No conditions selected</span>';
                        } else {
                            if (($step_asset->attr('logic') === 'all') || ($step_asset->attr('logic_num') == count($conditions))) {
                                // Nothing
                            } else {
                                echo '<em>At least '.$step_asset->attr('logic_num').' condition(s) of:</em> ';
                            }
                        }

                        $condition_names = Array();
                        foreach ($conditions as $condition) {
                            if (count($condition_names) > 3) {
                                $condition_names[] = '...';
                                break;
                            }

                            $userids = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('userid', 'workflow_step_condition', Array($condition['minorid']));
                            $userid = $userids[$condition['minorid']];
                            $user_name = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($userid);
                            $condition_name = $user_name[$userid]['name'].' (Id: #'.$userid.')';

                            if ($GLOBALS['SQ_SYSTEM']->am->isTypeDecendant($user_name[$userid]['type_code'], 'user_group') === TRUE) {
                                $logic = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('logic', 'workflow_step_condition', Array($condition['minorid']));
                                $logic_num = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('logic_num', 'workflow_step_condition', Array($condition['minorid']));
                                if ($logic[$condition['minorid']] === 'all') {
                                    $condition_name = 'All of '.$condition_name;
                                } else {
                                    $condition_name = 'At least '.$logic_num[$condition['minorid']].' of '.$condition_name;
                                }
                            }

                            $condition_names[] = $condition_name;
                        }
                        echo implode('; ', $condition_names);

                        echo '</td>';

                        echo '<td'.$border_style.'><div style="text-align: right">';
                        $expiry = (int)$step_asset->attr('expiry_time');
                        $expiry_text = easy_time_total($expiry);

                        if ($expiry > 0) {
                            if ($step_asset->attr('escalate')) {
                                $esc_links = array_reverse($GLOBALS['SQ_SYSTEM']->am->getLinks($step_assetid, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE));
                                echo translate('workflow_stream_escalation_msg', $expiry_text, count($esc_links));
                            } else {
                                echo translate('workflow_stream_reminder_sent_msg', $expiry_text);
                            }
                        }

                        echo '</div></td>';
                        echo '</tr>';
                    }

                    // Add a drop point after the last main step
                    echo '</tbody></table>';
                } else {
                    echo '<span class="sq-backend-warning">No workflow defined</span>';
                }

                $workflow_summary = ob_get_clean();

                $class_style = 'sq-table-row';
                if ($selected_stream === $streamid) {
                    $class_style .= ' alt';
                }
                if ($alt_stream_num === 0) {
                    ?><tr class="sq-table-row"><td class="sq-backend-table-header-header" colspan="<?php echo 3 + ($write_access ? 1 : 0) ?>"><?php echo translate('default_stream'); ?></td></tr><?php
                } else if ($alt_stream_num === 1) {
                    ?><tr class="sq-table-row"><td class="sq-backend-table-header-header" colspan="<?php echo 3 + ($write_access ? 1 : 0) ?>"><?php echo translate('alternate_streams'); ?></td></tr><?php
                }
            ?>
                <tr class="<?php echo $class_style ?>">
                <td><?php if (($write_access === TRUE) && ($selected_stream !== $streamid)) {
                        ?><p><a href="#" onclick="document.getElementById('<?php echo $prefix; ?>_new_selected_stream').value = <?php echo $streamid ?>; document.main_form.submit(); return false;"><?php echo trim(sq_get_icon(sq_web_path('lib').'/web/images/icons/edit_mode.png', 15, 15, $stream_info['name'], NULL, ' border="0"')); ?></a></p><?php
                    } ?></td>
                    <td><p><strong><?php echo $stream_info['name'] ?></strong></p></td>
                    <td><?php echo $workflow_summary; ?></td>
                    <?php
                    if ($write_access === TRUE) {
                        if ($alt_stream_num === 0) {
                            ?><td align="center" class="sq-backend-table-header"></td><?php
                        } else {
                            ?><td align="center" class="sq-backend-table-header"><?php echo check_box($prefix.'_delete_stream[]', $streamid, FALSE); ?></td><?php
                        }
                    }
                    ?>
                </tr>
            <?php
                // After we have gone through once, the rest are non-default.
                $alt_stream_num++;
            }

            if (count($streams_info) <= 1) {
                ?><tr class="sq-table-row"><td class="sq-backend-table-header-header" colspan="<?php echo 3 + ($write_access ? 1 : 0) ?>"><?php echo translate('alternate_streams'); ?></td></tr><?php
                ?><tr class="sq-table-row"><td></td><td colspan="<?php echo 2 + ($write_access ? 1 : 0) ?>"><?php echo translate('workflow_stream_no_alternate_'.($write_access ? 'locked' : 'unlocked')); ?></td></tr><?php
            }

            if ($write_access === TRUE) {
                ?><tr class="sq-table-row"><td class="sq-backend-table-header-header" colspan="4">Add New Workflow Stream</td></tr><?php
            ?>
                <tr>
                    <td></td>
                    <td colspan="3"><?php
                        check_box($prefix.'_new_stream', '1', FALSE, 'document.getElementById("'.$prefix.'_new_stream_name").disabled = !this.checked; if (this.checked == true) { document.getElementById("'.$prefix.'_new_stream_name").focus() };');
                        label(translate('create_new_stream_called'), $prefix.'_new_stream');
                        text_box($prefix.'_new_stream_name', '', 30, 0, FALSE, ' disabled="disabled"');
                    ?></td>
                </tr>
            <?php
            }
            ?>
            </tbody>
            </table>
        <?php
        return FALSE;

    }//end paintWorkflowStreams()


    public function processWorkflowStreams(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;

        // Creating a stream
        if ((int)array_get_index($_POST, $prefix.'_new_stream', 0) === 1) {
            $new_stream_name = trim(array_get_index($_POST, $prefix.'_new_stream_name', ''));
            if ($new_stream_name === '') return FALSE;

            $GLOBALS['SQ_SYSTEM']->am->includeAsset('workflow_stream');
            $new_stream = new Workflow_Stream();
            $schema_link = Array('asset' => &$asset, 'link_type' => SQ_LINK_TYPE_2, 'sort_order' => -1, 'is_dependant' => 1);
            $new_stream->setAttrValue('name', $new_stream_name);
            if (!$new_stream->create($schema_link)) return FALSE;
            $_POST[$prefix.'_new_selected_stream'] = $new_stream->id;
        }

        // Removing a stream - note that we cannot remove the default stream,
        // and that removing a stream only removes it from the current schema,
        // not delete it entirely. Therefore, it is possible for streams to be
        // sitting in the trash if the last link is removed.
        $remove_streams = array_get_index($_POST, $prefix.'_delete_stream', Array());
        foreach ($remove_streams as $remove_stream) {
            $stream_link = $GLOBALS['SQ_SYSTEM']->am->getLinkByAsset($asset->id, $remove_stream, SQ_LINK_TYPE_2);
            if (empty($stream_link) === FALSE) {
                if ($stream_link['value'] !== 'default_stream') {
                    if (!$GLOBALS['SQ_SYSTEM']->am->deleteAssetLink($stream_link['linkid'])) {
                        return FALSE;
                    }
                    if (array_get_index($_POST, $prefix.'_selected_stream', NULL) === $remove_stream) {
                        unset($_POST[$prefix.'_selected_stream']);
                    }
                    if (array_get_index($_POST, $prefix.'_new_selected_stream', NULL) === $remove_stream) {
                        unset($_POST[$prefix.'_new_selected_stream']);
                    }
                }
            }
        }

        return TRUE;

    }//end processWorkflowStreams()


    public function paintNewStep(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getCurrentStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->paintNewStep($selected_stream, $o, $prefix);

    }//end paintNewStep()


    public function processNewStep(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getPriorStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->processNewStep($selected_stream, $o, $prefix);

    }//end processNewStep()


    public function paintWorkflowSummary(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getCurrentStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->paintWorkflowSummary($selected_stream, $o, $prefix);

    }//end paintWorkflowSummary()


    public function processWorkflowSummary(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getPriorStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->processWorkflowSummary($selected_stream, $o, $prefix);

    }//end processWorkflowSummary()


    public function paintSteps(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getCurrentStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->paintSteps($selected_stream, $o, $prefix);

    }//end paintSteps()


    public function processSteps(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;

        $selected_stream = $this->getPriorStream($prefix);
        if ($selected_stream === NULL) return FALSE;

        $edit_fns = $selected_stream->getEditFns();
        return $edit_fns->processSteps($selected_stream, $o, $prefix);

    }//end processSteps()


    public function generateWorkflowArray(Asset $asset)
    {
        $workflow_array['steps']        = Array();
        $workflow_array['current_step'] = Array('1');
        $workflow_array['complete']     = FALSE;
        $workflow_array['schema_name']  = $asset->name;
        $workflow_array['started']      = time();
        $workflow_array['started_by']   = $GLOBALS['SQ_SYSTEM']->currentUserId();

        $i = 1;
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'workflow_step', TRUE, 'major', NULL, TRUE, FALSE);
        foreach ($current_links as $link_data) {
            $step = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($step)) continue;
            $edit_fns = $step->getEditFns();
            $workflow_array['steps'][$i] = Array();
            if (!$edit_fns->generateWorkflowArray($step, $workflow_array['steps'][$i])) {
                return FALSE;
            }
            if ($i == 1) {
                $workflow_array['steps'][$i]['started'] = time();
            }
            $i++;
        }
        return $workflow_array;

    }//end generateWorkflowArray()


    public function getPriorStream($prefix)
    {
        $selected_stream = array_get_index($_POST, $prefix.'_selected_stream', NULL);

        if ($selected_stream === NULL) {
            return NULL;
        } else {
            return $GLOBALS['SQ_SYSTEM']->am->getAsset($selected_stream);
        }

    }//end getCurrentStream();


    public function getCurrentStream($prefix)
    {
        $selected_stream = array_get_index($_POST, $prefix.'_new_selected_stream', NULL);

        if (empty($selected_stream) === TRUE) {
            $selected_stream = array_get_index($_POST, $prefix.'_selected_stream', NULL);
            if (empty($selected_stream) === TRUE) return NULL;
        } else {
        }

        return $GLOBALS['SQ_SYSTEM']->am->getAsset($selected_stream);

    }//end getCurrentStream();


    public function hasSelectedCurrentStream(Asset $asset, $prefix)
    {
        $selected_stream = $this->getCurrentStream($prefix);
        return ($selected_stream !== NULL);

    }//end hasSelectedCurrentStream()


    public function hasSelectedPriorStream(Asset $asset, $prefix)
    {
        $selected_stream = $this->getPriorStream($prefix);
        return ($selected_stream !== NULL);

    }//end hasSelectedPriorStream()


    //--        WORKFLOW SCHEMA USAGE        --//


    public function paintUsage(Workflow_Schema $asset, Backend_Outputter $o, $prefix)
    {
        $page_size = 10;

        $o->openRaw();

        $schema_treeids_sql = 'SELECT
                                treeid, assetid, granted, cascades
                                FROM (sq_ast_lnk_tree ta
                                    JOIN sq_ast_lnk la ON ta.linkid = la.linkid
                                        JOIN sq_ast_wflow wa ON la.minorid = wa.assetid)
                                WHERE wa.schemaid = :schemaid
                                AND NOT EXISTS (
                                    SELECT * FROM (sq_ast_lnk_tree tb
                                                    JOIN sq_ast_lnk lb ON tb.linkid = lb.linkid
                                                        JOIN sq_ast_wflow wb ON lb.minorid = wb.assetid)
                                    WHERE wb.schemaid = wa.schemaid
                                    AND length(ta.treeid) - LENGTH(tb.treeid) = :tree_size AND SUBSTR(ta.treeid, 1, LENGTH(ta.treeid) - :tree_size_1) = tb.treeid
                                    AND wa.granted = wb.granted
                                    AND wa.cascades = wb.cascades
                                ) ORDER BY length(treeid), treeid';

        $query = MatrixDAL::preparePdoQuery($schema_treeids_sql);
        MatrixDAL::bindValueToPdo($query, 'schemaid', $asset->id);
        MatrixDAL::bindValueToPdo($query, 'tree_size', SQ_CONF_ASSET_TREE_SIZE);
        MatrixDAL::bindValueToPdo($query, 'tree_size_1', SQ_CONF_ASSET_TREE_SIZE);
        $treeids = MatrixDAL::executePdoAssoc($query);

        if (count($treeids) > 0) {
            $tree_tops = $this->_getTreeTops($asset, $treeids);

            $num_pages = ceil(count($tree_tops) / $page_size);
            $page_num = array_get_index($_POST, $prefix.'_usage_page', 1);
            $page_num = max($page_num, 1);
            $page_num = min($page_num, $num_pages);

            if ($num_pages == 1) {
                $page_tag = translate('page_number', $page_num, $num_pages);
            } else {
                $page_tag = translate('page_number_with_pager', $page_num, $num_pages, $prefix.'_usage_page');
            }
            $asset_count_tag = translate('item_range', ($page_num - 1) * $page_size + 1, min(count($tree_tops), $page_num * $page_size), count($tree_tops), strtolower(translate('trees')));

            $tree_tops = array_slice($tree_tops, ($page_num - 1) * $page_size, $page_size);

            $links = Array(
                        'first'     => '&lt;&lt;',
                        'previous'  => '&lt;',
                        'page'      => $page_tag,
                        'next'      => '&gt;',
                        'last'      => '&gt;&gt;',
                    );

            if ($page_num > 1) {
                $links['first'] = '<a title="'.translate('pagination_go_to_first').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_usage_page\', 1)">'.$links['first'].'</a>';
                $links['previous'] = '<a title="'.translate('pagination_go_to_previous').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_usage_page\', '.($page_num - 1).')">'.$links['previous'].'</a>';
            } else {
                $links['first'] = '<span title="'.translate('pagination_cannot_go_further_back').'." style="color: #333">'.$links['first'].'</span>';
                $links['previous'] = '<span title="'.translate('pagination_cannot_go_further_back').'." style="color: #333">'.$links['previous'].'</span>';
            }

            if ($page_num < $num_pages) {
                $links['last'] = '<a title="'.translate('pagination_go_to_last').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_usage_page\', '.$num_pages.')">'.$links['last'].'</a>';
                $links['next'] = '<a title="'.translate('pagination_go_to_next').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_usage_page\', '.($page_num + 1).')">'.$links['next'].'</a>';
            } else {
                $links['last'] = '<span title="'.translate('pagination_cannot_go_further_forward').'." style="color: #333">'.$links['last'].'</span>';
                $links['next'] = '<span title="'.translate('pagination_cannot_go_further_forward').'." style="color: #333">'.$links['next'].'</span>';
            }

            hidden_field($prefix.'_usage_page', $page_num); ?>
            <table class="sq-backend-table">
            <thead>
            <tr>
                <td class="sq-backend-table-header-header"><?php echo implode(' &nbsp; &nbsp; ', $links) ?></td>
                <td class="sq-backend-table-header-header" colspan="2" style="text-align: right; font-weight: normal"><?php echo $asset_count_tag; ?></span></td>
            </tr>
            <tr class="sq-backend-table-row">
                <th class="sq-backend-table-cell"><?php echo translate('asset'); ?></th>
                <th style="width: 15%" class="sq-backend-table-cell"><?php echo translate('granted_question') ?></th>
                <th style="width: 15ex" class="sq-backend-table-cell"><?php echo translate('cascade_question') ?></th>
            </tr>
            </thead>
            <tbody>
            <?php

            foreach ($tree_tops as $tt_assetid => &$tree_top_info) {
                $root_tree = $tree_top_info;
                unset($root_tree['sub_trees']);
                $root_trees = array_merge(Array($root_tree), $tree_top_info['sub_trees']);

                foreach ($root_trees as $root_assetid => &$tree_info) {

                    ?><tr class="sq-backend-table-row">
                        <td class="sq-backend-table-cell">
                        <?php

                        $tag_line = get_asset_tag_line($tree_info['assetid'], 'details');

                        echo ($tree_info['depth'] === 0 ? '' : '<span style="padding-left: '.($tree_info['depth']*5).'ex">');
                        echo translate('asset_and_child_count_0', $tag_line);
                        echo ($tree_info['depth'] === 0 ? '' : '</span>');

                        ?></td>
                        <td class="sq-backend-table-cell">
                            <strong><span style="color: <?php echo (($tree_info['granted'] == '0') ? 'red' : 'green'); ?>"><?php echo (($tree_info['granted'] == '0') ? translate('denied') : translate('applied')) ?></span></strong>
                        </td>
                        <td class="sq-backend-table-cell">
                            <img src="<?php echo sq_web_path('lib'); ?>/web/images/<?php echo ($tree_info['cascades'] === '1' ? 'tick' : 'cross'); ?>.gif" width="15" height="15" style="vertical-align: middle;" alt="<?php echo translate($tree_info['cascades'] === '1' ? 'yes' : 'no'); ?>" />
                        </td>
                    </tr>
                    <?php
                }//end foreach entry

                unset($tree_info);

            }//end foreach top tree
            ?>

            </tbody>
            </table>
            <?php

            $o->note(translate('core_schema_usage_explanation'));

        } else {
            $o->note(translate('core_schema_usage_no_assets'));
        }

        $o->closeRaw();

        return FALSE;

    }//end paintUsage()


    public function _getTreeTops(Workflow_Schema $asset, Array $treeids)
    {
        $used_assetids = Array();

        $all_treeids = Array();
        foreach ($treeids as $treeid) {
            $all_treeids[$treeid['treeid']] = $treeid;
        }
        unset($treeids);

        $res = Array();
        foreach ($all_treeids as $tree_info) {
            $treeid = $tree_info['treeid'];
            $treeid_copy = $treeid;
            $top_parent  = $treeid;
            $depth       = 0;
            $used_sub_tree = FALSE;

            while (empty($treeid_copy) === FALSE) {
                if (isset($res[$treeid_copy]) === TRUE) {
                    if ($used_sub_tree === FALSE) {
                        $used_sub_tree = TRUE;
                    }
                }

                if (($used_sub_tree === TRUE) && (array_key_exists($treeid_copy, $all_treeids) === TRUE)) {
                    $top_parent = $treeid_copy;
                    $depth++;
                }

                $treeid_copy = substr($treeid_copy, 0, -SQ_CONF_ASSET_TREE_SIZE);
            }

            $res[$treeid] = $tree_info;
            $res[$treeid]['top_parent'] = $top_parent;
            $res[$treeid]['depth'] = $depth;
            $res[$treeid]['sub_trees'] = Array();

            // Have we seen this asset before? If so, let it go, but mark it
            // to be dumped afterwards so we only have one of each asset
            if (array_search($tree_info['assetid'], $used_assetids) === FALSE) {
                $res[$treeid]['dupe'] = FALSE;
                $used_assetids[] = $tree_info['assetid'];
            } else {
                $res[$treeid]['dupe'] = TRUE;
            }
        }

        foreach ($res as $key => &$res_item) {
            if ($res_item['dupe'] === TRUE) {
                unset($res[$key]);
            } else {
                if ($res_item['depth'] > 0) {
                    $res[$res_item['top_parent']]['sub_trees'][$res_item['treeid']] =& $res_item;
                    unset($res[$key]);
                }
            }
        }

        // Sort each sub-tree top-to-bottom, to ensure correct tree order
        foreach ($res as $key => &$res_item) {
            uksort($res_item['sub_trees'], create_function('$key1,$key2', 'return strcmp($key1, $key2);'));
        }

        unset($res_item);

        return $res;

    }//end _getTreeTops()


}//end class

?>