A

ArgumentBagClass in namespace Sofa\Eloquence
ArgumentBag::all() — Method in class ArgumentBag
Builder::aggregate() — Method in class Builder
Execute an aggregate function on the database.
Builder::avg() — Method in class Builder
Retrieve the average of the values of a given column.
ArgumentBagClass in namespace Sofa\Eloquence\Contracts
ArgumentBag::all() — Method in class ArgumentBag
Get array with all arguments.
AttributeClass in namespace Sofa\Eloquence\Contracts
AttributeBagClass in namespace Sofa\Eloquence\Contracts
$MetableProperty in class Metable
array$allowedMeta
Metable::allowsMeta() — Method in class Metable
Determine whether meta attribute is allowed for the model.
AttributeClass in namespace Sofa\Eloquence\Metable
$AttributeProperty in class Attribute
array$attributes
AttributeBagClass in namespace Sofa\Eloquence\Metable
AttributeBag::add() — Method in class AttributeBag
Set attribute.
ColumnCollection::add() — Method in class ColumnCollection

B

BuilderClass in namespace Sofa\Eloquence
Eloquence::bootEloquence() — Method in class Eloquence
Boot the trait.
Mappable::bootMappable() — Method in class Mappable
Register hooks for the trait.
Metable::bootMetable() — Method in class Metable
Register hooks for the trait.
Mutable::bootMutable() — Method in class Mutable
Register hooks for the trait.
ServiceProvider::boot() — Method in class ServiceProvider
Validable::bootValidable() — Method in class Validable
Register hooks for the trait.

C

Builder::callParent() — Method in class Builder
Call base Eloquent method.
Builder::count() — Method in class Builder
Retrieve the "count" result of the query.
Attribute::castToString() — Method in class Attribute
Handle casting value to string.
CleansAttributesClass in namespace Sofa\Eloquence\Contracts
Attribute::castToString() — Method in class Attribute
Handle casting value to string.
CreateMetaAttributesTableClass in namespace Sofa\Eloquence\Metable
ColumnClass in namespace Sofa\Eloquence\Searchable
ColumnCollectionClass in namespace Sofa\Eloquence\Searchable
Observer::creating() — Method in class Observer
Halt creating if model doesn't pass validation.

D

Validable::disableValidation() — Method in class Validable
CreateMetaAttributesTable::down() — Method in class CreateMetaAttributesTable
Reverse the migrations.
Validable::disableValidation() — Method in class Validable
Disable validation for this instance.

E

EloquenceClass in namespace Sofa\Eloquence\Contracts
Validable::enableValidation() — Method in class Validable
EloquenceClass in namespace Sofa\Eloquence
Validable::enableValidation() — Method in class Validable
Enable validation for this instance.

F

ArgumentBag::first() — Method in class ArgumentBag
ArgumentBag::first() — Method in class ArgumentBag
Fetch first argument from the bag.
AttributeBag::forget() — Method in class AttributeBag
Unset attribute.

G

