BP_Invitation::get_query_clauses( array $args = array() )
Assemble query clauses, based on arguments, to pass to $wpdb methods.
Description Description
The insert(), update(), and delete() methods of wpdb expect arguments of the following forms:
- associative arrays whose key/value pairs are column => value, to be used in WHERE, SET, or VALUES clauses
- arrays of "formats", which tell $wpdb->prepare() which type of value to expect when sanitizing (eg, array( ‘%s’, ‘%d’ ))
This utility method can be used to assemble both kinds of params, out of a single set of associative array arguments, such as:
$args = array(
'user_id' => 4,
'class' => 'BP_Groups_Invitation_Manager',
);This will be converted to:
array(
'data' => array(
'user_id' => 4,
'class' => 'BP_Groups_Invitation_Manager',
),
'format' => array(
'%d',
'%s',
),
)which can easily be passed as arguments to the $wpdb methods.
Parameters Parameters
- $args
-
(Optional) Associative array of filter arguments. See {@BP_Invitation::get()} for a breakdown.
Default value: array()
Return Return
(array) Associative array of 'data' and 'format' args.
Source Source
File: bp-core/classes/class-bp-invitation.php
protected static function get_query_clauses( $args = array() ) {
$where_clauses = array(
'data' => array(),
'format' => array(),
);
// id
if ( ! empty( $args['id'] ) ) {
$where_clauses['data']['id'] = absint( $args['id'] );
$where_clauses['format'][] = '%d';
}
// user_id
if ( ! empty( $args['user_id'] ) ) {
$where_clauses['data']['user_id'] = absint( $args['user_id'] );
$where_clauses['format'][] = '%d';
}
// inviter_id
if ( ! empty( $args['inviter_id'] ) ) {
$where_clauses['data']['inviter_id'] = absint( $args['inviter_id'] );
$where_clauses['format'][] = '%d';
}
// invitee_email
if ( ! empty( $args['invitee_email'] ) ) {
$where_clauses['data']['invitee_email'] = $args['invitee_email'];
$where_clauses['format'][] = '%s';
}
// class
if ( ! empty( $args['class'] ) ) {
$where_clauses['data']['class'] = $args['class'];
$where_clauses['format'][] = '%s';
}
// item_id
if ( ! empty( $args['item_id'] ) ) {
$where_clauses['data']['item_id'] = absint( $args['item_id'] );
$where_clauses['format'][] = '%d';
}
// secondary_item_id
if ( ! empty( $args['secondary_item_id'] ) ) {
$where_clauses['data']['secondary_item_id'] = absint( $args['secondary_item_id'] );
$where_clauses['format'][] = '%d';
}
// type
if ( ! empty( $args['type'] ) && 'all' !== $args['type'] ) {
if ( 'invite' == $args['type'] || 'request' == $args['type'] ) {
$where_clauses['data']['type'] = $args['type'];
$where_clauses['format'][] = '%s';
}
}
/**
* invite_sent
* Only create a where statement if something less than "all" has been
* specifically requested.
*/
if ( isset( $args['invite_sent'] ) && 'all' !== $args['invite_sent'] ) {
if ( $args['invite_sent'] == 'draft' ) {
$where_clauses['data']['invite_sent'] = 0;
$where_clauses['format'][] = '%d';
} else if ( $args['invite_sent'] == 'sent' ) {
$where_clauses['data']['invite_sent'] = 1;
$where_clauses['format'][] = '%d';
}
}
// accepted
if ( ! empty( $args['accepted'] ) && 'all' !== $args['accepted'] ) {
if ( $args['accepted'] == 'pending' ) {
$where_clauses['data']['accepted'] = 0;
$where_clauses['format'][] = '%d';
} else if ( $args['accepted'] == 'accepted' ) {
$where_clauses['data']['accepted'] = 1;
$where_clauses['format'][] = '%d';
}
}
return $where_clauses;
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |