Class Ad
Represents a single element in a result having the ad format.
-
Apptus\ESales\Connector\Ad
implements
IteratorAggregate
Methods summary
public
Apptus\ESales\Connector\Attribute |null
|
#
getAttribute( string $name )
Get the attribute with the specified name or null if no such attribute exists for this ad.
Get the attribute with the specified name or null if no such attribute exists for this ad.
Parameters
- $name
- name of the attribute to get.
Returns
|
public
Apptus\ESales\Connector\Time\TimePoint |null
|
#
getStartTime( )
Get the start time or null if no such attribute exists for this ad.
Get the start time or null if no such attribute exists for this ad.
Returns
|
public
Apptus\ESales\Connector\Time\TimePoint |null
|
#
getEndTime( )
Get the end time or null if no such attribute exists for this ad.
Get the end time or null if no such attribute exists for this ad.
Returns
|
public
Apptus\ESales\Connector\Filter |null
|
#
getIncluded( )
Get the "included" attribute or null if no such attribute exists for this ad.
Get the "included" attribute or null if no such attribute exists for this ad.
Returns
|
public
Apptus\ESales\Connector\Filter |null
|
#
getRelated( )
Get the "related" attribute or null if no such attribute exists for this ad.
Get the "related" attribute or null if no such attribute exists for this ad.
Returns
|
public
string
|
#
campaignKey( )
Get the campaign key of this ad.
Get the campaign key of this ad.
Returns
string The campaign key of this ad.
|
public
string
|
#
key( )
Get the key of this ad
Returns
string The key of this ad.
|
public
string|mixed
|
#
getValue( string $attributeName, mixed $defaultValue = null )
Get the value of the attribute with the specified
attributeName
. The specified
defaultValue
will be returned if no such attribute exists (defaults to null).
Get the value of the attribute with the specified
attributeName
. The specified
defaultValue
will be returned if no such attribute exists (defaults to null).
Parameters
- $attributeName
- name of the attribute whose value to retrieve.
- $defaultValue
value to return if this ad doesn't have an attribute with the specified
attributeName
.
Returns
string|mixed The attribute value of attribute with the specified
attributeName
. The supplied
defaultValue
will be returned
if this ad has no attribute matching the name.
|
public
|
|
public
string
|
#
getTicket( )
Get the notification ticket of this ad.
Get the notification ticket of this ad.
Returns
string The ticket.
|
public
Apptus\ESales\Connector\Products
|
#
getProducts( )
Get the products in this ad.
Get the products in this ad.
Returns
|
public
|
|