ArgumentBag::get() — Method in class ArgumentBag
Builder::getLikeOperator() — Method in class Builder
Get driver-specific case insensitive like operator.
Builder::get() — Method in class Builder
Execute the query as a "select" statement.
ArgumentBag::get() — Method in class ArgumentBag
Get argument with given key.
Attribute::getValue() — Method in class Attribute
Get the meta attribute value.
Attribute::getKey() — Method in class Attribute
Get the meta attribute key.
AttributeBag::getValue() — Method in class AttributeBag
CleansAttributes::getColumnListing() — Method in class CleansAttributes
CleansAttributes::getDirty() — Method in class CleansAttributes
Eloquence::getColumnsListing() — Method in class Eloquence
Eloquence::getSearchableColumns() — Method in class Eloquence
Mappable::getAttribute() — Method in class Mappable
Mappable::getMappingForAttribute() — Method in class Mappable
Mappable::getMaps() — Method in class Mappable
Metable::getAttribute() — Method in class Metable
Metable::getMetaAttributes() — Method in class Metable
Metable::getMetaAttributesArray() — Method in class Metable
Metable::getMeta() — Method in class Metable
Metable::getAllowedMeta() — Method in class Metable
Validable::getDirty() — Method in class Validable
Validable::getValidationErrors() — Method in class Validable
Validable::getInvalidAttributes() — Method in class Validable
Validable::getValidator() — Method in class Validable
Validable::getUpdateRules() — Method in class Validable
Validable::getCreateRules() — Method in class Validable
Eloquence::getSearchableColumns() — Method in class Eloquence
Get searchable columns defined on the model.
Eloquence::getColumnListing() — Method in class Eloquence
Get model table columns.
Eloquence::getAttributeMutator() — Method in class Eloquence
Get attribute mutator instance.
Eloquence::getAttribute() — Method in class Eloquence
Register hook for getAttribute.
Eloquence::getConnection() — Method in class Eloquence
Eloquence::getTable() — Method in class Eloquence
Mappable::getMappingForAttribute() — Method in class Mappable
Get the mapping key.
Mappable::getAttributeMappable() — Method in class Mappable
Register hook on getAttribute method.
Mappable::getMaps() — Method in class Mappable
Get the array of attribute mappings.
Metable::getAttributeMetable() — Method in class Metable
Register hook on getAttribute method.
Metable::getMeta() — Method in class Metable
Get meta attribute value.
Metable::getMetaAttributes() — Method in class Metable
Get meta attributes as collection.
Metable::getMetaAttributesAttribute() — Method in class Metable
Accessor for metaAttributes property
Metable::getMetaAttributesArray() — Method in class Metable
Get meta attributes as associative array.
Metable::getAllowedMeta() — Method in class Metable
Get allowed meta attributes array.
Attribute::getValue() — Method in class Attribute
Get the meta attribute value.
Attribute::getMetaKey() — Method in class Attribute
Get the meta attribute key.
Attribute::getTable() — Method in class Attribute
Allow custom table name for meta attributes via config.
AttributeBag::getValue() — Method in class AttributeBag
Get attribute value.
$MutableProperty in class Mutable
array$getterMutators
Mutable::getAttributeMutable() — Method in class Mutable
Register hook on getAttribute method.
Mutable::getMutators() — Method in class Mutable
Get the array of attribute mutators.
Column::getWrapped() — Method in class Column
Get qualified name wrapped by the grammar.
Column::getQualifiedName() — Method in class Column
Get column name with table prefix.
Column::getTable() — Method in class Column
Column::getName() — Method in class Column
Column::getMapping() — Method in class Column
Column::getWeight() — Method in class Column
ColumnCollection::getColumns() — Method in class ColumnCollection
ColumnCollection::getQualifiedNames() — Method in class ColumnCollection
Get array of qualified columns names.
ColumnCollection::getTables() — Method in class ColumnCollection
Get array of tables names.
ColumnCollection::getWeights() — Method in class ColumnCollection
Get array of columns mappings and weights.
ColumnCollection::getMappings() — Method in class ColumnCollection
Get array of columns mappings.
ColumnCollection::getIterator() — Method in class ColumnCollection
Get an iterator for the columns.
Subquery::getQuery() — Method in class Subquery
Get underlying query builder.
Subquery::getValue() — Method in class Subquery
Evaluate query as string.
Subquery::getAlias() — Method in class Subquery
Get subquery alias.
Validable::getValidationErrors() — Method in class Validable
Retrieve validation error messages.
Validable::getMessageBag() — Method in class Validable
Retrieve validation error messages.
Validable::getInvalidAttributes() — Method in class Validable
Get names of the attributes that didn't pass validation.
Validable::getValidator() — Method in class Validable
Get the validator instance.
Validable::getValidationMessages() — Method in class Validable
Get custom validation messages.
Validable::getValidationAttributes() — Method in class Validable
Get custom validation attribute names.
Validable::getCreateRules() — Method in class Validable
Get all the validation rules for this model.
Validable::getUpdateRules() — Method in class Validable
Get all validation rules for update on this model.
Validable::getUpdateRulesForId() — Method in class Validable
Get all validation rules for update for given id.
Validable::getValidatedFields() — Method in class Validable
Get array of attributes that have validation rules defined.
Validable::getKey() — Method in class Validable
Validable::getKeyName() — Method in class Validable

H

Eloquence::hasColumn() — Method in class Eloquence
Mappable::hook() — Method in class Mappable
Mappable::hasMapping() — Method in class Mappable
Metable::hook() — Method in class Metable
Metable::hasMeta() — Method in class Metable
Eloquence::hook() — Method in class Eloquence
Register hook on Eloquent method.
Eloquence::hasHook() — Method in class Eloquence
Determine whether a method has any hooks registered.
Eloquence::hasColumn() — Method in class Eloquence
Determine whether the key is meta attribute or actual table field.
Mappable::hasMapping() — Method in class Mappable
Determine whether a mapping exists for an attribute.
Metable::hasMeta() — Method in class Metable
Determine whether meta attribute exists on the model.
Mutable::hasGetterMutator() — Method in class Mutable
Determine whether an attribute has getter mutators defined.
Mutable::hasSetterMutator() — Method in class Mutable
Determine whether an attribute has setter mutators defined.

