Documentation

GetList

CDBResult
CSaleOrderPropsGroup::GetList(
  string &by,
  string &order,
  array arFilter = Array()
);

The method GetList returns an optionally sorted and filtered list of order property groups.

Parameters

ParameterDescription
by Specifies the name of a parameter by which the sorting is to be performed. 

The following values are possible:
  • SORT - sort weight (default);
  • NAME - name;
  • PERSON_TYPE_ID - the payer type ID.
order Sort order. Can be one of the following:
  • ASC - ascending;
  • DESC - descending.
arFilter The filter is an associated array whose keys are the parameter names, and values are the conditions.

The following keys are possible:
  • PERSON_TYPE_ID - the payer type ID;
  • ID - the property group ID.

Return Values

Returns an instance of CDBResult, containing a set of associated arrays with the following keys.

Key Description
ID The property group ID.
PERSON_TYPE_ID The payer type ID.
NAME Group name.
SORT Sort weight.

Example


<?
// Display all groups for payer $PERSON_TYPE
$db_propsGroup = CSaleOrderPropsGroup::GetList(($by="SORT"), 
                                               ($order="ASC"), 
                                               Array("PERSON_TYPE_ID"=>$PERSON_TYPE));
while ($propsGroup = $db_propsGroup->Fetch())
{
   echo $propsGroup["NAME"]."<br>";
}
?>
© «Bitrix24», 2001-2024