class CRM_Event_BAO_Event extends CRM_Event_DAO_Event

Constants

NOT_NULL

IS_NULL

DB_DAO_NOTNULL

VALUE_SEPARATOR

BULK_INSERT_COUNT

BULK_INSERT_HIGH_COUNT

QUERY_FORMAT_WILDCARD

QUERY_FORMAT_NO_QUOTES

Properties

static null $_nullObject from CRM_Core_DAO
static array $_nullArray from CRM_Core_DAO
static $_dbColumnValueCache from CRM_Core_DAO
static array $_testEntitiesToSkip Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted from CRM_Core_DAO
static object $_factory The factory class for this application. from CRM_Core_DAO
static $_checkedSqlFunctionsExist from CRM_Core_DAO
protected $_options https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings from CRM_Core_DAO
static string $_tableName Static instance to hold the table name. from CRM_Event_DAO_Event
static boolean $_log Should CiviCRM log any modifications to this table in the civicrm_log table. from CRM_Event_DAO_Event
int $id Event from CRM_Event_DAO_Event
string $title Event Title (e.g. Fall Fundraiser Dinner) from CRM_Event_DAO_Event
text $summary Brief summary of event. Text and html allowed. Displayed on Event Registration form and can be used on other CMS pages which need an event summary. from CRM_Event_DAO_Event
text $description Full description of event. Text and html allowed. Displayed on built-in Event Information screens. from CRM_Event_DAO_Event
int $event_type_id Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type. from CRM_Event_DAO_Event
int $participant_listing_id Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing. from CRM_Event_DAO_Event
boolean $is_public Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs. from CRM_Event_DAO_Event
datetime $start_date Date and time that event starts. from CRM_Event_DAO_Event
datetime $end_date Date and time that event ends. May be NULL if no defined end date/time from CRM_Event_DAO_Event
boolean $is_online_registration If true, include registration link on Event Info page. from CRM_Event_DAO_Event
$registration_link_text Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true. from CRM_Event_DAO_Event
datetime $registration_start_date Date and time that online registration starts. from CRM_Event_DAO_Event
datetime $registration_end_date Date and time that online registration ends. from CRM_Event_DAO_Event
int $max_participants Maximum number of registered participants to allow. After max is reached, a custom Event Full message is displayed. If NULL, allow unlimited number of participants. from CRM_Event_DAO_Event
text $event_full_text Message to display on Event Information page and INSTEAD OF Event Registration form if maximum participants are signed up. Can include email address/info about getting on a waiting list, etc. Text and html allowed. from CRM_Event_DAO_Event
boolean $is_monetary If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration. from CRM_Event_DAO_Event
int $financial_type_id Financial type assigned to paid event registrations for this event. Required if is_monetary is true. from CRM_Event_DAO_Event
string $payment_processor Payment Processors configured for this Event (if is_monetary is true) from CRM_Event_DAO_Event
boolean $is_map Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified? from CRM_Event_DAO_Event
boolean $is_active Is this Event enabled or disabled/cancelled? from CRM_Event_DAO_Event
string $fee_label from CRM_Event_DAO_Event
boolean $is_show_location If true, show event location. from CRM_Event_DAO_Event
int $loc_block_id FK to Location Block ID from CRM_Event_DAO_Event
int $default_role_id Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role. from CRM_Event_DAO_Event
text $intro_text Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form. from CRM_Event_DAO_Event
$footer_text Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form. from CRM_Event_DAO_Event
string $confirm_title Title for Confirmation page. from CRM_Event_DAO_Event
text $confirm_text Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form. from CRM_Event_DAO_Event
$confirm_footer_text Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form. from CRM_Event_DAO_Event
boolean $is_email_confirm If true, confirmation is automatically emailed to contact on successful registration. from CRM_Event_DAO_Event
text $confirm_email_text text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now from CRM_Event_DAO_Event
string $confirm_from_name FROM email name used for confirmation emails. from CRM_Event_DAO_Event
string $confirm_from_email FROM email address used for confirmation emails. from CRM_Event_DAO_Event
string $cc_confirm comma-separated list of email addresses to cc each time a confirmation is sent from CRM_Event_DAO_Event
string $bcc_confirm comma-separated list of email addresses to bcc each time a confirmation is sent from CRM_Event_DAO_Event
int $default_fee_id FK to civicrm_option_value. from CRM_Event_DAO_Event
int $default_discount_fee_id FK to civicrm_option_value. from CRM_Event_DAO_Event
string $thankyou_title Title for ThankYou page. from CRM_Event_DAO_Event
text $thankyou_text ThankYou Text. from CRM_Event_DAO_Event
$thankyou_footer_text Footer message. from CRM_Event_DAO_Event
boolean $is_pay_later if true - allows the user to send payment directly to the org later from CRM_Event_DAO_Event
text $pay_later_text The text displayed to the user in the main form from CRM_Event_DAO_Event
text $pay_later_receipt The receipt sent to the user instead of the normal receipt text from CRM_Event_DAO_Event
boolean $is_partial_payment is partial payment enabled for this event from CRM_Event_DAO_Event
string $initial_amount_label Initial amount label for partial payment from CRM_Event_DAO_Event
text $initial_amount_help_text Initial amount help text for partial payment from CRM_Event_DAO_Event
float $min_initial_amount Minimum initial amount for partial payment from CRM_Event_DAO_Event
boolean $is_multiple_registrations if true - allows the user to register multiple participants for event from CRM_Event_DAO_Event
int $max_additional_participants Maximum number of additional participants that can be registered on a single booking from CRM_Event_DAO_Event
boolean $allow_same_participant_emails if true - allows the user to register multiple registrations from same email address. from CRM_Event_DAO_Event
boolean $has_waitlist Whether the event has waitlist support. from CRM_Event_DAO_Event
boolean $requires_approval Whether participants require approval before they can finish registering. from CRM_Event_DAO_Event
int $expiration_time Expire pending but unconfirmed registrations after this many hours. from CRM_Event_DAO_Event
boolean $allow_selfcancelxfer Allow self service cancellation or transfer for event? from CRM_Event_DAO_Event
int $selfcancelxfer_time Number of hours prior to event start date to allow self-service cancellation or transfer. from CRM_Event_DAO_Event
text $waitlist_text Text to display when the event is full, but participants can signup for a waitlist. from CRM_Event_DAO_Event
text $approval_req_text Text to display when the approval is required to complete registration for an event. from CRM_Event_DAO_Event
boolean $is_template whether the event has template from CRM_Event_DAO_Event
string $template_title Event Template Title from CRM_Event_DAO_Event
int $created_id FK to civicrm_contact, who created this event from CRM_Event_DAO_Event
datetime $created_date Date and time that event was created. from CRM_Event_DAO_Event
string $currency 3 character string, value from config setting or input via user. from CRM_Event_DAO_Event
int $campaign_id The campaign for which this event has been created. from CRM_Event_DAO_Event
boolean $is_share Can people share the event through social media? from CRM_Event_DAO_Event
boolean $is_confirm_enabled If false, the event booking confirmation screen gets skipped from CRM_Event_DAO_Event
int $parent_event_id Implicit FK to civicrm_event: parent event from CRM_Event_DAO_Event
int $slot_label_id Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot. from CRM_Event_DAO_Event
int $dedupe_rule_group_id Rule to use when matching registrations for this event from CRM_Event_DAO_Event
boolean $is_billing_required if true than billing block is required this event from CRM_Event_DAO_Event