I

ArgumentBag::isEmpty() — Method in class ArgumentBag
ArgumentBag::isEmpty() — Method in class ArgumentBag
Determine whether the bag is empty.
Validable::isValid() — Method in class Validable
InvalidMutatorExceptionClass in namespace Sofa\Eloquence\Metable
InvalidTypeExceptionClass in namespace Sofa\Eloquence\Metable
InvalidCallableExceptionClass in namespace Sofa\Eloquence\Mutator
Validable::isValid() — Method in class Validable
Determine whether all the attributes on this instance pass validation.

J

Builder::joinRelations() — Method in class Builder
Join related tables.
JoinerClass in namespace Sofa\Eloquence\Contracts\Relations
Joiner::join() — Method in class Joiner
Join tables of the provided relations and return related model.
JoinerFactoryClass in namespace Sofa\Eloquence\Contracts\Relations
JoinerClass in namespace Sofa\Eloquence\Relations
Joiner::join() — Method in class Joiner
Join related tables.
JoinerFactoryClass in namespace Sofa\Eloquence\Relations

L

ArgumentBag::last() — Method in class ArgumentBag
Builder::leftJoinRelations() — Method in class Builder
Left join related tables.
Builder::latest() — Method in class Builder
Add an "order by" clause for a timestamp to the query.
Builder::lists() — Method in class Builder
Get an array with the values of a given column.
ArgumentBag::last() — Method in class ArgumentBag
Fetch last argument from the bag.
Joiner::leftJoin() — Method in class Joiner
Left join related tables.

M

Builder::min() — Method in class Builder
Retrieve the minimum value of a given column.
Builder::max() — Method in class Builder
Retrieve the maximum value of a given column.
MappableClass in namespace Sofa\Eloquence\Contracts
MetableClass in namespace Sofa\Eloquence\Contracts
MutatorClass in namespace Sofa\Eloquence\Contracts
Mutator::mutate() — Method in class Mutator
Mutate value using provided methods.
JoinerFactory::make() — Method in class JoinerFactory
Create new joiner instance.
ParserFactory::make() — Method in class ParserFactory
Create new parser instance.
MappableClass in namespace Sofa\Eloquence
$MappableProperty in class Mappable
Flat array representation of mapped attributes.
$MappableProperty in class Mappable
array$maps
MetableClass in namespace Sofa\Eloquence
Metable::metaAttributes() — Method in class Metable
Meta attributes relation.
ModelClass in namespace Sofa\Eloquence
MutableClass in namespace Sofa\Eloquence
MutatorClass in namespace Sofa\Eloquence\Mutator
Mutator::mutate() — Method in class Mutator
Mutate value using provided methods.
JoinerFactory::make() — Method in class JoinerFactory
Create new joiner instance.
ParserFactory::make() — Method in class ParserFactory
Create new parser instance.

N

Builder::newQuery() — Method in class Builder
Get a new instance of the Eloquence query builder.
Attribute::newCollection() — Method in class Attribute
Create new AttributeBag.
Eloquence::newEloquentBuilder() — Method in class Eloquence
Create new Eloquence query builder for the instance.
Attribute::newBag() — Method in class Attribute
Create new AttributeBag.

O

ObserverClass in namespace Sofa\Eloquence\AttributeCleaner
Builder::orWhere() — Method in class Builder
Add an "or where" clause to the query.
Builder::orWhereBetween() — Method in class Builder
Add an or where between statement to the query.
Builder::orWhereNotBetween() — Method in class Builder
Add an or where not between statement to the query.
Builder::orWhereIn() — Method in class Builder
Add an "or where in" clause to the query.
Builder::orWhereNotIn() — Method in class Builder
Add an "or where not in" clause to the query.
Builder::orWhereNull() — Method in class Builder
Add an "or where null" clause to the query.
Builder::orWhereNotNull() — Method in class Builder
Add an "or where not null" clause to the query.
Builder::orderBy() — Method in class Builder
Add an "order by" clause to the query.
Builder::oldest() — Method in class Builder
Add an "order by" clause for a timestamp to the query.
AttributeBag::offsetSet() — Method in class AttributeBag
Set attribute.
AttributeBag::offsetUnset() — Method in class AttributeBag
Set attribute to null.
ColumnCollection::offsetExists() — Method in class ColumnCollection
ColumnCollection::offsetGet() — Method in class ColumnCollection
ColumnCollection::offsetSet() — Method in class ColumnCollection
ColumnCollection::offsetUnset() — Method in class ColumnCollection
ObserverClass in namespace Sofa\Eloquence\Validable

