Class Inbound_Mailer_Variations

Class interface for retrieving email variation elements and recording "online version" event statistics

Package: Mailer\Variations
Located at core/mailer/classes/class.variations.php

Methods summary
`public`	# `__construct( )`
`public static`	# `load_hooks( )`
`public static`	# `delete_variation( INT $inbound_email_id, INT $vid )` Deletes variation for a call to action Deletes variation for a call to action Parameters `$inbound_email_id` id of call to action `$vid` id of variation to delete
`public static`	# `pause_variation( INT $inbound_email_id, INT $vid )` Pauses variation for a call to action Pauses variation for a call to action Parameters `$inbound_email_id` id of call to action `$vid` id of variation to delete
`public static`	# `play_variation( INT $inbound_email_id, INT $vid )` Activations variation for a call to action Activations variation for a call to action Parameters `$inbound_email_id` id of call to action `$vid` id of variation to play
`public static`	# `set_variation_status( INT $inbound_email_id, INT $vid, STRING $status = 'play' )` Sets the variation status to a custom status Sets the variation status to a custom status Parameters `$inbound_email_id` id of call to action `$vid` id of variation to delete `$status` custom status
`public static`	# `get_variations( INT $inbound_email_id, INT $vid = null )` Returns array of variation data given a call to action id Returns array of variation data given a call to action id Parameters `$inbound_email_id` id of call to action `$vid` id of specific variation Returns ARRAY of variation data
`public static`	# `get_variation_status( INT $inbound_email_id, INT $vid = null )` Returns the status of a variation given inbound_email_id and vid Returns the status of a variation given inbound_email_id and vid Parameters `$inbound_email_id` id of call to action `$vid` variation id of call to action Returns STRING status
`public static INT`	# `get_next_variant_marker( INT $inbound_email_id )` Set Variant Marker - When automated emails are sent we still want to rotate variations if they exist. When an email is bein sent to one lead, batching needs a consistant way to rotate variations Set Variant Marker - When automated emails are sent we still want to rotate variations if they exist. When an email is bein sent to one lead, batching needs a consistant way to rotate variations Parameters `$inbound_email_id` Returns INT $next_variant_marker
`public static`	# `set_variation_marker( INT $inbound_email_id, INT $variation_marker )` Updates variation marker (used for single sends) Updates variation marker (used for single sends) Parameters `$inbound_email_id` `$variation_marker`
`public static`	# `get_variation_permalink( INT $inbound_email_id, INT $vid = null )` Returns the permalink of a variation given inbound_email_id and vid Returns the permalink of a variation given inbound_email_id and vid Parameters `$inbound_email_id` id of call to action `$vid` variation id of call to action Returns STRING permalink
`public static`	# `update_variations( INT $inbound_email_id, variations $variations )` Updates 'inbound-email-variations' meta key with json object Updates 'inbound-email-variations' meta key with json object Parameters `$inbound_email_id` id of call to action `$variations` of variation data
`public static ARRAY`	# `get_variation_meta( INT $inbound_email_id, INT $vid )` Returns array of variation specific meta data Returns array of variation specific meta data Parameters `$inbound_email_id` ID of call to action `$vid` ID of variation belonging to call to action Returns ARRAY $meta array of variation meta data
`public static STRING`	# `get_variation_notes( INT $inbound_email_id, INT $vid = null )` Gets the call to action variation notes Gets the call to action variation notes Parameters `$inbound_email_id` id of call to action `$vid` variation id of call to action variation, will attempt to autodetect if left as null Returns STRING $notes variation notes.
`public static STRING`	# `get_variation_custom_css( INT $inbound_email_id, INT $vid = null )` Gets the call to action variation custom css Gets the call to action variation custom css Parameters `$inbound_email_id` id of call to action `$vid` variation id of call to action variation, will attempt to autodetect if left as null Returns STRING $custom_css.
`public static STRING`	# `get_variation_custom_js( INT $inbound_email_id, INT $vid = null )` Gets the call to action variation custom js Gets the call to action variation custom js Parameters `$inbound_email_id` id of call to action `$vid` variation id of call to action variation, will attempt to autodetect if left as null Returns STRING $custom_js.
`public static`	# `prepare_input_id( $id, $vid = null )`
`public static`	# `get_current_variation_id( )`
`public static`	# `get_next_available_variation_id( $inbound_email_id )`
`public static`	# `get_current_template( $inbound_email_id, $vid = null )`
`public static STRING`	# `get_screenshot_url( INT $inbound_email_id, INT $vid = null )` Get Screenshot URL for email preview. If local environment show template thumbnail. Get Screenshot URL for email preview. If local environment show template thumbnail. Parameters `$inbound_email_id` id if of call to action `$vid` id of variation belonging to call to action Returns STRING url of preview
`public static STRING`	# `append_variation_id_to_url( link $link )` Appends current variation id onto a URL Appends current variation id onto a URL Parameters `$link` URL that param will be appended onto Returns STRING modified URL.
`public static STRING`	# `vid_to_letter( INT $inbound_email_id, INT $vid )` Discovers which alphabetic letter should be associated with a given cta's variation id. Discovers which alphabetic letter should be associated with a given cta's variation id. Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action Returns STRING alphebit letter.
`public static INT`	# `get_impressions( INT $inbound_email_id, INT $vid )` Returns impression for given cta and variation id Returns impression for given cta and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action Returns INT impression count
`public static`	# `record_impression( INT $inbound_email_id, INT $vid )` Increments impression count for given cta and variation id Increments impression count for given cta and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action
`public static`	# `set_impression_count( INT $inbound_email_id, INT $vid, $count )` Manually sets conversion count for given cta id and variation id Manually sets conversion count for given cta id and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action `$count`
`public static INT`	# `get_conversions( INT $inbound_email_id, INT $vid )` Returns impression for given cta and variation id Returns impression for given cta and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action Returns INT impression count
`public static INT`	# `get_conversion_rate( INT $inbound_email_id, INT $vid )` Returns conversion rate for given cta and variation id Returns conversion rate for given cta and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action Returns INT conversion rate
`public static`	# `record_conversion( INT $inbound_email_id, INT $vid )` Increments conversion count for given cta id and variation id Increments conversion count for given cta id and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action
`public static`	# `set_conversion_count( INT $inbound_email_id, INT $vid, $count )` Manually sets conversion count for given cta id and variation id Manually sets conversion count for given cta id and variation id Parameters `$inbound_email_id` id of call to action `$vid` id of variation belonging to call to action `$count`

Packages

Classes

Class Inbound_Mailer_Variations

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters