Bitrix Site Manager

CAdv::GetSimpleList

CDBResult
CAdv::GetSimpleList(
 string &by = "s_referer1",
 string &order = "desc",
 array filter = array(),
 bool &is_filtered
)

The method GetSimpleList returns a brief list of advertising campaigns (AC).

Parameters

Parameter Description
by Sorting field. Possible values:
  • s_id - the ID of the AC;
  • s_referer1 - the referer1 identifier of the AC;
  • s_referer2 - the referer2 identifier of the AC;
  • s_description - the description of the AC.
order Sort order. Possible values:
  • asc - ascending;
  • desc - descending.
filter Array used to filter the resulting list. The following keys are possible in this array:
  • ID* - the ID of the AC;
  • ID_EXACT_MATCH - if set to "N", the ID can be an entry in the identifier string (loose match);
  • REFERER1* - the referer1 identifier of the AC;
  • REFERER1_EXACT_MATCH - if set to "Y", the REFERER1 must match exactly;
  • REFERER2* - the referer2 identifier of the AC;
  • REFERER2_EXACT_MATCH - if set to "Y", the REFERER2 must match exactly;
  • DESCRIPTION* - the description of the AC;
  • DESCRIPTION_EXACT_MATCH - if set to "Y", the DESCRIPTION must match exactly.
* - complex logic is allowed
is_filtered If this variable contains "true" on return, the resulting list is filtered.

Structure of the returned record

Array
(
    [ID] => ID
    [REFERER1] => the referer1 identifier
    [REFERER2] => the referer2 identifier
    [DESCRIPTION] => description
)

See Also

Example



<?
// select only those advertising campaigns whose referer1 contains "google"
$arFilter = array(
    "REFERER1" => "google"
    );

// obtain the set of records
$rs = CAdv::GetSimpleList(
    ($by="s_referer1"), 
    ($order="desc"), 
    $arFilter, 
    $is_filtered
    );

// print all the records
while ($ar = $rs->Fetch())
{
    echo "<pre>"; print_r($ar); echo "</pre>";    
}
?>