P

Builder::prefixColumnsForJoin() — Method in class Builder
Prefix selected columns with table name in order to avoid collisions.
Builder::pluck() — Method in class Builder
Pluck a single column from the database.
Eloquence::parseMappedColumn() — Method in class Eloquence
PipelineClass in namespace Sofa\Eloquence\Contracts
ParserClass in namespace Sofa\Eloquence\Contracts\Searchable
Parser::parseQuery() — Method in class Parser
Parse query string into separate words with wildcards if applicable.
Parser::parseWeights() — Method in class Parser
Parse searchable columns.
ParserFactoryClass in namespace Sofa\Eloquence\Contracts\Searchable
Eloquence::parseMappedColumn() — Method in class Eloquence
Get the target relation and column from the mapping.
PipelineClass in namespace Sofa\Eloquence\Pipeline
ParserClass in namespace Sofa\Eloquence\Searchable
Parser::parseWeights() — Method in class Parser
Parse searchable columns.
Parser::parseQuery() — Method in class Parser
Parse query string into separate words with wildcards if applicable.
ParserFactoryClass in namespace Sofa\Eloquence\Searchable
ServiceProvider::provides() — Method in class ServiceProvider
Get the services provided by the provider.

Q

Eloquence::queryHook() — Method in class Eloquence
Allow custom where method calls on the builder.
Mappable::queryHookMappable() — Method in class Mappable
Register hook on customWhere method.
Metable::queryHookMetable() — Method in class Metable
Register hook on queryHook method.

R

Builder::rightJoinRelations() — Method in class Builder
Right join related tables.
Eloquence::replicate() — Method in class Eloquence
Register hook for replicate.
Metable::replicateMetable() — Method in class Metable
Register hook on replicate method.
AttributeBag::replicate() — Method in class AttributeBag
Create copy of the attribute bag.
Joiner::rightJoin() — Method in class Joiner
Right join related tables.
ServiceProvider::register() — Method in class ServiceProvider
Register the service provider.

S

ArgumentBag::set() — Method in class ArgumentBag
Set value at given key.
Observer::saving() — Method in class Observer
Saving event handler.
Builder::search() — Method in class Builder
Search through any columns on current table or any defined relations and return results ordered by search relevance.
Builder::setParserFactory() — Method in class Builder
Set search query parser factory instance.
Builder::setJoinerFactory() — Method in class Builder
Set the relations joiner factory instance.
Builder::select() — Method in class Builder
Set the columns to be selected.
Builder::sum() — Method in class Builder
Retrieve the sum of the values of a given column.
Attribute::setValue() — Method in class Attribute
Set value of the meta attribute.
AttributeBag::set() — Method in class AttributeBag
Mappable::setAttribute() — Method in class Mappable
Metable::setAttribute() — Method in class Metable
Metable::setMeta() — Method in class Metable
Pipeline::send() — Method in class Pipeline
Specify the parcel to be passed through pipeline.
Parser::stripWildcards() — Method in class Parser
Strip wildcard tokens from the word.
Validable::skipsValidation() — Method in class Validable
Eloquence::setAttributeMutator() — Method in class Eloquence
Set attribute mutator instance.
Eloquence::setAttribute() — Method in class Eloquence
Register hook for setAttribute.
Eloquence::save() — Method in class Eloquence
Register hook for save.
Mappable::setAttributeMappable() — Method in class Mappable
Register hook on setAttribute method.
Mappable::saveMappable() — Method in class Mappable
Register hook on save method.
Metable::setAttributeMetable() — Method in class Metable
Register hook on setAttribute method.
Metable::saveMetable() — Method in class Metable
Register hook on save method.
Metable::setMeta() — Method in class Metable
Set meta attribute.
Attribute::setValue() — Method in class Attribute
Set value of the meta attribute.
Attribute::setCustomTable() — Method in class Attribute
Set custom table for the meta attributes. Allows doing it only once in order to mimic protected behaviour, most likely in the service provider, which in turn gets the table name from configuration.
AttributeBag::set() — Method in class AttributeBag
Add or update attribute.
$MutableProperty in class Mutable
array$setterMutators
Mutable::setAttributeMutable() — Method in class Mutable
Register hook on setAttribute method.
Pipeline::send() — Method in class Pipeline
Parser::stripWildcards() — Method in class Parser
Strip wildcard tokens from the word.
SearchableClass in namespace Sofa\Eloquence\Searchable
SubqueryClass in namespace Sofa\Eloquence\Searchable
ServiceProviderClass in namespace Sofa\Eloquence
SubqueryClass in namespace Sofa\Eloquence
Subquery::setQuery() — Method in class Subquery
Set underlying query builder.
Subquery::setAlias() — Method in class Subquery
Set subquery alias.
Validable::skipValidation() — Method in class Validable
Skip validation on the next saving attempt.
Validable::skipsValidation() — Method in class Validable
Get current validation flag.
Validable::setValidatorFactory() — Method in class Validable
Set validation factory instance for this model.
Observer::saved() — Method in class Observer
Enable validation for the model if skipped only once.

