Overview

Namespaces

  • PipelinerSales
    • ApiClient
      • Http
      • Query
      • Repository
        • Rest

Classes

  • Criteria
  • Filter
  • Sort
  • Overview
  • Namespace
  • Class
  • Tree

Class Sort

A convenient wrapper for generating the sort string for queries.

For details, see the API documentation.

All the magic methods can also be called statically, e.g.

Sort::asc('NAME')->desc('MODIFIED')
Namespace: PipelinerSales\ApiClient\Query
Located at PipelinerSales/ApiClient/Query/Sort.php
Methods summary
public
# __construct( mixed $sort = '' )

Constructor, optionally copies an existing sort string into this object.

Constructor, optionally copies an existing sort string into this object.

Parameters

$sort
either a sort string or another Sort object
public
# __call( $name, $arguments )
public static
# __callStatic( $name, $arguments )
public string
# getString( )

Returns the resulting sort string.

Returns the resulting sort string.

Returns

string
Magic methods summary
public PipelinerSales\ApiClient\Query\Sort
# asc( string $fieldName )

sorts by a field in ascending order

sorts by a field in ascending order

Parameters

$fieldName

Returns

PipelinerSales\ApiClient\Query\Sort
public PipelinerSales\ApiClient\Query\Sort
# desc( string $fieldName )

sorts by a field in descending order

sorts by a field in descending order

Parameters

$fieldName

Returns

PipelinerSales\ApiClient\Query\Sort
public PipelinerSales\ApiClient\Query\Sort
# raw( string $sortString )

appends a separator (|) followed by a raw string to the current sort string

appends a separator (|) followed by a raw string to the current sort string

Parameters

$sortString

Returns

PipelinerSales\ApiClient\Query\Sort
API documentation generated by ApiGen