Methods

__construct()

Class constructor.

static 
getTableName()

Returns the names of this table

static 
init(string $dsn)

Initialize the DAO object.

static DB_common
getConnection()

No description

assignTestFK(string $fieldName, $fieldDef, array $params)

No description

assignTestValue(string $fieldName, array $fieldDef, int $counter)

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

reset()

Reset the DAO object.

static string
getLocaleTableName(string $tableName)

No description

object
query(string $query, bool $i18nRewrite = TRUE)

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

static 
setFactory(object $factory)

Static function to set the factory instance for this class.

factory(string $table = '')

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

initialize()

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

array
keys()

Defines the default key as 'id'.

array
sequenceKey()

Tells DB_DataObject which keys use autoincrement.

static array
getReferenceColumns()

Returns foreign keys and entity references.

static array
fields()

Returns all the column names of this table

array
table()

Get/set an associative array of table columns

save(bool $hook = TRUE)

Save DAO object.

delete(bool $useWhere = FALSE)

Deletes items from table which match current objects variables.

log(bool $created = FALSE)

No description

bool
copyValues(array $params)

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

static 
storeValues(object $object, array $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.

static array|null
makeAttribute(array $field)

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

static array
getAttribute(string $class, string $fieldName = NULL)

Get the size and maxLength attributes for this text field.

static 
transaction($type)

No description

static bool
objectExists(string $value, string $daoName, string $daoID, string $fieldName = 'name', string $domainID = NULL)

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

static bool
checkFieldExists(string $tableName, string $columnName, bool $i18nRewrite = TRUE)

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

static array
getTableNames()

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

static bool
isDBMyISAM(int $maxTablesToCheck = 10)

No description

static string
getDatabaseName()

Get the name of the CiviCRM database.

static bool
checkConstraintExists(string $tableName, string $constraint)

Checks if a constraint exists for a specified table.

static bool
schemaRequiresRebuilding(array $tables = array("civicrm_contact"))

Checks if CONSTRAINT keyword exists for a specified table.

static bool
checkFKConstraintInFormat(string $tableName, string $columnName)

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

static bool
checkFieldHasAlwaysValue(string $tableName, string $columnName, string $columnValue)

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

static bool
checkFieldIsAlwaysNull(string $tableName, string $columnName)

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

static bool
checkTableExists(string $tableName)

Check if there is a given table in the database.

bool
checkVersion($version)

No description

static object
findById(int $id)

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

array
fetchAll()

Returns all results as array-encoded records.

array
fetchMap(string $keyColumn, string $valueColumn)

Get all the result records as mapping between columns.

static string|null
getFieldValue(string $daoName, int $searchValue, string $returnColumn = 'name', string $searchColumn = 'id', bool $force = FALSE)

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

static bool
setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue, string $searchColumn = 'id')

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

static string
getSortString(array|object $sort, string $default = NULL)

Get sort string.

static object
commonRetrieve(string $daoName, array $params, array $defaults, array $returnProperities = NULL)

Fetch object based on array of properties.

static 
deleteEntityContact(string $daoName, int $contactId)

Delete the object records that are associated with this contact.

static CRM_Core_DAO
executeUnbufferedQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)

Execute an unbuffered query.

static CRM_Core_DAO|object
executeQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)

Execute a query.

static string|null
singleValueQuery(string $query, array $params = array(), bool $abort = TRUE, bool $i18nRewrite = TRUE)

Execute a query and get the single result.

static string
composeQuery(string $query, array $params, bool $abort = TRUE)

Compose the query by merging the parameters into it.

static 
freeResult(null $ids = NULL)

No description

