Overview

Namespaces

  • Webmozart
    • KeyValueStore
      • Api
      • Decorator
      • Util

Interfaces

  • CountableStore
  • KeyValueStore
  • SortableStore

Exceptions

  • InvalidKeyException
  • NoSuchKeyException
  • ReadException
  • SerializationFailedException
  • UnserializationFailedException
  • UnsupportedValueException
  • WriteException
  • Overview
  • Namespace
  • Class

Interface SortableStore

A sortable key-value store.

In addition of the properties of a classical store, a sortable store has the ability to sort its values by its keys.

Webmozart\KeyValueStore\Api\SortableStore implements Webmozart\KeyValueStore\Api\KeyValueStore

Direct known implementers

Webmozart\KeyValueStore\ArrayStore, Webmozart\KeyValueStore\Decorator\SortableDecorator, Webmozart\KeyValueStore\JsonFileStore, Webmozart\KeyValueStore\NullStore

Indirect known implementers

Webmozart\KeyValueStore\SerializingArrayStore
Namespace: Webmozart\KeyValueStore\Api
Since: 1.0
Author: Bernhard Schussek bschussek@gmail.com
Author: Titouan Galopin galopintitouan@gmail.com
Located at Api/SortableStore.php
Methods summary
public
# sort( integer $flags = SORT_REGULAR )

Sort the store by its keys.

Sort the store by its keys.

The store values will be arranged from lowest to highest when this function has completed.

This method accepts an optional second parameter that may be used to modify the sorting behavior using the standard sort flags of PHP.

Parameters

$flags
Sorting type flags (from the standard PHP sort flags).

Throws

Webmozart\KeyValueStore\Api\ReadException
If the store cannot be read.
Webmozart\KeyValueStore\Api\WriteException
If the store cannot be written.

See

http://php.net/manual/en/function.sort.php
Methods inherited from Webmozart\KeyValueStore\Api\KeyValueStore
clear(), exists(), get(), getMultiple(), getMultipleOrFail(), getOrFail(), keys(), remove(), set()
Webmozart Key-Value Store API API documentation generated by ApiGen