CRM_Mailing_BAO_Mailing

Class constructor.

Returns the names of this table

Initialize the DAO object.

Generate and assign an arbitrary value to a field of a test object.

Reset the DAO object.

DAO is kinda crappy in that there is an unwritten rule of one query per DAO.

We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution

Execute a query by the current DAO, localizing it along the way (if needed).

Static function to set the factory instance for this class.

Factory method to instantiate a new object from a table name.

Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.

Defines the default key as 'id'.

Tells DB_DataObject which keys use autoincrement.

'id' is autoincrementing by default.

Returns foreign keys and entity references.

Returns all the column names of this table

Get/set an associative array of table columns

Save DAO object.

Deletes items from table which match current objects variables.

Returns the true on success

for example

Designed to be extended

$object = new mytable(); $object->ID=123; echo $object->delete(); // builds a conditon

$object = new mytable(); $object->whereAdd('age > 12'); $object->limit(1); $object->orderBy('age DESC'); $object->delete(true); // dont use object vars, use the conditions, limit and order.

Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values

Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.

Create an attribute for this specific field. We only do this for strings and text

Get the size and maxLength attributes for this text field.

(or for all text fields) in the DAO object.

Check if there is a record with the same name in the db.

Check if there is a given column in a specific table.

Scans all the tables using a slow query and table name.

Get the name of the CiviCRM database.

Checks if a constraint exists for a specified table.

Checks if CONSTRAINT keyword exists for a specified table.

Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.

Check whether a specific column in a specific table has always the same value.

Check whether a specific column in a specific table is always NULL.

Check if there is a given table in the database.

Find a DAO object for the given ID and return it.

Returns all results as array-encoded records.

Get all the result records as mapping between columns.

Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record

Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record

Get sort string.

Fetch object based on array of properties.

Delete the object records that are associated with this contact.

Execute an unbuffered query.

This is a wrapper around new functionality exposed with CRM-17748.

Execute a query.

Execute a query and get the single result.

Compose the query by merging the parameters into it.

make a shallow copy of an object.

and all the fields in the object

Cascade update through related entities.

Given the component id, compute the contact id since its used for things like send email

Fetch object based on array of properties.

Escape a list of strings for use with "WHERE X IN (.

..)" queries.

Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING

Deletes the this object plus any dependent objects that are associated with it.

ONLY USE FOR TESTING

Set defaults when creating new entity.

(don't call this set defaults as already in use with different signature in some places)

Build a list of triggers via hook and add them to (err, reconcile them with) the database.

Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests

Wrapper function to drop triggers.

Given a list of fields, create a list of references.

Find all records which refer to this entity.

List all tables which have hard foreign keys to this table.

For now, this returns a description of every entity_id/entity_table reference. TODO: filter dynamic entity references on the $tableName, based on schema metadata in dynamicForeignKey which enumerates a restricted set of possible entity_table's.

Lookup the value of a MySQL global configuration variable.

Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.

This is relevant where we want to offer both the ID field and the label field as an option, e.g. search builder.

It is currently limited for optionGroupName for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.

Get options for the called BAO object's field.

This function can be overridden by each BAO to add more logic related to context. The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get

Populate option labels for this object's fields.

Provides documentation and validation for the buildOptions $context param

Get SQL where clause for SQL filter syntax input parameters.

SQL version of api function to assign filters to the DAO based on the syntax $field => array('IN' => array(4,6,9)) OR $field => array('LIKE' => array('%me%)) etc

SQL has a limit of 64 characters on various names: table name, trigger name, column name .

..

For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.

https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query

https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level

Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity

Return format is in the form of fieldname => clauses starting with an operator. e.g.:

This returns the final permissioned query string for this entity

With acls from related entities + additional clauses from hook_civicrm_selectWhereClause

ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.

Return a mapping from field-name to the corresponding key (as used in fields()).

Returns if this table needs to be logged

Returns the list of fields that can be imported

Returns the list of fields that can be exported

Returns the list of indices

note that $job_id is used only as a variable in the temp table construction and does not play a role in the queries generated.

Returns an array that denotes the type of token that we are dealing with we use the type later on when we are doing a token replacement lookup

Retrieve a ref to an array that holds the email and text templates for this email assembles the complete template including the header and footer that the user has uploaded or declared (if they have done that)

Retrieve a ref to an array that holds all of the tokens in the email body where the keys are the type of token and the values are ordinal arrays that hold the token names (even repeated tokens) in the order in which they appear in the body of the email.

note: the real work is done in the _getTokens() function

this function needs to have some sort of a body assigned either text or html for this to have any meaningful impact

Returns the token set for all 3 parts as one set. This allows it to be sent to the hook in one call and standardizes it across other token workflows

Generate an event queue for a test job.

Given and array of headers and a prefix, job ID, event queue ID, and hash, add a Message-ID header if needed.

i.e. if the global includeMessageId is set and there isn't already a Message-ID in the array. The message ID is structured the same way as a verp. However no interpretation is placed on the values received, so they do not need to follow the verp convention.

Static wrapper for getting verp and urls.

Get verp, urls and headers

Compose a message.

Replace tokens.

Get mailing object and replaces subscribeInvite, domain and mailing tokens.

Return a list of group names for this mailing. Does not work with prior-mailing targets.

Add the mailings.

Construct a new mailing object, along with job and mailing_group objects, from the form values of the create mailing wizard.

This function is a bit evil. It not only merges $params and saves the mailing -- it also schedules the mailing and chooses the recipients. Since it merges $params, it's also the only place to correctly trigger multi-field validation. It should be broken up.

In the mean time, use-cases which break under the weight of this evil may find reprieve in these extra evil params:

• skip_evil_bao_auto_recipients: bool
• skip_evil_bao_auto_schedule: bool
• evil_bao_validator: string|callable

Replace the list of recipients on a given mailing.

Get hash value of the mailing.

Generate a report. Fetch event count information, mailing data, and job status.

Get the count of mailings.

Returns all the mailings that this user can access. This is dependent on all the groups that the user has access to.

However since most civi installs dont use ACL's we special case the condition where the user has access to ALL groups, and hence ALL mailings and return a value of TRUE (to avoid the downstream where clause with a list of mailing list IDs

Get the rows for a browse operation.

Show detail Mailing report.

Delete Mails and all its associated records.

Delete Jobss and all its associated records related to test Mailings

Build the compose mail form.

Get the search based mailing Ids.

Get the content/components of mailing based on mailing Id

wrapper for ajax activity selector.

Retrieve contact mailing.

Retrieve contact mailing count.

Get a list of permissions required for CRUD'ing each field (when workflow is enabled).

White-list of possible values for the entity_table field.

Get the public view url.

Get a list of template types which can be used as civicrm_mailing.template_type.

Get a list of template types.