rebelcode / expression-wp-query-builder-abstract
Abstract functionality for building WP_Query args using expressions.
Requires
- php: ^5.4 | ^7.0
- dhii/expression-interface: ^0.2
- dhii/sql-interface: ^0.1
Requires (Dev)
- codeclimate/php-test-reporter: <=0.3.2
- dhii/php-cs-fixer-config: ^0.1
- dhii/stringable-interface: ^0.1
- phpunit/phpunit: ^4.8
- ptrofimov/xpmock: ^1.1
This package is auto-updated.
Last update: 2024-10-10 23:11:24 UTC
README
Abstract functionality for building WP_Query
args using expressions.
Details
This package provides abstract functionality for the most implementation aspects of building WP_Query
arguments from
expressions. The traits in this package are meant to complement each other, while also remaining agnostic of the each
other's implementation details. Most, if not all, traits are designed to provide functionality that depends on
abstracted methods. Other traits in the package will offer implementations for those abstracted methods, while also
depending on their own abstracted methods.
Traits
BuildWpQueryArgsCapableTrait
👁️ Build Args
Intended to provide the entry point functionality of building an expression into WP_Query
args by attempting to
build each expression term as either a comparison, meta query relation entry or taxonomy query relation entry.
- Required implementations:
_buildWpQueryCompare()
- fulfilled byBuildWpQueryCompareCapableTrait
_buildWpQueryMetaRelation()
- fulfilled indirectly byBuildWpQueryRelationTermCapableTrait
_buildWpQueryTaxTelation()
- fulfilled indirectly byBuildWpQueryRelationTermCapableTrait
BuildWpQueryCompareCapableTrait
👁️ Build Comparison
Provides functionality for building top-level comparison key-value pairs.
- Required implementations:
_getWpQueryCompareKey()
_getWpQueryCompareValue()
- Complements:
BuildWpQueryRelationCapableTrait
👁️ Build Relation
Provides functionality for building relation arrays.
- Required implementations:
_getWpQueryRelationOperator()
- fullfilled byGetWpQueryRelationOperatorCapableTrait
_buildWpQueryRelationTerm()
- fulfilled byBuildWpQueryRelationTermCapableTrait
- Complements:
BuildWpQueryRelationTermCapableTrait
👁️ Build Relation Term
Provides functionality for building the terms in a relation array, by delegating building mechanism used depending on the current relation context, i.e. meta_query
relation or tax_query
relation.
- Required implementations:
_buildWpQueryMetaCompare()
- fulfilled byBuildWpQueryMetaCompareCapableTrait
_buildWpQueryTaxCompare()
- fulfilled byBuildWpQueryTaxCompareCapableTrait
- Complements
BuildWpQueryMetaCompareCapableTrait
👁️ Build Meta Comparison
Provides functionality for building meta comparison arrays.
- Required implementations:
_getWpQueryMetaCompareKey()
_getWpQueryMetaCompareValue()
_getWpQueryMetaCompareType()
- fulfilled byGetWpQueryMetaCompareTypeCapableTrait
_getWpQueryMetaCompareOperator()
- fulfilled byGetWpQueryMetaCompareOperatorCapableTrait
- Complements:
BuildWpQueryTaxCompareCapableTrait
👁️ Build Taxonomy Comparison
Provides functionality for building taxonomy comparison arrays.
- Required implementations:
_getWpQueryTaxCompareTaxonomy()
_getWpQueryTaxCompareField()
_getWpQueryTaxCompareTerms()
_getWpQueryTaxCompareOperator()
- fulfilled byGetWpQueryTaxCompareOperatorCapableTrait
- Complements:
GetWpQueryMetaCompareOperatorCapableTrait
👁️ Get Meta Comparison Operator
Provides functionality for resolving the meta comparison compare type from an expression.
- Complements:
GetWpQueryMetaCompareTypeCapableTrait
👁️ Get Meta Comparison Type
Provides functionality for resolving the meta comparison value cast type from an expression.
- Required implementations:
_getWpQueryMetaCompareValue()
- Complements:
GetWpQueryTaxCompareOperatorCapableTrait
👁️ Get Taxonomy Comparison Operator
Provides functionality for resolving the taxonomy comparison operator from an expression.
- Complements:
GetWpQueryRelationOperatorCapableTrait
👁️ Get Relation Operator
Provides functionality for resolving the relation operator ("AND" or "OR") from an expression.
- Complements:
If all of the above traits are brought together, the implementing class is only required to implement the following:
_buildWpQueryMetaRelation()
- recommended to redirect tobuildWpQueryRelation
with a "meta" mode._buildWpQueryTaxRelation()
- recommended to redirect tobuildWpQueryRelation
with a "tax" mode._getWpQueryCompareKey()
- recommended to search the expression for aVariableTermInterface
or anEntityFieldInterface
and retrieve the field._getWpQueryCompareValue()
- recommended to search the expression for aLiteralTermInterface
._getWpQueryMetaCompareKey()
- recommended to search the expression for aVariableTermInterface
or anEntityFieldInterface
and retrieve the field._getWpQueryMetaCompareValue()
- recommended to search the expression for aLiteralTermInterface
._getWpQueryTaxCompareTaxonomy()
- recommended to search the expression for anEntityFieldInterface
and retrieve the entity._getWpQueryTaxCompareField()
- recommended to search the expression for anEntityFieldInterface
and retrieve the field._getWpQueryTaxCompareTerms()
- recommended to search the expression for aLiteralTermInterface
.