Class Criteria

Represents the query parameters for loading entities.

For details, see the API documentation on querying.

Namespace: PipelinerSales\ApiClient\Query
Located at PipelinerSales/ApiClient/Query/Criteria.php

Methods summary
`public`	# `__construct( mixed $criteria = array(), string $dateTimeFormat = PipelinerSales\ApiClient\Query\Defaults::DATE_FORMAT, $defaultLimit = PipelinerSales\ApiClient\Query\Defaults::DEFAULT_LIMIT )` Creates a new set of criteria. Creates a new set of criteria. Parameters `$criteria` initial criteria to use, see `PipelinerSales\ApiClient\Query\Criteria::set()` `$dateTimeFormat` format to use for converting DateTime objects `$defaultLimit`
`public string`	# `toUrlQuery( )` Returns the resulting url-encoded query string. Returns the resulting url-encoded query string. Returns `string`
`public integer\|null`	# `getLimit( )` Returns the currently set limit. Null will be returned if the limit is not set. Returns the currently set limit. Null will be returned if the limit is not set. Returns `integer\|null`
`public integer`	# `getEffectiveLimit( )` Returns the currently set limit, or the default limit if none is set. Returns the currently set limit, or the default limit if none is set. Returns `integer`
`public integer\|null`	# `getOffset( )` Returns the currently set offset. Null will be returned if no offset is set. Returns the currently set offset. Null will be returned if no offset is set. Returns `integer\|null`
`public integer`	# `getEffectiveOffset( )` Returns the currently set offset, or the default offset 0 if no offset is set. Returns the currently set offset, or the default offset 0 if no offset is set. Returns `integer`
`public string\|null`	# `getSort( )` Returns `string\|null`
`public PipelinerSales\ApiClient\Query\Criteria`	# `setSort( string\|PipelinerSales\ApiClient\Query\Sort $sort )` Parameters `$sort` Returns `PipelinerSales\ApiClient\Query\Criteria`
`public string\|null`	# `getFilter( )` Returns the currently set filter string. Returns the currently set filter string. Returns `string\|null`
`public string\|null`	# `getAfter( )` Returns `string\|null`
`public string\|null`	# `getLoadOnly( )` Returns `string\|null`
`public`	# `set( mixed $criteria )` Sets multiple parameters at once. Sets multiple parameters at once. Parameters `$criteria` Can be one of the following: Another Criteria object - copies that object's criteria into this one. Competely replaces the current object's values, unsetting those which have not been set in $criteria An array - sets the parameters present in the array. Parameters not present in the array will not be unset. If you wish to unset certain parameters, set them to null in the array. A string - the resulting query string (without a leading question mark), will be parsed back into the individual parameters and processed like an array.
`public static`	# `__callStatic( $name, $arguments )`
`public`	# `__call( $name, $arguments )`

Magic methods summary
`public PipelinerSales\ApiClient\Query\Criteria`	# `limit( $limit )` Limits how many entities to load. Use the NO_LIMIT constant to disable limits. Limits how many entities to load. Use the NO_LIMIT constant to disable limits. Parameters `$limit` Returns `PipelinerSales\ApiClient\Query\Criteria`
`public PipelinerSales\ApiClient\Query\Criteria`	# `offset( $offset )` Parameters `$offset` Returns `PipelinerSales\ApiClient\Query\Criteria`
`public PipelinerSales\ApiClient\Query\Criteria`	# `sort( )` or a Sort object or a Sort object Returns `PipelinerSales\ApiClient\Query\Criteria`
`public PipelinerSales\ApiClient\Query\Criteria`	# `filter( )` or a Filter object or a Filter object Returns `PipelinerSales\ApiClient\Query\Criteria`
`public PipelinerSales\ApiClient\Query\Criteria`	# `after( $after )` Only load entities modified after the date, specified as either a string or a DateTime object Only load entities modified after the date, specified as either a string or a DateTime object Parameters `$after` Returns `PipelinerSales\ApiClient\Query\Criteria`
`public PipelinerSales\ApiClient\Query\Criteria`	# `loadonly( $loadonly )` Only load the specified fields, specified as either an array or a string separated with \| Only load the specified fields, specified as either an array or a string separated with \| Parameters `$loadonly` Returns `PipelinerSales\ApiClient\Query\Criteria`

Constants summary
`integer`	`NO_LIMIT` Disable the limit on how many entities to load. Please use with caution. Disable the limit on how many entities to load. Please use with caution.	# `-1`