static CRM_Core_DAO
copyGeneric(string $daoName, array $criteria, array $newData = NULL, string $fieldsFix = NULL, string $blockCopyOfDependencies = NULL)

make a shallow copy of an object.

static CRM_Core_DAO|null
cascadeUpdate(string $daoName, $fromId, $toId, array $newData = array())

Cascade update through related entities.

static array
getContactIDsFromComponent($componentIDs, string $tableName)

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

static object
commonRetrieveAll(string $daoName, string $fieldIdName = 'id', int $fieldId, $details, array $returnProperities = NULL)

Fetch object based on array of properties.

static 
dropAllTables()

No description

static string
escapeString($string)

No description

static string
escapeStrings(array $strings, string $default = NULL)

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

static string
escapeWildCardString($string)

No description

static object|array|NULL
createTestObject(string $daoName, array $params = array(), int $numObjects = 1, bool $createOnly = FALSE)

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

static 
deleteTestObjects(string $daoName, array $params = array())

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

static 
setCreateDefaults(array $params, $defaults)

Set defaults when creating new entity.

static string
createTempTableName(string $prefix = 'civicrm', bool $addRandomString = TRUE, null $string = NULL)

No description

static bool
checkTriggerViewPermission(bool $view = TRUE, bool $trigger = TRUE)

No description

static 
debugPrint(null $message = NULL, bool $printDAO = TRUE)

No description

static 
triggerRebuild(string $tableName = NULL, bool $force = FALSE) deprecated

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

static 
checkSqlFunctionsExist()

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

static 
dropTriggers(string $tableName = NULL) deprecated

Wrapper function to drop triggers.

static 
createTriggers(array $info, string $onlyTableName = NULL) deprecated

No description

static array
createReferenceColumns(string $className)

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

array
findReferences()

Find all records which refer to this entity.

array
getReferenceCounts()

No description

static array
getReferencesToTable(string $tableName)

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

static mixed
getGlobalSetting(string $name, mixed $default = NULL)

Lookup the value of a MySQL global configuration variable.

static 
appendPseudoConstantsToFields(array $fields)

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

static array|bool
buildOptions(string $fieldName, string $context = NULL, array $props = array())

Get options for a given field.

getOptionLabels()

Populate option labels for this object's fields.

static array
buildOptionsContext(string $context = NULL)

Provides documentation and validation for the buildOptions $context param

bool|array
getFieldSpec(string $fieldName)

No description

static NULL|string|array
createSQLFilter(string $fieldName, array $filter, string $type = NULL, string $alias = NULL, bool $returnSanitisedArray = FALSE)

Get SQL where clause for SQL filter syntax input parameters.

static array
acceptedSQLOperators()

No description

static string
shortenSQLName(string $string, int $length = 60, bool $makeRandom = FALSE)

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

setOptions(array $options)

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

_setDBOptions(array $options)

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

setApiFilter(array $params) deprecated

No description

array
addSelectWhereClause()

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

static array
getSelectWhereClause(string $tableAlias = NULL)

This returns the final permissioned query string for this entity

static bool
requireSafeDBName($database)

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

static array
fieldKeys()

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

boolean
getLog()

Returns if this table needs to be logged

static array
import(bool $prefix = false)

Returns the list of fields that can be imported

static array
export(bool $prefix = false)

Returns the list of fields that can be exported

static 
indices($localize = TRUE)

Returns the list of indices

retrieve(array $params, array $defaults)

Fetch object based on array of properties.

static Object
setIsActive(int $id, bool $is_active)

Update the is_active flag in the db.

add(array $params)

Add the event.

static object
create(array $params)

Create the event.

static mixed|null
del(int $id)

Delete the event.

static 
deleteEventLocBlock(int $locBlockId, int $eventId = NULL)

Delete the location block associated with an event.

static array
getEvents(int $all, int|array $id = NULL, bool $isActive = TRUE, bool $checkPermission = TRUE, bool $titleOnly = FALSE)

Get current/future Events.

static array
getEventSummary()

Get events Summary.

static array
getParticipantCount(int $eventId, bool $considerStatus = TRUE, bool $status = TRUE, bool $considerRole = TRUE, bool $role = TRUE)

Get participant count.

static null|string
getMapInfo(int $id)

Get the information to map a event.

static array
getCompleteInfo(date $start = NULL, int $type = NULL, int $eventId = NULL, date $end = NULL, bool $onlyPublic = TRUE)

Get the complete information for one or more events.

copy(int $id, null $newEvent = NULL, bool $afterCreate = FALSE)

Make a copy of a Event.

static 
copyCustomFields(int $oldEventID, int $newCopyID)

Method that copies custom fields values from an old event to a new one. Fixes bug CRM-19302, where if a custom field of File type was present, left both events using the same file, breaking download URL's for the old event.

static bool
isMonetary(int $id)

This is sometimes called in a loop (during event search).

static bool
usesPriceSet(int $id)

This is sometimes called in a loop (during event search).

static 
sendMail(int $contactID, array $values, int $participantId, bool $isTest = FALSE, bool $returnMessageText = FALSE)

Send e-mails.

static array|null
buildCustomDisplay(int $id, string $name, int $cid, string $template, int $participantId, bool $isTest, bool $isCustomProfile = FALSE, array $participantParams = array())

Add the custom fields OR array of participant's profile info.

static 
displayProfile(array $params, int $gid, array $groupTitle, array $values, array $profileFields = array())

Build the array for display the profile fields.

static array
buildCustomProfile(int $participantId, array $values, int $contactId = NULL, bool $isTest = FALSE, bool $isIdsArray = FALSE, bool $skipCancel = TRUE)

