Class Inbound_Events

Class for creating events table, storing, and retrieving event records

Package: Shared\EventManagement
Located at core/shared/classes/class.events.php

Methods summary
`public`	# `__construct( )` Inbound_Events constructor. Inbound_Events constructor.
`public static`	# `add_hooks( )` Define WordPress hooks and filters Define WordPress hooks and filters
`public static`	# `create_events_table( )` Creates inbound_events Creates inbound_events
`public static`	# `create_page_views_table( )` Creates inbound_events Creates inbound_events
`public static`	# `create_link_tracking_table( )` Creates inbound_tracked_links table Creates inbound_tracked_links table
`public static`	# `store_form_submission( $lead )` Stores a form submission event into events table Stores a form submission event into events table Parameters `$lead`
`public static`	# `store_email_click( $args )` Stores inbound email click event into events table Stores inbound email click event into events table Parameters `$args`
`public static`	# `store_unsubscribe_event( $args )` Stores inbound mailer unsubscribe event into events table Stores inbound mailer unsubscribe event into events table Parameters `$args`
`public static`	# `store_list_add_event( $lead_id, $list_id )` Stores inbound lead list addition event(s) into events table Stores inbound lead list addition event(s) into events table Parameters `$lead_id` `$list_id`
`public static`	# `store_mute_event( $args )` Stores inbound mailer mute event into events table Stores inbound mailer mute event into events table Parameters `$args`
`public static`	# `store_search_event( $args )` Stores search made events into the events table Stores search made events into the events table Parameters `$args`
`public static`	# `store_comment_event( $args )` Stores comment made events into the events table Stores comment made events into the events table Parameters `$args`
`public static`	# `store_event( $args )` Add event to inbound_events table Add event to inbound_events table Parameters `$args`
`public static`	# `store_page_view( $args )` Stores page view event int inbound_page_views table Stores page view event int inbound_page_views table Parameters `$args`
`public static`	# `delete_related_events( $post_id, $vid = 'all' )`
`public static boolean`	# `event_exists( $args )` Checks if an event has already been created. Right now mailer is the only tool leveraging this. It will need to be improved to support other uses Checks if an event has already been created. Right now mailer is the only tool leveraging this. It will need to be improved to support other uses Parameters `$args` Returns boolean
`public static BOOL`	# `check_page_view( $args )` Checks to see if lead has viewed a page Checks to see if lead has viewed a page Parameters `$args` Returns BOOL
`public static BOOL`	# `check_email_open( $args )` Checks to see if lead has opened an email Checks to see if lead has opened an email Parameters `$args` Returns BOOL
`public static BOOL`	# `check_cta_click( $args )` Checks to see if lead has opened an email Checks to see if lead has opened an email Parameters `$args` Returns BOOL
`public static`	# `get_form_submissions( $lead_id )` Get all Inbound Form submission events related to lead ID Get all Inbound Form submission events related to lead ID
`public static`	# `get_all_form_submissions( $lead_id )` Agnostically get all form submission events related to lead ID Agnostically get all form submission events related to lead ID
`public static mixed`	# `get_event_capture_data( $event )` Determine information about point of event capture Determine information about point of event capture Parameters `$event` Returns mixed
`public static`	# `get_form_submissions_by( $nature, $params )` Get form submission events given conditions Get form submission events given conditions
`public static`	# `get_page_views( $lead_id, $lead_uid = 0 , $page_id = 0 )` Get page view events related to lead ID Get page view events related to lead ID
`public static`	# `get_page_views_by( $nature, $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_page_views_count_by( $nature, $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_page_views_by_dates( $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_page_views_count( $lead_id )` Get page view count given lead_id Get page view count given lead_id
`public static`	# `get_lead_sources( $lead_id )` Get sources given lead_id Get sources given lead_id
`public static`	# `get_visitors_count( $page_id, $params = array() )` Get visitor count given page_id Get visitor count given page_id
`public static`	# `get_visitors( $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_visitors_by_dates( $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_visitors_group_by_source( $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_events( $params )` Get events given parameters Get events given parameters
`public static`	# `get_event_label( $event_name, $plural = true )` Returns a label for an event given an event_name Returns a label for an event given an event_name
`public static`	# `get_event_names( $params = array() )` Get all possible event names Get all possible event names
`public static`	# `get_events_count( $event_name )` Get all mute events given an email id Get all mute events given an email id
`public static`	# `get_events_by_dates( $params )` Get page view events given conditions Get page view events given conditions
`public static`	# `get_cta_clicks( $lead_id )` Get all cta click events related to lead ID Get all cta click events related to lead ID
`public static`	# `get_cta_clicks_by( $nature, $params )` Get cta click events given conditions Get cta click events given conditions
`public static`	# `get_cta_conversions( $nature, $params )` Gets cta conversion events by cta_id, lead_id or by page_id Gets cta conversion events by cta_id, lead_id or by page_id
`public static`	# `get_content_clicks( $lead_id )` Get all cta click events related to lead ID Get all cta click events related to lead ID
`public static`	# `get_content_clicks_by( $nature, $params )` Get cta click events given conditions Get cta click events given conditions
`public static`	# `get_email_clicks( $lead_id )` Get all email click events related to lead ID Get all email click events related to lead ID
`public static`	# `get_all_email_opens( $lead_id )` Agnosticly et all email click events related to lead ID Agnosticly et all email click events related to lead ID
`public static`	# `get_unsubscribes( $lead_id )` Get all unsubscribe events given a lead id Get all unsubscribe events given a lead id
`public static`	# `get_unsubscribes_by_email( $email_id, $vid = null )` Get all unsubscribe events given an email id Get all unsubscribe events given an email id
`public static`	# `get_unsubscribes_count_by_email_id( $email_id, $vid = null )` Get all unsubscribe events given an email id Get all unsubscribe events given an email id
`public static`	# `get_mutes( $lead_id )` Get all mute events given a lead id Get all mute events given a lead id
`public static`	# `get_mutes_by_email( $email_id, $vid = null )` Get all mute events given an email id Get all mute events given an email id
`public static`	# `get_mutes_count_by_email_id( $email_id, $vid = null )` Get all mute events given an email id Get all mute events given an email id
`public static`	# `get_custom_event_data( $lead_id )` Get custom event data by lead id Get custom event data by lead id
`public static`	# `get_custom_event_data_by( $nature, $params )` Get all all custom event data by a certain indicator Get all all custom event data by a certain indicator
`public static datetime`	# `get_last_activity( $lead_id, string $activity = 'any' )` Get date of latest activity Get date of latest activity Parameters `$lead_id` `$activity` Returns datetime or null
`public static datetime`	# `get_total_activity( $lead_id, string $activity = 'any' , $blacklist = array() )` Get count of event activity given a lead id Get count of event activity given a lead id Parameters `$lead_id` `$activity` `$blacklist` Returns datetime or null
`public static`	# `get_page_actions_count( integer $page_id, string $activity = 'any' , datetime $start_date = null, datetime $end_date = null )` Parameters `$page_id` `$activity` [any or custom event type] `$start_date` `$end_date`
`public static`	# `comment_exists( $comment_id )` Checks to see if a comment has already been logged in the events table Checks to see if a comment has already been logged in the events table Parameters `$comment_id`
`public static`	# `remove_comment_event( $comment_id )` Removes a comment from the events database Removes a comment from the events database Parameters `$comment_id`
`public static`	# `isJson( $string )`

Packages

Classes

Class Inbound_Events

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters