Object Sync for Salesforce Code Documentation

Object_Sync_Sf_Salesforce_Select_Query

Object_Sync_Sf_Salesforce_Select_Query class.

Table of Contents

$conditions  : array<string|int, mixed>
Conditions for the SOQL query
$fields  : array<string|int, mixed>
Fields for the SOQL query
$limit  : string
Limit for the SOQL query
$object_type  : string
Salesforce object type
$offset  : string
Offset for the SOQL query
$option_prefix  : string
The plugin's prefix when saving options to the database
$order  : array<string|int, mixed>
Order for the SOQL query
$version  : string
Current version of the plugin
__construct()  : mixed
Constructor for mapping class
__toString()  : string
Implements PHP's magic __toString().
add_condition()  : mixed
Add a condition to the query.

Properties

Methods

__construct()

Constructor for mapping class

public __construct([string $object_type = '' ]) : mixed
Parameters
$object_type : string = ''

Salesforce object type to query.

Return values
mixed

__toString()

Implements PHP's magic __toString().

public __toString() : string

Function to convert the query to a string to pass to the SF API.

Return values
string

$query SOQL query ready to be executed the SF API.

add_condition()

Add a condition to the query.

public add_condition(string $field, mixed $value[, string $operator = '=' ]) : mixed
Parameters
$field : string

Field name.

$value : mixed

Condition value. If an array, it will be split into quote enclosed strings separated by commas inside of parenthesis. Note that the caller must enclose the value in quotes as needed by the SF API.

$operator : string = '='

Conditional operator. One of '=', '!=', '<', '>', 'LIKE, 'IN', 'NOT IN'.

Return values
mixed

Search results