Build the array for Additional participant's information array of primary and additional Ids.

static array
getLocationEvents()

Retrieve all event addresses.

static int|null|string
countEventsUsingLocBlockId(int $locBlockId)

No description

static bool
validRegistrationRequest(array $values, int $eventID)

Check if event registration is valid according to permissions AND Dates.

static bool
validRegistrationDate($values)

No description

static bool
showHideRegistrationLink($values)

No description

static bool
checkRegistration(array $params)

No description

static string
checkPermission(int $eventId = NULL, int $type = CRM_Core_Permission::VIEW)

Make sure that the user has permission to access this event.

static array
getFromEmailIds(int $eventId = NULL)

Build From Email as the combination of all the email ids of the logged in user, the domain email id and the email id configured for the event

static int
eventTotalSeats(int $eventId, sting $extraWhereClause = NULL)

Calculate event total seats occupied.

static array
getTemplateDefaultValues(int $templateId)

Retrieve event template default values to be set.

static object
get_sub_events(int $event_id)

No description

static 
updateParticipantCampaignID(int $eventID, int $eventCampaignID)

Update the Campaign Id of all the participants of the given event.

Details

at line 38
CRM_Core_DAO __construct()

Class constructor.

Return Value

CRM_Core_DAO

in CRM_Event_DAO_Event at line 1541
static getTableName()

Returns the names of this table

in CRM_Core_DAO at line 112
static init(string $dsn)

Initialize the DAO object.

Parameters

string $dsn The database connection string.

in CRM_Core_DAO at line 131
static DB_common getConnection()

Return Value

DB_common

in CRM_Core_DAO at line 142
protected assignTestFK(string $fieldName, $fieldDef, array $params)

Parameters

string $fieldName
$fieldDef
array $params

in CRM_Core_DAO at line 191
protected assignTestValue(string $fieldName, array $fieldDef, int $counter)

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

Parameters

string $fieldName
array $fieldDef
int $counter The globally-unique ID of the test object.

in CRM_Core_DAO at line 303
reset()

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

in CRM_Core_DAO at line 323
static string getLocaleTableName(string $tableName)

Parameters

string $tableName

Return Value

string

in CRM_Core_DAO at line 345
object query(string $query, bool $i18nRewrite = TRUE)

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

Parameters

string $query The SQL query for execution.
bool $i18nRewrite Whether to rewrite the query.

Return Value

object the current DAO object after the query execution

in CRM_Core_DAO at line 374
static setFactory(object $factory)

Static function to set the factory instance for this class.

Parameters

object $factory The factory application object.

in CRM_Core_DAO at line 383
factory(string $table = '')

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

Parameters

string $table

in CRM_Core_DAO at line 395
initialize()

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

in CRM_Core_DAO at line 411
array keys()

Defines the default key as 'id'.

Return Value

array

in CRM_Core_DAO at line 426
array sequenceKey()

Tells DB_DataObject which keys use autoincrement.

'id' is autoincrementing by default.

Return Value

array

in CRM_Event_DAO_Event at line 479
static array getReferenceColumns()

Returns foreign keys and entity references.

Return Value

array Array of CRM_Core_Reference_Interface

in CRM_Event_DAO_Event at line 495
static array fields()

Returns all the column names of this table

Return Value

array

in CRM_Core_DAO at line 462
array table()

Get/set an associative array of table columns

Return Value

array (associative)

in CRM_Core_DAO at line 485
CRM_Core_DAO save(bool $hook = TRUE)

Save DAO object.

Parameters

bool $hook

Return Value

CRM_Core_DAO

in CRM_Core_DAO at line 536
delete(bool $useWhere = FALSE)

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.

Parameters

bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then we will build the condition only using the whereAdd's. Default is to build the condition only using the object parameters.

* @return mixed Int (No. of rows affected) on success, false on failure, 0 on no data affected

in CRM_Core_DAO at line 552
log(bool $created = FALSE)

Parameters

bool $created

in CRM_Core_DAO at line 587
bool copyValues(array $params)

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

Parameters

array $params (reference ) associative array of name/value pairs.

Return Value

bool Did we copy all null values into the object

