• ActiveWAFL 1770 API Reference Documentation
  • Search
  • Version

DblEj \ Data

The Data namespace.

Contains several server-side (JS) and client-side (PHP) interfaces, abstract classes, concrete implementations, exception classes, and utility classes that deal with data storage and retrieval.

 
DblEj\Data

Classes

ArrayModel

A data model that uses a php associative array as the underlying data source. Each element value is expected to be a string.

Field

Represents a data field.

Contains properties that inform about the field's type and constraints.

FieldCollection

A strong-typed collection of DblEj\Data\Field objects.

ForeignKey

Represents a foreign key constraint in a relational data model.

IndexSort

Used to specify sorting criteria when querying an index.

IndexerExtensionBase Abstract
Model Abstract

Represents a set of data of some defined structure.

PersistableModel Abstract

A data model that can be persisted to and loaded from an underlying data storage, if one is provided.

SaveableObject Abstract

ScriptExecutedEvent

Represents an event that fires when a script has executed.

Validator Static

A utility class for validating and sanitizing data.

Interfaces

IData

An interface for an object that contains any arbitrary data that can be read or written.

IDataStore

A store of key/val string pairs.

IDataStoreContainer

A container for multiple data stores.

IDatabaseEngine

Represents a database engine.

Database engines should implement this interface to be used as a StorageEngine persistant data source.

IFieldAggregatorUtil

Interface for a class that exposes static methods for aggregating data from multiple different instances of that class.

IFieldPublisher

A class that publishes information about it's fields. Iterating over an instance of this class will iterate on it's fields.

IFilterable

Interface for classes that want to expose methods for filtering though some underlying collection of instances of that same class.

For example, let's say you have a class named "Animal" and you want to be able to query Animal for all instances that are "Dogs". Animal would implement IFilterable and then expose the Filter method for finding a subset of the Animal's (in this case, dogs) based on the given $filter and other parameters.

IIndex

An interface to a search indexing service.

IIndexable

Represents an indexable object.

An indexable object is one which can be indexed in an IIndex.

IIndexer

Represents an application or service that indexes information. An IIndexer has IIndexes which can store IIndexables.

IInitializableStatic

Represents a static class that has a static initializer.

IKeyedData

Represents any data that is identified by a key. Provides a static interface for getting information about the type of keyed data as well as looking up the actual data.

IModel

Represents a set of data of some defined structure.

IPersistable

An interface for classes who's instances can be persisted.

IPersistableModel

A class that publishes information about it's fields. Iterating over an instance of this class will iterate on it's fields.

IPersistantDataStore

A data store who's data can be saved to and restored from a persistant storage medium.

IPersistantModel

An alias of IPersistableModel

ISaveableObject

An object that can be saved.

IStorageEngine
IStorageEngineContainer

A container for one or more storage engines.

Exceptions

DataException

Thrown when there is a data-related exception.

DataModelException

Thrown when there is an unexpected event related to an operation dealing with a data model.

DatabaseUpdateException

Thrown when there is an unexpected event related to a database update.

InvalidDataException

Thrown when invalid data is passed as an argument or returned as a value.

InvalidDataFieldException

A data field or its value was requested on an object which does not contain it

StorageEngineNotReadyException

Thrown when a storage engine is not ready to perform a requested task.

Child Namespaces

There are no namespaces beneath Data