Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractSource
  • DatabaseSource
  • DatabaseSourceConfig
  • Filter
  • Order
  • Pagination
  • SourceConfig

Interfaces

  • DatabaseSourceInterface
  • FilterInterface
  • OrderInterface
  • PaginationInterface
  • SourceInterface
  • StorableInterface

Traits

  • StorableTrait
  • Overview
  • Namespace
  • Class

Interface OrderInterface

Direct known implementers

Charcoal\Source\Order

Indirect known implementers

Charcoal\Source\Database\DatabaseOrder
Namespace: Charcoal\Source
Located at Charcoal/Source/OrderInterface.php
Methods summary
public Charcoal\Source\Order
# setData( array $data )

Parameters

$data
The order data.

Returns

Charcoal\Source\Order
Chainable
public Charcoal\Source\Order
# setProperty( string $property )

Parameters

$property
The property to order with.

Returns

Charcoal\Source\Order
(Chainable)
public string
# property( )

Returns

string
public Charcoal\Source\Order
# setMode( string $mode )

Parameters

$mode
The order mode.

Returns

Charcoal\Source\Order
Chainable
public string
# mode( )

Returns

string
public Charcoal\Source\Order
# setValues( string|array $values )

Set the values. Values are ignored if the mode is not "values"

Set the values. Values are ignored if the mode is not "values"

If the $values argument is a string, it will be split by ",". If it is an array, the values will be used as is. Otherwise, the function will throw an error

Parameters

$values
The order values.

Returns

Charcoal\Source\Order
(Chainable)
public array
# values( )

Returns

array
API documentation generated by ApiGen