in CRM_Core_DAO at line 628
static storeValues(object $object, array $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.

Parameters

object $object The object that we are extracting data from.
array $values (reference ) associative array of name/value pairs.

in CRM_Core_DAO at line 650
static array|null makeAttribute(array $field)

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

Parameters

array $field The field under task.

Return Value

array|null the attributes for the object

in CRM_Core_DAO at line 703
static array getAttribute(string $class, string $fieldName = NULL)

Get the size and maxLength attributes for this text field.

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

Parameters

string $class Name of DAO class.
string $fieldName Field that i'm interested in or null if. you want the attributes for all DAO text fields

Return Value

array assoc array of name => attribute pairs

in CRM_Core_DAO at line 731
static transaction($type)

Parameters

$type

Exceptions

Exception

in CRM_Core_DAO at line 754
static bool objectExists(string $value, string $daoName, string $daoID, string $fieldName = 'name', string $domainID = NULL)

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

Parameters

string $value The value of the field we are checking.
string $daoName The dao object name.
string $daoID The id of the object being updated. u can change your name. as long as there is no conflict
string $fieldName The name of the field in the DAO.
string $domainID The id of the domain. Object exists only for the given domain.

Return Value

bool true if object exists

in CRM_Core_DAO at line 780
static bool checkFieldExists(string $tableName, string $columnName, bool $i18nRewrite = TRUE)

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

Parameters

string $tableName
string $columnName
bool $i18nRewrite Whether to rewrite the query on multilingual setups.

Return Value

bool true if exists, else false

in CRM_Core_DAO at line 798
static array getTableNames()

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

Return Value

array

in CRM_Core_DAO at line 820
static bool isDBMyISAM(int $maxTablesToCheck = 10)

Parameters

int $maxTablesToCheck

Return Value

bool

in CRM_Core_DAO at line 837
static string getDatabaseName()

Get the name of the CiviCRM database.

Return Value

string

in CRM_Core_DAO at line 851
static bool checkConstraintExists(string $tableName, string $constraint)

Checks if a constraint exists for a specified table.

Parameters

string $tableName
string $constraint

Return Value

bool true if constraint exists, false otherwise

in CRM_Core_DAO at line 879
static bool schemaRequiresRebuilding(array $tables = array("civicrm_contact"))

Checks if CONSTRAINT keyword exists for a specified table.

Parameters

array $tables

Return Value

bool true if CONSTRAINT keyword exists, false otherwise

Exceptions

Exception

in CRM_Core_DAO at line 915
static bool checkFKConstraintInFormat(string $tableName, string $columnName)

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

Parameters

string $tableName
string $columnName

Return Value

bool true if in format, false otherwise

in CRM_Core_DAO at line 944
static bool checkFieldHasAlwaysValue(string $tableName, string $columnName, string $columnValue)

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

Parameters

string $tableName
string $columnName
string $columnValue

Return Value

bool true if the value is always $columnValue, false otherwise

in CRM_Core_DAO at line 961
static bool checkFieldIsAlwaysNull(string $tableName, string $columnName)

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

Parameters

string $tableName
string $columnName

Return Value

bool true if if the value is always NULL, false otherwise

in CRM_Core_DAO at line 977
static bool checkTableExists(string $tableName)

Check if there is a given table in the database.

Parameters

string $tableName

Return Value

bool true if exists, else false

in CRM_Core_DAO at line 995
bool checkVersion($version)

Parameters

$version

Return Value

bool

in CRM_Core_DAO at line 1013
static object findById(int $id)

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

Parameters

int $id Id of the DAO object being searched for.

Return Value

object Object of the type of the class that called this function.

in CRM_Core_DAO at line 1027
array fetchAll()

Returns all results as array-encoded records.

Return Value

array

in CRM_Core_DAO at line 1045
array fetchMap(string $keyColumn, string $valueColumn)

Get all the result records as mapping between columns.

Parameters

string $keyColumn Ex: "name"
string $valueColumn Ex: "label"

Return Value

array Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]

in CRM_Core_DAO at line 1070
static string|null getFieldValue(string $daoName, int $searchValue, string $returnColumn = 'name', string $searchColumn = 'id', bool $force = FALSE)

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

Parameters

string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
int $searchValue Value of the column you want to search by.
string $returnColumn Name of the column you want to GET the value of.
string $searchColumn Name of the column you want to search by.
bool $force Skip use of the cache.

Return Value

string|null Value of $returnColumn in the retrieved record

in CRM_Core_DAO at line 1120
static bool setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue, string $searchColumn = 'id')

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

Parameters

string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
int $searchValue Value of the column you want to search by.
string $setColumn Name of the column you want to SET the value of.
string $setValue SET the setColumn to this value.
string $searchColumn Name of the column you want to search by.

Return Value

bool true if we found and updated the object, else false

in CRM_Core_DAO at line 1146
static string getSortString(array|object $sort, string $default = NULL)

Get sort string.

Parameters

array|object $sort either array or CRM_Utils_Sort
string $default Default sort value.

Return Value

string sortString

in CRM_Core_DAO at line 1177
static object commonRetrieve(string $daoName, array $params, array $defaults, array $returnProperities = NULL)

Fetch object based on array of properties.

Parameters

string $daoName Name of the dao object.
array $params (reference ) an assoc array of name/value pairs.
array $defaults (reference ) an assoc array to hold the flattened values.
array $returnProperities An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').

Return Value

object an object of type referenced by daoName

in CRM_Core_DAO at line 1202
static deleteEntityContact(string $daoName, int $contactId)

Delete the object records that are associated with this contact.

Parameters

string $daoName Name of the dao object.
int $contactId Id of the contact to delete.

in CRM_Core_DAO at line 1227
static CRM_Core_DAO executeUnbufferedQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)

Execute an unbuffered query.

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

Parameters

string $query query to be executed
array $params
bool $abort
null $daoName
bool $freeDAO
bool $i18nRewrite
bool $trapException

Return Value

CRM_Core_DAO Object that points to an unbuffered result set

in CRM_Core_DAO at line 1293
static CRM_Core_DAO|object executeQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)

Execute a query.

Parameters

string $query Query to be executed.
array $params
bool $abort
null $daoName
bool $freeDAO
bool $i18nRewrite
bool $trapException

Return Value

CRM_Core_DAO|object object that holds the results of the query NB - if this is defined as just returning a DAO phpstorm keeps pointing out all the properties that are not part of the DAO

in CRM_Core_DAO at line 1343
static string|null singleValueQuery(string $query, array $params = array(), bool $abort = TRUE, bool $i18nRewrite = TRUE)

Execute a query and get the single result.

Parameters

string $query Query to be executed.
array $params
bool $abort
bool $i18nRewrite

Return Value

string|null the result of the query if any

in CRM_Core_DAO at line 1381
static string composeQuery(string $query, array $params, bool $abort = TRUE)

Compose the query by merging the parameters into it.

Parameters

string $query
array $params
bool $abort

Return Value

string

Exceptions

Exception

in CRM_Core_DAO at line 1428
static freeResult(null $ids = NULL)

Parameters

null $ids

in CRM_Core_DAO at line 1474
static CRM_Core_DAO copyGeneric(string $daoName, array $criteria, array $newData = NULL, string $fieldsFix = NULL, string $blockCopyOfDependencies = NULL)

make a shallow copy of an object.

and all the fields in the object

Parameters

string $daoName Name of the dao.
array $criteria Array of all the fields & values. on which basis to copy
array $newData Array of all the fields & values. to be copied besides the other fields
string $fieldsFix Array of fields that you want to prefix/suffix/replace.
string $blockCopyOfDependencies Fields that you want to block from. getting copied

Return Value

CRM_Core_DAO the newly created copy of the object

in CRM_Core_DAO at line 1557
static CRM_Core_DAO|null cascadeUpdate(string $daoName, $fromId, $toId, array $newData = array())

Cascade update through related entities.

Parameters

string $daoName
$fromId
$toId
array $newData

Return Value

CRM_Core_DAO|null

in CRM_Core_DAO at line 1601
static array getContactIDsFromComponent($componentIDs, string $tableName)

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

Parameters

$componentIDs
string $tableName

Return Value

array

in CRM_Core_DAO at line 1636
static object commonRetrieveAll(string $daoName, string $fieldIdName = 'id', int $fieldId, $details, array $returnProperities = NULL)

Fetch object based on array of properties.

Parameters

string $daoName Name of the dao object.
string $fieldIdName
int $fieldId
$details
array $returnProperities An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').

Return Value

object an object of type referenced by daoName

in CRM_Core_DAO at line 1658
static dropAllTables()

in CRM_Core_DAO at line 1680
static string escapeString($string)

Parameters

$string

Return Value

string

in CRM_Core_DAO at line 1709
static string escapeStrings(array $strings, string $default = NULL)

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

..)" queries.

Parameters

array $strings
string $default the value to use if $strings has no elements.

Return Value

string eg "abc","def","ghi"

in CRM_Core_DAO at line 1728
static string escapeWildCardString($string)

Parameters

$string

Return Value

string

in CRM_Core_DAO at line 1756
static object|array|NULL createTestObject(string $daoName, array $params = array(), int $numObjects = 1, bool $createOnly = FALSE)

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

Parameters

string $daoName
array $params
int $numObjects
bool $createOnly

Return Value

object|array|NULL NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.

in CRM_Core_DAO at line 1839
static deleteTestObjects(string $daoName, array $params = array())

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

ONLY USE FOR TESTING

Parameters

string $daoName
array $params

in CRM_Core_DAO at line 1885
static setCreateDefaults(array $params, $defaults)

Set defaults when creating new entity.

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

Parameters

array $params
$defaults

in CRM_Core_DAO at line 1903
static string createTempTableName(string $prefix = 'civicrm', bool $addRandomString = TRUE, null $string = NULL)

Parameters

string $prefix
bool $addRandomString
null $string

Return Value

string

in CRM_Core_DAO at line 1923
static bool checkTriggerViewPermission(bool $view = TRUE, bool $trigger = TRUE)

Parameters

bool $view
bool $trigger

Return Value

bool

in CRM_Core_DAO at line 1971
static debugPrint(null $message = NULL, bool $printDAO = TRUE)

Parameters

null $message
bool $printDAO

in CRM_Core_DAO at line 1995
static triggerRebuild(string $tableName = NULL, bool $force = FALSE) deprecated

deprecated

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

Parameters

string $tableName the specific table requiring a rebuild; or NULL to rebuild all tables.
bool $force

See also

CRM-9716

in CRM_Core_DAO at line 2006
static checkSqlFunctionsExist()

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

See also

http://issues.civicrm.org/jira/browse/CRM-13822 TODO: Alternative solutions might be * Stop using functions and find another way to strip numeric characters from phones * Give better error messages (currently a missing fn fatals with "unknown error")

in CRM_Core_DAO at line 2023
static dropTriggers(string $tableName = NULL) deprecated

deprecated

Wrapper function to drop triggers.

Parameters

string $tableName the specific table requiring a rebuild; or NULL to rebuild all tables.

in CRM_Core_DAO at line 2034
static createTriggers(array $info, string $onlyTableName = NULL) deprecated

deprecated

Parameters

array $info per hook_civicrm_triggerInfo.
string $onlyTableName the specific table requiring a rebuild; or NULL to rebuild all tables.

in CRM_Core_DAO at line 2045
static array createReferenceColumns(string $className)

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

Parameters

string $className BAO/DAO class name.

Return Value

array

in CRM_Core_DAO at line 2068
array findReferences()

Find all records which refer to this entity.

Return Value

array Array of objects referencing this

in CRM_Core_DAO at line 2097
array getReferenceCounts()

Return Value

array each item has keys: - name: string - type: string - count: int - table: string|null SQL table name - key: string|null SQL column name

in CRM_Core_DAO at line 2134
static array getReferencesToTable(string $tableName)

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.

Parameters

string $tableName Table referred to.

Return Value

array structure of table and column, listing every table with a foreign key reference to $tableName, and the column where the key appears.

in CRM_Core_DAO at line 2158
static mixed getGlobalSetting(string $name, mixed $default = NULL)

Lookup the value of a MySQL global configuration variable.

Parameters

string $name E.g. "thread_stack".
mixed $default

Return Value

mixed

