API Documentation
\

\Object_Sync_Sf_Salesforce_Select_Query

Class representing a Salesforce SELECT SOQL query.

Summary

Methods
Properties
Constants
__construct()
add_condition()
__toString()
$fields
$order
$object_type
$limit
$offset
$conditions
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$fields

$fields :

Type

$order

$order :

Type

$object_type

$object_type :

Type

$limit

$limit :

Type

$offset

$offset :

Type

$conditions

$conditions :

Type

Methods

__construct()

__construct(string  $object_type = '')

Constructor which sets the query object type.

Parameters

string $object_type

Salesforce object type to query.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

add_condition()

add_condition(string  $field, mixed  $value, string  $operator = '=')

Add a condition to the query.

Parameters

string $field

Field name.
mixed $value

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.
string $operator

Conditional operator. One of '=', '!=', '<', '>', 'LIKE, 'IN', 'NOT IN'.
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

__toString()

__toString() : string

Implements PHP's magic __toString().

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

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/jstegall/Sites/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string —

SOQL query ready to be executed the SF API.