T

Pipeline::through() — Method in class Pipeline
Specify the actions the parcel will be passed through.
Pipeline::to() — Method in class Pipeline
Dispatch the parcel and call the final callback at the end.
Eloquence::toArray() — Method in class Eloquence
Register hook for toArray.
Metable::toArrayMetable() — Method in class Metable
Register hook on toArray method.
$AttributeProperty in class Attribute
Indicates if the model should be timestamped.
Mutable::toArrayMutable() — Method in class Mutable
Register hook on toArray method.
Pipeline::through() — Method in class Pipeline
Pipeline::to() — Method in class Pipeline

U

CreateMetaAttributesTable::up() — Method in class CreateMetaAttributesTable
Run the migrations.
Observer::updating() — Method in class Observer
Updating event handler.

V

ValidableClass in namespace Sofa\Eloquence\Contracts
Validable::validationEnabled() — Method in class Validable
ValidableClass in namespace Sofa\Eloquence
Validable::validationEnabled() — Method in class Validable
Determine whether validation is enabled for this instance.

W

Builder::where() — Method in class Builder
Add where constraint to the query.
Builder::whereBetween() — Method in class Builder
Add a where between statement to the query.
Builder::whereNotBetween() — Method in class Builder
Add a where not between statement to the query.
Builder::whereIn() — Method in class Builder
Add a "where in" clause to the query.
Builder::whereNotIn() — Method in class Builder
Add a "where not in" clause to the query.
Builder::whereNull() — Method in class Builder
Add a "where null" clause to the query.
Builder::whereNotNull() — Method in class Builder
Add a "where not null" clause to the query.
Builder::whereDate() — Method in class Builder
Add a "where date" statement to the query.
Builder::whereDay() — Method in class Builder
Add a "where day" statement to the query.
Builder::whereMonth() — Method in class Builder
Add a "where month" statement to the query.
Builder::whereYear() — Method in class Builder
Add a "where year" statement to the query.
Builder::whereExists() — Method in class Builder
Add an exists clause to the query.
Pipeline::with() — Method in class Pipeline
Add the arguments to be passed along with the parcel.
Pipeline::with() — Method in class Pipeline

_

ArgumentBag::__construct() — Method in class ArgumentBag
Create new bag.
Eloquence::__isset() — Method in class Eloquence
Register hook for isset call.
Eloquence::__unset() — Method in class Eloquence
Register hook for isset call.
Mappable::__issetMappable() — Method in class Mappable
Register hook on isset call.
Mappable::__unsetMappable() — Method in class Mappable
Register hook on unset call.
Metable::__issetMetable() — Method in class Metable
Register hook on isset call.
Metable::__unsetMetable() — Method in class Metable
Register hook on unset call.
Attribute::__construct() — Method in class Attribute
Create new attribute instance.
Attribute::__toString() — Method in class Attribute
Handle dynamic casting to string.
AttributeBag::__construct() — Method in class AttributeBag
Create new AttributeBag.
AttributeBag::__set() — Method in class AttributeBag
Handle dynamic properties.
AttributeBag::__get() — Method in class AttributeBag
Handle dynamic properties.
AttributeBag::__isset() — Method in class AttributeBag
Handle isset calls.
AttributeBag::__unset() — Method in class AttributeBag
Handle unset calls.
Pipeline::__construct() — Method in class Pipeline
Create new pipeline.
Joiner::__construct() — Method in class Joiner
Create new joiner instance.
Column::__construct() — Method in class Column
Create new searchable column instance.
ColumnCollection::__construct() — Method in class ColumnCollection
Create new searchable columns collection.
Parser::__construct() — Method in class Parser
Create new parser instance.
Subquery::__construct() — Method in class Subquery
Create new subquery instance.
Subquery::__set() — Method in class Subquery
Pass property calls to the underlying builder.
Subquery::__get() — Method in class Subquery
Pass property calls to the underlying builder.
Subquery::__call() — Method in class Subquery
Pass method calls to the underlying builder.