in CRM_Core_DAO at line 2183
static protected appendPseudoConstantsToFields(array $fields)

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.

Parameters

array $fields

at line 2273
static array|bool buildOptions(string $fieldName, string $context = NULL, array $props = array())

Get options for a given field.

Parameters

string $fieldName
string $context
array $props whatever is known about this bao object.

Return Value

array|bool

See also

CRM_Core_DAO::buildOptions

in CRM_Core_DAO at line 2220
getOptionLabels()

Populate option labels for this object's fields.

Exceptions

exception if called directly on the base class

in CRM_Core_DAO at line 2246
static array buildOptionsContext(string $context = NULL)

Provides documentation and validation for the buildOptions $context param

Parameters

string $context

Return Value

array

Exceptions

Exception

in CRM_Core_DAO at line 2266
bool|array getFieldSpec(string $fieldName)

Parameters

string $fieldName

Return Value

bool|array

in CRM_Core_DAO at line 2309
static NULL|string|array createSQLFilter(string $fieldName, array $filter, string $type = NULL, string $alias = NULL, bool $returnSanitisedArray = FALSE)

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

Parameters

string $fieldName Name of fields.
array $filter filter to be applied indexed by operator.
string $type type of field (not actually used - nor in api @todo ).
string $alias alternative field name ('as') @todo- not actually used.
bool $returnSanitisedArray Return a sanitised array instead of a clause. this is primarily so we can add filters @ the api level to the Query object based fields

Return Value

NULL|string|array a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL depending on whether it is supported as yet

Exceptions

Exception

in CRM_Core_DAO at line 2372
static array acceptedSQLOperators()

Return Value

array

See also

http://issues.civicrm.org/jira/browse/CRM-9150 support for other syntaxes is discussed in ticket but being put off for now

in CRM_Core_DAO at line 2409
static string shortenSQLName(string $string, int $length = 60, bool $makeRandom = FALSE)

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.

Parameters

string $string The string to be shortened.
int $length The max length of the string.
bool $makeRandom

Return Value

string

in CRM_Core_DAO at line 2435
setOptions(array $options)

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

Parameters

array $options

in CRM_Core_DAO at line 2448
protected _setDBOptions(array $options)

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

Parameters

array $options

in CRM_Core_DAO at line 2463
setApiFilter(array $params) deprecated

deprecated

Parameters

array $params

in CRM_Core_DAO at line 2480
array addSelectWhereClause()

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.:

Return Value

array

in CRM_Core_DAO at line 2521
static array getSelectWhereClause(string $tableAlias = NULL)

This returns the final permissioned query string for this entity

With acls from related entities + additional clauses from hook_civicrm_selectWhereClause

Parameters

string $tableAlias

Return Value

array

in CRM_Core_DAO at line 2544
static bool requireSafeDBName($database)

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

Parameters

$database

Return Value

bool

in CRM_Event_DAO_Event at line 1530
static array fieldKeys()

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

Return Value

array Array(string $name => string $uniqueName).

in CRM_Event_DAO_Event at line 1549
boolean getLog()

Returns if this table needs to be logged

Return Value

boolean

in CRM_Event_DAO_Event at line 1559
static array import(bool $prefix = false)

Returns the list of fields that can be imported

Parameters

bool $prefix

Return Value

array

in CRM_Event_DAO_Event at line 1570
static array export(bool $prefix = false)

Returns the list of fields that can be exported

Parameters

bool $prefix

Return Value

array

in CRM_Event_DAO_Event at line 1577
static indices($localize = TRUE)

Returns the list of indices

Parameters

$localize

at line 52
static CRM_Event_DAO_Event retrieve(array $params, array $defaults)

Fetch object based on array of properties.

Parameters

array $params (reference ) an assoc array of name/value pairs.
array $defaults (reference ) an assoc array to hold the flattened values.

Return Value

CRM_Event_DAO_Event

at line 73
static Object setIsActive(int $id, bool $is_active)

Update the is_active flag in the db.

Parameters

int $id Id of the database record.
bool $is_active Value we want to set the is_active field.

Return Value

Object DAO object on success, null otherwise

at line 85
static CRM_Event_DAO_Event add(array $params)

Add the event.

Parameters

array $params Reference array contains the values submitted by the form.

Return Value

CRM_Event_DAO_Event

at line 123
static object create(array $params)

Create the event.

Parameters

array $params Reference array contains the values submitted by the form.

Return Value

object

at line 179
static mixed|null del(int $id)

Delete the event.

Parameters

int $id Event id.

Return Value

mixed|null

at line 230
static deleteEventLocBlock(int $locBlockId, int $eventId = NULL)

Delete the location block associated with an event.

Function checks that it is not being used by any other event.

Parameters

int $locBlockId Location block id to be deleted.
int $eventId Event with which loc block is associated.

at line 261
static array getEvents(int $all, int|array $id = NULL, bool $isActive = TRUE, bool $checkPermission = TRUE, bool $titleOnly = FALSE)

Get current/future Events.

Parameters

int $all 0 returns current and future events. 1 if events all are required 2 returns events since 3 months ago
int|array $id single int event id or array of multiple event ids to return
bool $isActive true if you need only active events.
bool $checkPermission true if you need to check permission else false.
bool $titleOnly true if you need only title not appended with start date

Return Value

array

at line 323
static array getEventSummary()

Get events Summary.

Return Value

array Array of event summary values

at line 593
static array getParticipantCount(int $eventId, bool $considerStatus = TRUE, bool $status = TRUE, bool $considerRole = TRUE, bool $role = TRUE)

