\Visionline\Crm\WebApiOrder

Defines the order of a result set.

Summary

Methods
Properties
Constants
__construct()
asc()
desc()
random()
__toString()
fromString()
$fields
$asc
$random
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 : string

The fields by which the result set should be sorted. If multiple fields are specified, the first filled-in field per entity is used for comparison.

Type

string

$asc

$asc : boolean

Specifies whether the order should be ascending or descending.

Type

boolean

$random

$random : boolean

Specifies whether the order is random. If <code>true</code>, other settings are ignored and a random order is performed.

Type

boolean

Methods

__construct()

__construct(string|array  $field, boolean  $ascending, boolean  $random = false) 

Creates a new Order

Parameters

string|array $field

The fields by which the result set should be sorted. If multiple fields are specified, the first filled-in field per entity is used for comparison.

boolean $ascending

Specifies whether the order should be ascending or descending. If true, the order will be ascending, otherwise descending.

boolean $random

Specifies whether the order is random. If true, the other parameters are ignored and a random order is performed.

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

asc()

asc(string|array  $field) : \Visionline\Crm\WebApi\Order

Shorthand for creating an ascending order by the specified field

Parameters

string|array $field

The fields by which the result set should be sorted. If multiple fields are specified, the first filled-in field per entity is used for comparison.

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

Returns

\Visionline\Crm\WebApi\Order

desc()

desc(string|array  $field) : \Visionline\Crm\WebApi\Order

Shorthand for creating an descending order by the specified field

Parameters

string|array $field

The fields by which the result set should be sorted. If multiple fields are specified, the first filled-in field per entity is used for comparison.

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

Returns

\Visionline\Crm\WebApi\Order

random()

random() : \Visionline\Crm\WebApi\Order

Shorthand for creating a random order

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

Returns

\Visionline\Crm\WebApi\Order

__toString()

__toString() : string

Returns the string representation of this order

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

Returns

string —

The string representation of this order

fromString()

fromString(string  $orderstr) : \Visionline\Crm\WebApi\Order

Create an order from a string representation previously generated by __toString()

Parameters

string $orderstr

A string representation of an order

Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376 Warning: count(): Parameter must be an array or an object that implements Countable in phar://E:/source/CRM-VISIONLINE/3.4.2/Source/Website/build/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1376

Returns

\Visionline\Crm\WebApi\Order

The order created from the string representation