Interface Inx_Api_DataAccess_LinkDataQuery

Description

LinkDataQuery provides a fluent interface for retrieving link data. to filter the links:

  • mailing IDs
  • link IDs
  • recipient IDs
  • link types
  • link names
  • link name set
  • permanent links only
Each filter is assigned by calling the corresponding method.

LinkDataQuery provides a fluent interface for retrieving link data. The following criteria can be used to filter the links:

  • mailing IDs
  • link IDs
  • recipient IDs
  • link types
  • link names
  • link name set
  • permanent links only
Each filter is assigned by calling the corresponding method. All filters can be freely combined. Most parameters shall be given as an array. This allows the creation of complex queries while the fluent interface keeps the syntax as concise as possible. It is possible to set each filter multiple times, but each subsequent set call will overwrite the previous configuration of this filter.

Important note: The Inxmail Professional server will terminate any ClickDataQuery request that produces an overall result size of over ten million links, by default. Any request with a result size above this threshold will result in a server-side RuntimeException.

The following snippet demonstrates how simple it is to retrieve all links which are of a certain type and have been clicked by specific members:

 $oQuery = session->getDataAccess()->getLinkDataWithNewLinkType()->createQuery();
 $oResult = $oQuery->linkTypes(aray(Inx_Api_DataAccess_LinkDataRowSet::LINK_TYPE_UNIQUE_COUNT))->
      recipientIds(array(1001, 1002))->executeQuery();

For more information about link data, see the Inx_Api_DataAccess_LinkData documentation.

Located in /Api/DataAccess/LinkDataQuery.php (line 39)


	
			
Method Summary
Methods
executeQuery (line 131)

Executes the query, applying all filters and returning the resulting LinkDataRowSet.

Executes the query, applying all filters and returning the resulting LinkDataRowSet.

  • return: a LinkDataRowSet object that contains the data produced by this query.
  • access: public
linkIds (line 58)

Assigns a link filter for links, overwriting any existing link filters. the given link IDs.

Assigns a link filter for links, overwriting any existing link filters. The filter matches all links with the given link IDs. The result will contain the links with the given link IDs. Invalid link IDs will be ignored.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery linkIds ([ $aLinkIds = null])
  • $aLinkIds $aLinkIds: the IDs of the links by which the result shall be filtered.
linkNames (line 92)

Assigns a link name filter for link names, overwriting any existing link name filters. contains all links where the names (alias) of the link is equal to any given link name. called at all or called with null this filter doesn't apply.

Assigns a link name filter for link names, overwriting any existing link name filters. The result contains all links where the names (alias) of the link is equal to any given link name. If this method is not called at all or called with null this filter doesn't apply.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery linkNames ([ $aLinkNames = null])
  • $aLinkNames $aLinkNames: the link names by which the result shall be filtered.
linkNameSet (line 104)

Assigns a link name set filter for filtering whether link name has a value or is null, overwriting any existing link name set filters. means not null. null.

Assigns a link name set filter for filtering whether link name has a value or is null, overwriting any existing link name set filters. If TRUE, the result only contains links with a set name, which means not null. If FALSE, the result only contains links where the link name is null. If the method is not called at all or called with null this filter doesn't apply.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery linkNameSet ($blLinkNameSet $blLinkNameSet)
  • $blLinkNameSet $blLinkNameSet: defines whether a link name must be set or not.
linkTypes (line 70)

Assigns a link type filter for link types, overwriting any existing link type filter. contain only links of the given types.

Assigns a link type filter for link types, overwriting any existing link type filter. The result will contain only links of the given types.

  • return: this query.
  • throws: Inx_Api_IllegalArgumentException if at least one of the given link types is not one of the link types specified in Inx_Api_DataAccess_LinkDataRowSet, excluding LINK_TYPE_UNKNOWN.
  • access: public
Inx_Api_DataAccess_LinkDataQuery linkTypes ([ $aLinkTypes = null])
  • $aLinkTypes $aLinkTypes: the link types by which the result shall be filtered.
mailingIds (line 48)

Assigns a mailing filter for mailings, overwriting any existing mailing filters. contain links which are part of the given mailings.

Assigns a mailing filter for mailings, overwriting any existing mailing filters. The result will only contain links which are part of the given mailings. Invalid mailing IDs will be ignored.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery mailingIds ([ $aMailingIds = null])
  • $aMailingIds $aMailingIds: the IDs of the mailings by which the result shall be filtered.
permanentAndTemporaryLinks (line 123)

Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. the result may contain temporary links. only.

Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. If called, the result may contain temporary links. If the method is not called, the result will include permanent links only.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery permanentAndTemporaryLinks ()
permanentLinksOnly (line 113)

Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. the query result will contain permanent links only.

Assigns a link filter for filtering permanent links, overwriting any existing permanent link filter. If called, the query result will contain permanent links only. This is the default behaviour.

  • return: this query.
  • access: public
Inx_Api_DataAccess_LinkDataQuery permanentLinksOnly ()
recipientIds (line 81)

Assigns a recipient filter for recipients, overwriting any existing recipient filters. contain all links which have been clicked by at least one of the given recipients. ignored.

Assigns a recipient filter for recipients, overwriting any existing recipient filters. The result will contain all links which have been clicked by at least one of the given recipients. Invalid recipient IDs will be ignored.

  • return: query.
  • access: public
Inx_Api_DataAccess_LinkDataQuerythis recipientIds ([ $aRecipientIds = null])
  • $aRecipientIds $aRecipientIds: the ID of the recipient by which the result shall be filtered.

Documentation generated on Thu, 17 Sep 2015 14:27:26 +0200 by phpDocumentor 1.3.2