Bitrix Site Manager

CStatEventType::GetByID

CDBResult
CStatEventType::GetByID(
 int type_id
)

The method GetByID returns information on the specified event type.

Parameters

Parameter Description
type_id The event type ID.

Structure of the returned record

Array
(
    [ID] => the event type ID
    [EVENT1] => the event1 identifier of the event type
    [EVENT2] => the event2 identifier of the event type
    [NAME] => the event type name
    [EVENT] => event1 / event2, or the type name if specified
    [DESCRIPTION] => the event type description
    [MONEY] => total amount of money for this event type
    [DATE_ENTER] => the date the event was created
    [DATE_CLEANUP] => the date the statistical information
                      on this event type was cleaned up, on daily basis
    [C_SORT] => sort order
    [COUNTER] => counter to keep the number of events of this type
    [ADV_VISIBLE] => [Y|N] flag: whether to include statistics on this
                                 event type in adv. campaign reports
    [KEEP_DAYS] => days to keep events of this type
    [DYNAMIC_KEEP_DAYS] => days to keep statistical information
                           on this event type, on daily basis
    [DIAGRAM_DEFAULT] => [Y|N] flag: whether to include this event type
                                     in charts and graphs by default
)

See Also

Example



<?
$type_id = 1;
if ($rs = CStatEventType::GetByID($type_id))
{
    $ar = $rs->Fetch();
    // print the event type parameters
    echo "<pre>"; print_r($ar); echo "</pre>";
}
?>