icecave/dialekt

This package is abandoned and no longer maintained. The author suggests using the dialekt/dialekt package instead.

A simple language for representing boolean expressions.

0.1.0 2014-05-30 03:53 UTC

Requires

• php: >=5.3

Requires (Dev)

• icecave/archer: ~1

Suggests

• eloquent/asplode: Drop-in exception-based error handling.

MIT

• James Harris

• parser
• search
• logic
• tag
• expression
• label
• boolean
• logical

README

This project has been deprecated by the authors. Use dialekt/dialekt instead.

Dialekt is a very simple language for representing boolean expressions of the form often used by search engines.

composer require icecave/dialekt

Rationale and Concepts

Dialekt was devised for specifing filters for lists of objects based on sets of human-readable "tags" or "labels". This PHP package provides an expression parser which parses Dialekt expressions into an abstract syntax tree, a list parser which parses lists of tags into arrays, and an evaluator which checks if a given set of tags matches a particular expression.

Additionally, the nodes of the abstract syntax tree implement the visitor pattern, allowing the creation of new algorithms that traverse the syntax tree. This could be used, for example, to generate an SQL query that finds entities with tags that match the expression.

Syntax

Below is an example of a Dialekt expression showing the available language features. You can see how this expression is parsed using the online demo.

foo bar AND (baz OR qux) AND NOT "doom hammer"

In the above example, foo, bar, baz, qux and "doom hammer" are examples of tags. The tag is the most basic syntactic element of an expression. An expression is composed of one or more tags, and the logical operators AND, OR and NOT. The logical operators are case-insensitive.

Tags may be formed by any non-whitespace characters except the parentheses and asterisk characters. Tags may optionally be enclosed in double-quotes, as the doom hammer tag has been in the example above. Doing so allows the inclusion of parentheses and whitespace characters. Tags must also be enclosed in double-quotes if they are one of the reserved words AND, OR or NOT. Inside a quoted tag the backslash character provides escaping functionality similar to a double-quoted PHP string.

Implicit AND operator

When one tag is directly adjacent to another (as foo and bar are above) they are treated equivalent to an AND, thus the expression foo bar baz is equivalent to foo AND bar AND baz.

Grouping and operator precedence

Sub-expressions can be grouped using parenthesis to control evaluation order, as baz and qux have been in the example above.

When parenthesis are not present, the AND operator has higher precedence than OR such that foo OR bar AND baz is equivalent to foo OR (bar AND baz).