Get participant count.

Parameters

int $eventId
bool $considerStatus consider status for participant count. Consider status for participant count.
bool $status counted participant. Consider counted participant.
bool $considerRole consider role for participant count. Consider role for participant count.
bool $role consider counted( is filter role) participant. Consider counted( is filter role) participant.

Return Value

array array with count of participants for each event based on status/role

at line 655
static null|string getMapInfo(int $id)

Get the information to map a event.

Parameters

int $id For which we want map info.

Return Value

null|string title of the event

at line 730
static array getCompleteInfo(date $start = NULL, int $type = NULL, int $eventId = NULL, date $end = NULL, bool $onlyPublic = TRUE)

Get the complete information for one or more events.

Parameters

date $start Get events with start date >= this date.
int $type Get events on the a specific event type (by event_type_id). Get events on the a specific event type (by event_type_id).
int $eventId Return a single event - by event id. Return a single event - by event id.
date $end Also get events with end date >= this date.
bool $onlyPublic Include public events only, default TRUE. Include public events only, default TRUE.

Return Value

array array of all the events that are searched

at line 917
static CRM_Event_DAO_Event copy(int $id, null $newEvent = NULL, bool $afterCreate = FALSE)

Make a copy of a Event.

Include all the fields in the event Wizard.

Parameters

int $id The event id to copy. boolean $afterCreate call to copy after the create function
null $newEvent
bool $afterCreate

Return Value

CRM_Event_DAO_Event

at line 1014
static copyCustomFields(int $oldEventID, int $newCopyID)

Method that copies custom fields values from an old event to a new one. Fixes bug CRM-19302, where if a custom field of File type was present, left both events using the same file, breaking download URL's for the old event.

Parameters

int $oldEventID
int $newCopyID

at line 1066
static bool isMonetary(int $id)

This is sometimes called in a loop (during event search).

We cache the values to prevent repeated calls to the db.

Parameters

int $id

Return Value

bool

at line 1086
static bool usesPriceSet(int $id)

This is sometimes called in a loop (during event search).

We cache the values to prevent repeated calls to the db.

Parameters

int $id

Return Value

bool

at line 1103
static sendMail(int $contactID, array $values, int $participantId, bool $isTest = FALSE, bool $returnMessageText = FALSE)

Send e-mails.

Parameters

int $contactID
array $values
int $participantId
bool $isTest
bool $returnMessageText

at line 1298
static array|null buildCustomDisplay(int $id, string $name, int $cid, string $template, int $participantId, bool $isTest, bool $isCustomProfile = FALSE, array $participantParams = array())

Add the custom fields OR array of participant's profile info.

Parameters

int $id
string $name
int $cid
string $template
int $participantId
bool $isTest
bool $isCustomProfile
array $participantParams

Return Value

array|null

at line 1483
static displayProfile(array $params, int $gid, array $groupTitle, array $values, array $profileFields = array())

Build the array for display the profile fields.

Parameters

array $params Key value.
int $gid Profile Id.
array $groupTitle Profile Group Title.
array $values Formatted array of key value.
array $profileFields

at line 1761
static array buildCustomProfile(int $participantId, array $values, int $contactId = NULL, bool $isTest = FALSE, bool $isIdsArray = FALSE, bool $skipCancel = TRUE)

Build the array for Additional participant's information array of primary and additional Ids.

Parameters

int $participantId Id of Primary participant.
array $values Key/value event info.
int $contactId Contact id of Primary participant.
bool $isTest Whether test or live transaction.
bool $isIdsArray To return an array of Ids.
bool $skipCancel

Return Value

array array of Additional participant's info OR array of Ids.

at line 1875
static array getLocationEvents()

Retrieve all event addresses.

Return Value

array

at line 1917
static int|null|string countEventsUsingLocBlockId(int $locBlockId)

Parameters

int $locBlockId

Return Value

int|null|string

at line 1938
static bool validRegistrationRequest(array $values, int $eventID)

Check if event registration is valid according to permissions AND Dates.

Parameters

array $values
int $eventID

Return Value

bool

at line 1952
static bool validRegistrationDate($values)

Parameters

$values

Return Value

bool

Parameters

$values

Return Value

bool

at line 2022
static bool checkRegistration(array $params)

Parameters

array $params

Return Value

bool

at line 2052
static string checkPermission(int $eventId = NULL, int $type = CRM_Core_Permission::VIEW)

Make sure that the user has permission to access this event.

Parameters

int $eventId
int $type

Return Value

string the permission that the user has (or null)

at line 2127
static array getFromEmailIds(int $eventId = NULL)

Build From Email as the combination of all the email ids of the logged in user, the domain email id and the email id configured for the event

Parameters

int $eventId The id of the event.

Return Value

array an array of email ids

at line 2163
static int eventTotalSeats(int $eventId, sting $extraWhereClause = NULL)

Calculate event total seats occupied.

Parameters

int $eventId Event id.
sting $extraWhereClause Extra filter on participants.

Return Value

int event total seats w/ given criteria.

at line 2209
static array getTemplateDefaultValues(int $templateId)

Retrieve event template default values to be set.

as default values for current new event.

Parameters

int $templateId Event template id.

Return Value

array Array of custom data defaults.

at line 2235
static object get_sub_events(int $event_id)

Parameters

int $event_id

Return Value

object

at line 2249
static updateParticipantCampaignID(int $eventID, int $eventCampaignID)

Update the Campaign Id of all the participants of the given event.

Parameters

int $eventID Event id.
int $eventCampaignID Campaign id of that event.