Index
A
- AbstractConstraint — Class in namespace SehrGut\Eloquery\Constraints
- $ AbstractConstraint#attribute — Property in class AbstractConstraint
- The attribute that we're comparing.
- AbstractConstraint::applyToBuilder() — Method in class AbstractConstraint
- Apply the operation to the query builder.
- Operation::applyToBuilder() — Method in class Operation
- Apply the operation to a query builder.
- Eloquery::apply() — Method in class Eloquery
- Apply query params from the request to given query builder.
- Eloquery::allowFilterKeys() — Method in class Eloquery
- Set the filter whitelist.
- Eloquery::allowIncludes() — Method in class Eloquery
- Set the include whitelist.
- AbstractExtractor — Class in namespace SehrGut\Eloquery\Extractors
- AbstractGrammar — Class in namespace SehrGut\Eloquery\Grammar
- FilterGrammar::applyWhitelist() — Method in class FilterGrammar
- Drop all items that are not contained in the whitelist.
- OperationCollection::add() — Method in class OperationCollection
- Add one or more operations to the collection.
- OperationCollection::applyToBuilder() — Method in class OperationCollection
- Apply all operations in the collection to the builder.
- OperationCollection::append() — Method in class OperationCollection
- Add an operation to the collection.
- $ Filter#attribute — Property in class Filter
- The attribute name that this filter compares.
- Filter::applyToBuilder() — Method in class Filter
- Apply the filter to a query builder.
- Filter::apply() — Method in class Filter
- Apply the filter to a query builder (not checking for relationship).
- Filter::actsOnRelation() — Method in class Filter
- Determine if the filter acts on a relation (as opposed to the model we're querying for).
- Paginate::applyToBuilder() — Method in class Paginate
- Apply the pagination constraints to a query builder.
- $ Search#attributes — Property in class Search
- The model attributes by which to filter.
- Search::applyToBuilder() — Method in class Search
- Apply the search filter to a query builder.
- Sideload::applyToBuilder() — Method in class Sideload
- Apply the sideload to a query builder.
- $ Sort#attribute — Property in class Sort
- The attribute that is sorted by.
- $ Sort#ascending — Property in class Sort
- Sort direction.
- Sort::applyToBuilder() — Method in class Sort
- Apply the sort order to a query builder.
- Operators::all() — Method in class Operators
- Retrieve all possible operations.
B
- BetweenConstraint — Class in namespace SehrGut\Eloquery\Constraints
C
- ContainsConstraint — Class in namespace SehrGut\Eloquery\Constraints
- $ AbstractExtractor#config — Property in class AbstractExtractor
- Configuration options for the Extractor.
- $ AbstractGrammar#config — Property in class AbstractGrammar
- Configuration options for this Grammar instance.
- $ Filter#constraints — Property in class Filter
- Constraints by operator.
- $ RequestParser#config — Property in class RequestParser
- Configuration options.
D
- OperationCollection::dump() — Method in class OperationCollection
- Return all contained operations.
E
- EndsWithConstraint — Class in namespace SehrGut\Eloquery\Constraints
- EqualsConstraint — Class in namespace SehrGut\Eloquery\Constraints
- Extractor — Class in namespace SehrGut\Eloquery\Contracts
- Extractor::extract() — Method in class Extractor
- Extract operations from the request.
- Grammar::extract() — Method in class Grammar
- Extract all options from the request.
- Eloquery — Class in namespace SehrGut\Eloquery
- Eloquery::extract() — Method in class Eloquery
- Extract operations from the request.
- AbstractExtractor::extract() — Method in class AbstractExtractor
- FilterExtractor::extract() — Method in class FilterExtractor
- Extract filter constraints from the request.
- PaginateExtractor::extract() — Method in class PaginateExtractor
- Extract pagination parameters from the request.
- SearchExtractor::extract() — Method in class SearchExtractor
- Extract search queries from the request.
- SideloadExtractor::extract() — Method in class SideloadExtractor
- Extract includes from the request.
- SortExtractor::extract() — Method in class SortExtractor
- Extract sort orders from the request.
- Eloquery — Class in namespace SehrGut\Eloquery\Facades
- AbstractGrammar::extract() — Method in class AbstractGrammar
- FilterGrammar::extract() — Method in class FilterGrammar
- Extract an array of filter options from the request.
- PaginateGrammar::extract() — Method in class PaginateGrammar
- Extract pagination parameters from a request.
- SearchGrammar::extract() — Method in class SearchGrammar
- Extract search queries from the request.
- SideloadGrammar::extract() — Method in class SideloadGrammar
- Extract an array of included relationships from the request.
- SortGrammar::extract() — Method in class SortGrammar
- Extract an array of sort options from the request.
- Operators::exists() — Method in class Operators
- Check if given operation exists / is defined.
- EloqueryServiceProvider — Class in namespace SehrGut\Eloquery\Providers
- RequestParser::extract() — Method in class RequestParser
- Extract all query Operations from the request.
F
- Eloquery::from() — Method in class Eloquery
- Override the request from which to extract.
- FilterExtractor — Class in namespace SehrGut\Eloquery\Extractors
- FilterGrammar — Class in namespace SehrGut\Eloquery\Grammar
- Rules for extracting filter constraints from a Request.
- FilterGrammar::fillWithDefaults() — Method in class FilterGrammar
- Replace missing values with their defaults.
- SortGrammar::fillWithDefaults() — Method in class SortGrammar
- Replace missing values with their defaults.
- Filter — Class in namespace SehrGut\Eloquery\Operations
G
- AbstractConstraint::getOperator() — Method in class AbstractConstraint
- Get the operator to feed into the builder method.
- AbstractConstraint::getBuilderArguments() — Method in class AbstractConstraint
- Attributes to the builder method.
- AbstractConstraint::getBuilderMethod() — Method in class AbstractConstraint
- The method to call on the builder.
- AbstractConstraint::getPreparedValue() — Method in class AbstractConstraint
- The value transformed to match the operation.
- BetweenConstraint::getOperator() — Method in class BetweenConstraint
- Get the operator to feed into the builder method.
- BetweenConstraint::getBuilderMethod() — Method in class BetweenConstraint
- The method to call on the builder.
- ContainsConstraint::getOperator() — Method in class ContainsConstraint
- Get the operator to feed into the builder method.
- ContainsConstraint::getPreparedValue() — Method in class ContainsConstraint
- The value transformed to match the operation.
- EndsWithConstraint::getOperator() — Method in class EndsWithConstraint
- Get the operator to feed into the builder method.
- EndsWithConstraint::getPreparedValue() — Method in class EndsWithConstraint
- The value transformed to match the operation.
- EqualsConstraint::getOperator() — Method in class EqualsConstraint
- Get the operator to feed into the builder method.
- GreaterConstraint — Class in namespace SehrGut\Eloquery\Constraints
- GreaterConstraint::getOperator() — Method in class GreaterConstraint
- Get the operator to feed into the builder method.
- GreaterEqualConstraint — Class in namespace SehrGut\Eloquery\Constraints
- GreaterEqualConstraint::getOperator() — Method in class GreaterEqualConstraint
- Get the operator to feed into the builder method.
- InConstraint::getOperator() — Method in class InConstraint
- Get the operator to feed into the builder method.
- InConstraint::getBuilderMethod() — Method in class InConstraint
- The method to call on the builder.
- IsNotNullConstraint::getOperator() — Method in class IsNotNullConstraint
- Get the operator to feed into the builder method.
- IsNotNullConstraint::getBuilderMethod() — Method in class IsNotNullConstraint
- The method to call on the builder.
- IsNotNullConstraint::getPreparedValue() — Method in class IsNotNullConstraint
- The value transformed to match the operation.
- IsNullConstraint::getOperator() — Method in class IsNullConstraint
- Get the operator to feed into the builder method.
- IsNullConstraint::getBuilderMethod() — Method in class IsNullConstraint
- The method to call on the builder.
- IsNullConstraint::getPreparedValue() — Method in class IsNullConstraint
- The value transformed to match the operation.
- LessConstraint::getOperator() — Method in class LessConstraint
- Get the operator to feed into the builder method.
- LessEqualConstraint::getOperator() — Method in class LessEqualConstraint
- Get the operator to feed into the builder method.
- StartsWithConstraint::getOperator() — Method in class StartsWithConstraint
- Get the operator to feed into the builder method.
- StartsWithConstraint::getPreparedValue() — Method in class StartsWithConstraint
- The value transformed to match the operation.
- Grammar — Class in namespace SehrGut\Eloquery\Contracts
- Describes a "grammar" according to which we extract structured parameters from a request.
- Parser::getConfig() — Method in class Parser
- Retrieve the configuration variables of the parser.
- AbstractExtractor::getOperationClass() — Method in class AbstractExtractor
- Get the FQN of the Operation class that this Extractor should produce.
- Eloquery::getFacadeAccessor() — Method in class Eloquery
- OperationResult::getPaginationMeta() — Method in class OperationResult
- Get the pagination metadata.
- Filter::getRelation() — Method in class Filter
- Get the relation on which to apply this filter.
- Filter::getBareAttribute() — Method in class Filter
- Get the attribute that this filter compares without relationship prefix.
- Filter::getOperation() — Method in class Filter
- Get an Operation instance for the current filter.
- RequestParser::getConfig() — Method in class RequestParser
- Retrieve the configuration variables of the parser.
I
- InConstraint — Class in namespace SehrGut\Eloquery\Constraints
- IsNotNullConstraint — Class in namespace SehrGut\Eloquery\Constraints
- IsNullConstraint — Class in namespace SehrGut\Eloquery\Constraints
- $ OperationCollection#items — Property in class OperationCollection
- Underlying array of operations.
L
- LessConstraint — Class in namespace SehrGut\Eloquery\Constraints
- LessEqualConstraint — Class in namespace SehrGut\Eloquery\Constraints
- $ Paginate#limit — Property in class Paginate
- Number of records per page.
M
- AbstractExtractor::makeGrammar() — Method in class AbstractExtractor
- Get an instance of the associated Grammar for this Extractor.
- OperationCollection::merge() — Method in class OperationCollection
- Merge another OperationCollection into this one.
- OperationResult::merge() — Method in class OperationResult
- Merge two OperationResults.
- RequestParser::makeExtractors() — Method in class RequestParser
- Instantiate the extractors.
N
- $ AbstractConstraint#negated — Property in class AbstractConstraint
- Whether the operation needs to be negated (logical not).
- $ Filter#negated — Property in class Filter
- Whether the filter is negated (logical not).
O
- Operation — Class in namespace SehrGut\Eloquery\Contracts
- Describes an operation on a Query Builder, eg. a filter constraint or sort order.
- OperationCollection — Class in namespace SehrGut\Eloquery
- OperationResult — Class in namespace SehrGut\Eloquery
- $ Filter#operator — Property in class Filter
- The filter operator.
- Operators — Class in namespace SehrGut\Eloquery
P
- Parser — Class in namespace SehrGut\Eloquery\Contracts
- PaginateExtractor — Class in namespace SehrGut\Eloquery\Extractors
- PaginateGrammar — Class in namespace SehrGut\Eloquery\Grammar
- Rules for extracting pagination parameters from a request.
- $ OperationResult#paginationMeta — Property in class OperationResult
- Pagination metadata.
- Paginate — Class in namespace SehrGut\Eloquery\Operations
- $ Paginate#page — Property in class Paginate
- Current page number (1-indexed).
Q
- $ Search#query — Property in class Search
- The string to query by.
R
- $ Eloquery#requestParser — Property in class Eloquery
- A Parser instance.
- $ Sideload#relationship — Property in class Sideload
- The relationship that should be included.
- EloqueryServiceProvider::register() — Method in class EloqueryServiceProvider
- EloqueryServiceProvider::registerConfig() — Method in class EloqueryServiceProvider
- Register and publish the config file.
- EloqueryServiceProvider::registerBindings() — Method in class EloqueryServiceProvider
- Register bindings to the service container.
- RequestParser — Class in namespace SehrGut\Eloquery
- $ RequestParser#request — Property in class RequestParser
- The request from which to extract query options.
S
- StartsWithConstraint — Class in namespace SehrGut\Eloquery\Constraints
- Parser::setConfig() — Method in class Parser
- Set config value on the parser.
- Parser::setRequest() — Method in class Parser
- Override the request.
- Eloquery::searchFields() — Method in class Eloquery
- Set the attributes to respect when searching.
- SearchExtractor — Class in namespace SehrGut\Eloquery\Extractors
- SideloadExtractor — Class in namespace SehrGut\Eloquery\Extractors
- SortExtractor — Class in namespace SehrGut\Eloquery\Extractors
- SearchGrammar — Class in namespace SehrGut\Eloquery\Grammar
- Rules for extracting search queries from a Request.
- SideloadGrammar — Class in namespace SehrGut\Eloquery\Grammar
- Rules for extracting includes from a Request.
- SortGrammar — Class in namespace SehrGut\Eloquery\Grammar
- Rules for extracting sort orders from a Request.
- OperationCollection::sortComparator() — Method in class OperationCollection
- Comparator function for sorting operations.
- Search — Class in namespace SehrGut\Eloquery\Operations
- Sideload — Class in namespace SehrGut\Eloquery\Operations
- Sort — Class in namespace SehrGut\Eloquery\Operations
- RequestParser::setConfig() — Method in class RequestParser
- Set config value on the parser.
- RequestParser::setRequest() — Method in class RequestParser
- Override the request.
V
- $ AbstractConstraint#value — Property in class AbstractConstraint
- The reference value against we're comparing the attribute.
- FilterGrammar::validate() — Method in class FilterGrammar
- Validate the extacted array.
- FilterGrammar::validateFilter() — Method in class FilterGrammar
- Validate a single filter.
- SortGrammar::validate() — Method in class SortGrammar
- Validate the extacted array.
- SortGrammar::validateSort() — Method in class SortGrammar
- Validate a single sort rule.
- $ Filter#value — Property in class Filter
- The value against which this filter compares.
_
- AbstractConstraint::__construct() — Method in class AbstractConstraint
- Construct a Constraint instance.
- Extractor::__construct() — Method in class Extractor
- Construct an Extractor instance.
- Grammar::__construct() — Method in class Grammar
- Construct a new Grammar instance.
- Parser::__construct() — Method in class Parser
- Construct a Parser instance.
- Eloquery::__construct() — Method in class Eloquery
- Construct a new instance.
- AbstractExtractor::__construct() — Method in class AbstractExtractor
- AbstractGrammar::__construct() — Method in class AbstractGrammar
- OperationCollection::__construct() — Method in class OperationCollection
- Construct a OperationCollection instance.
- OperationResult::__construct() — Method in class OperationResult
- Construct a new instance.
- Filter::__construct() — Method in class Filter
- Construct a Filter instance.
- Paginate::__construct() — Method in class Paginate
- Construct a Paginate instance.
- Search::__construct() — Method in class Search
- Construct a Sort instance.
- Sideload::__construct() — Method in class Sideload
- Construct a Sideload instance.
- Sort::__construct() — Method in class Sort
- Construct a Sort instance.
- RequestParser::__construct() — Method in class RequestParser
- Construct a RequestParser instance.