/**
* Renders a list of items, target is the common admin-list.
* Please be aware, that the combination of paging and sortable-lists may result in unpredictable ordering.
* As soon as the list is sortable, the page-size should be at least the same as the number of elements. Optional
* it is possible to provide a filter callback which is called for each entry. If the callback returns false the
* entry gets skipped.
*
* @param class_array_section_iterator $objArraySectionIterator
* @param bool $bitSortable
* @param string $strListIdentifier an internal identifier to check the current parent-list
* @param bool $bitAllowTreeDrop
* @param string $strPagerAddon
* @param Closure $objFilter
*
* @throws class_exception
* @return string
*/
protected final function renderList(class_array_section_iterator $objArraySectionIterator, $bitSortable = false, $strListIdentifier = "", $bitAllowTreeDrop = false, $strPagerAddon = "", Closure $objFilter = null)
{
$strReturn = "";
$intI = 0;
$strListId = generateSystemid();
if (!$objArraySectionIterator->valid()) {
$strReturn .= $this->objToolkit->getTextRow($this->getLang("commons_list_empty"));
}
if ($bitSortable) {
$strReturn .= $this->objToolkit->dragableListHeader($strListId, false, $bitAllowTreeDrop, $objArraySectionIterator->getIntElementsPerPage(), $objArraySectionIterator->getPageNumber());
} else {
$strReturn .= $this->objToolkit->listHeader();
}
if ($this->renderLevelUpAction($strListIdentifier) != "") {
$strReturn .= $this->objToolkit->genericAdminList("", "", "", $this->objToolkit->listButton($this->renderLevelUpAction($strListIdentifier)), $intI++);
}
$arrMassActions = $this->getBatchActionHandlers($strListIdentifier);
$intTotalNrOfElements = $objArraySectionIterator->getNumberOfElements();
/** @var $objOneIterable class_model|interface_model|interface_admin_listable */
foreach ($objArraySectionIterator as $objOneIterable) {
// if we have a filter Closure call it else use the standard rightView method
if ($objFilter !== null) {
if ($objFilter($objOneIterable) === false) {
if ($bitSortable) {
//inject hidden dummy row for a proper sorting
$strReturn .= $this->objToolkit->genericAdminList($objOneIterable->getSystemid(), "", "", "", 0, "", "", false, "hidden");
}
$intTotalNrOfElements--;
continue;
}
} else {
if (!$objOneIterable->rightView()) {
if ($bitSortable) {
//inject hidden dummy row for a proper sorting
$strReturn .= $this->objToolkit->genericAdminList($objOneIterable->getSystemid(), "", "", "", 0, "", "", false, "hidden");
}
$intTotalNrOfElements--;
continue;
}
}
$strActions = $this->getActionIcons($objOneIterable, $strListIdentifier);
$strReturn .= $this->objToolkit->simpleAdminList($objOneIterable, $strActions, $intI++, count($arrMassActions) > 0);
}
$strNewActions = $this->mergeNewEntryActions($this->getNewEntryAction($strListIdentifier));
$strBatchActions = "";
if (count($arrMassActions) > 0) {
$strBatchActions .= $this->objToolkit->renderBatchActionHandlers($arrMassActions);
}
if ($strNewActions != "" || $strBatchActions != "") {
$strReturn .= $this->objToolkit->genericAdminList("batchActionSwitch", $strBatchActions, "", $strNewActions, $intI, "", "", $strBatchActions != "");
}
if ($bitSortable) {
$strReturn .= $this->objToolkit->dragableListFooter($strListId);
} else {
$strReturn .= $this->objToolkit->listFooter();
}
$objArraySectionIterator->setIntTotalElements($intTotalNrOfElements);
$strReturn .= $this->objToolkit->getPageview($objArraySectionIterator, $this->getArrModule("modul"), $this->getAction(), "&systemid=" . $this->getSystemid() . $this->strPeAddon . $strPagerAddon);
return $strReturn;
}
