Interfaces

Interface representing AMQP values

Interface to provide accessing objects as arrays.

A PHP representation of an aggregate

Cluster object is used to create Sessions.

A PHP representation of a column

An interface implemented by all exceptions thrown by the PHP Driver.

A PHP representation of a function

Futures are returns from asynchronous methods.

A PHP representation of an index

A PHP representation of a keyspace

Common interface implemented by all numeric types, providing basic arithmetic functions.

Interface for retry policies.

A PHP representation of a schema

A session is used to prepare and execute statements.

All statements implement this common interface.

A PHP representation of a table

Interface for timestamp generators.

A PHP representation of the CQL uuid datatype

Common interface implemented by all Cassandra value types.

(PECL pthreads >= 2.0.8)
Represents a garbage-collectable object.

Interface for retrieving results from analytics queries.

Interface of authentication containers.

Interface for results created by the counter operation.

A range (or bucket) for a date range facet result. Counts the number of matches that fall into the named range (which can overlap with other user-defined ranges).

An object which contains levels of durability that can be enforced when using mutation operations.

Interface for results created by the exists operation.

Interface for results created by the getReplica operation.

Interface for results created by the get operation.

Interface for results created by the lookupIn operation.

LookupInSpec is an interface for providing subdocument lookup operations.

Providers an interface to create value recorders for recording metrics.

Interface for results created by the mutateIn operation.

MutateInSpec is an interface for providing subdocument mutation operations.

Interface for results created by operations that perform mutations.

An object which contains meta information of the document needed to enforce query consistency.

A range (or bucket) for a numeric range facet result. Counts the number of matches that fall into the named range (which can overlap with other user-defined ranges).

Interface for retrieving metadata such as errors and metrics generated during N1QL queries.

Set of values for setting the profile mode of a query.

Interface for retrieving results from N1QL queries.

Set of values for the scan consistency level of a query.

Represents a span of time an event occurs over.

Represents a tracer capable of creating trace spans.

Base interface for all results generated by KV operations.

Common interface for all search facets

Interface representing facet results.

Interface for retrieving metadata such as error counts and metrics generated during search queries.

Common interface for all classes, which could be used as a body of SearchQuery

Common interface for all classes, which could be used as a body of SearchQuery

Interface for retrieving results from search queries.

Base interface for all FTS sort options in querying.

An object which contains how to define the document level action to take during a MutateIn operation.

A range (or bucket) for a term search facet result.

Provides an interface for recording values.

Interface for retrieving metadata generated during view queries.

Common interface for all View queries

Interface for retrieving results from view queries.

Classes implementing Countable can be used with the count function.

Collection is the base interface which covers functionality common to all the data structures in this library. It guarantees that all structures are traversable, countable, and can be converted to json using json_encode().

Hashable is an interface which allows objects to be used as keys. It’s an alternative to spl_object_hash(), which determines an object’s hash based on its handle: this means that two objects that are considered equal by an implicit definition would not treated as equal because they are not the same instance.

A Sequence describes the behaviour of values arranged in a single, linear dimension. Some languages refer to this as a "List". It’s similar to an array that uses incremental integer keys, with the exception of a few characteristics:

• Values will always be indexed as [0, 1, 2, …, size - 1].
• Only allowed to access values by index in the range [0, size - 1].

Use cases:

• Wherever you would use an array as a list (not concerned with keys).
• A more efficient alternative to SplDoublyLinkedList and SplFixedArray.

This interface has functionality shared between Transaction and Span contexts'.

This interface has functionality shared between Transaction and Span.

An object containing contextual data about the destination for spans

Class to gather optional parameters to start a new transaction

Interface for external iterators or objects that can be iterated themselves internally.

Interface to create an external Iterator.

Objects implementing JsonSerializable can customize their JSON representation when encoded with json_encode.

This interface is implemented by MongoDB\BSON\Binary but may also be used for type-hinting and userland classes.

This interface is implemented by MongoDB\BSON\Decimal128 but may also be used for type-hinting and userland classes.

Interface JavascriptInterface

This interface is implemented by MongoDB\BSON\MaxKey but may also be used for type-hinting and userland classes.

This interface is implemented by MongoDB\BSON\MinKey but may also be used for type-hinting and userland classes.

This interface is implemented by MongoDB\BSON\ObjectId but may also be used for type-hinting and userland classes.

Classes may implement this interface to take advantage of automatic ODM (object document mapping) behavior in the driver.

Classes that implement this interface may return data to be serialized as a BSON array or document in lieu of the object's public properties

Interface TimestampInterface

Interface Type

This interface is implemented by MongoDB\BSON\UTCDateTime but may also be used for type-hinting and userland classes.

Classes that implement this interface may be specified in a type map for unserializing BSON arrays and documents (both root and embedded).

This interface is implemented by MongoDB\Driver\Cursor but may also be used for type-hinting and userland classes.

Common interface for all driver exceptions. This may be used to catch only exceptions originating from the driver itself.

Classes may implement this interface to register an event subscriber that is notified for each started, successful, and failed command event.

Base interface for event subscribers.

Classes implementing OuterIterator can be used to iterate over iterators.

Classes implementing RecursiveIterator can be used to iterate over iterators recursively.

Reflector is an interface implemented by all exportable Reflection classes.

The Seekable iterator.

Interface for customized serializing.
As of PHP 8.1.0, a class which implements Serializable without also implementing __serialize() and __unserialize() will generate a deprecation warning.

SessionHandlerInterface is an interface which defines a prototype for creating a custom session handler.

SessionUpdateTimestampHandlerInterface is an interface which defines a prototype for updating the life time of an existing session.

The SplObserver interface is used alongside SplSubject to implement the Observer Design Pattern.

The SplSubject interface is used alongside SplObserver to implement the Observer Design Pattern.

Stringable interface denotes a class as having a __toString() method.

Throwable is the base interface for any object that can be thrown via a throw statement in PHP 7, including Error and Exception.

Interface to detect if a class is traversable using foreach.

\Yaf\Route_Interface used for developer defined their custom route.

Yaf provides a ability for developers to use custom view engine instead of build-in engine which is \Yaf\View\Simple. There is a example to explain how to do this, please see \Yaf\Dispatcher::setView()

Yaf_Route_Interface used for developer defined their custom route.

Yaf provides a ability for developers to use custom view engine instead of build-in engine which is Yaf_View_Simple. There is a example to explain how to do this, please see Yaf_Dispatcher::setView()

Interface to an user event loop implementation for http\Client::configure()'s $use_eventloop option.

The http extension's Exception interface.

Interface BaseResult

Interface CrudOperationBindable

Interface CrudOperationLimitable

Interface CrudOperationSkippable

Interface CrudOperationSortable

Interface DatabaseObject

Interface Executable

Interface SchemaObject

Interface for type conversions.

A base interface for all pq\Exception classes.