HasFilterString

This trait defines the date filter helpers.

Models::PLACES => fn( ContainerInterface $container ) => new Documents
(
    $container ,
    Collections::PLACES ,
    [
        ...
        AQL::FILTERS =>
        [
             Prop::NAME => FilterType::STRING ,
             ...
        ]
        ...

Tags

example

?filter={ "key":"name" , "val":"ekameleon" }

Filter with the basic operators

?filter={ "key":"name" , "val":"ekameleon"      , "op":"eq"    } // equals (default)
?filter={ "key":"name" , "val":"ekameleon"      , "op":"ne"    } // not equals
?filter={ "key":"name" , "val":"ekameleon"      , "op":"gt"    } // greater than
?filter={ "key":"name" , "val":"ekameleon"      , "op":"ge"    } // greater than or equals
?filter={ "key":"name" , "val":"ekameleon"      , "op":"lt"    } // less than
?filter={ "key":"name" , "val":"ekameleon"      , "op":"le"    } // less than or equals
?filter={ "key":"name" , "val":"eka%"           , "op":"like"  } // like
?filter={ "key":"name" , "val":"eka%"           , "op":"nlike" } // not like
?filter={ "key":"name" , "val":"leon"           , "op":"ew"    } // ends with   -> RIGHT(doc.name, CHAR_LENGTH("leon")) == "leon"
?filter={ "key":"name" , "val":"ekam"           , "op":"sw"    } // starts with -> STARTS_WITH(doc.name, "ekam")
?filter={ "key":"name" , "val":["eka","meleon"] , "op":"in"    } // in          -> doc.name IN @value
?filter={ "key":"name" , "val":["eka","meleon"] , "op":"nin"   } // not in      -> doc.name NOT IN @value
?filter={ "key":"name" , "val":"mele"           , "op":"contains" } // contains -> CONTAINS(doc.name, "mele")
?filter={ "key":"name" , "val":"^eka.*on$"      , "op":"regex" }    // regex    -> REGEX_TEST(doc.name, "^eka.*on$")

Negated function-form operators (prefix n) wrap their positive form in !( … ):

?filter={ "key":"name" , "val":"ekam" , "op":"nsw" }       // not starts with -> !(STARTS_WITH(doc.name, "ekam"))
?filter={ "key":"name" , "val":"leon" , "op":"new" }       // not ends with   -> !(RIGHT(doc.name, CHAR_LENGTH("leon")) == "leon")
?filter={ "key":"name" , "val":"mele" , "op":"ncontains" } // not contains    -> !(CONTAINS(doc.name, "mele"))
?filter={ "key":"name" , "val":"^x"   , "op":"nregex" }    // not regex       -> !(REGEX_TEST(doc.name, "^x"))

Use functions to transform the document property before the conditional evaluation.

?filter={ "key":"name" , "val":"EKAMELEON" , "alt":"upper" } // UPPER(value) == "EKAMELEON"
?filter={ "key":"name" , "val":"ekameleon" , "alt":"lower" } // LOWER(value) == "ekameleon"
?filter={ "key":"name" , "val":"ekameleon" , "alt":"trim" , type:0 } // TRIM(value,type)
?filter={ "key":"name" , "val":9           , "alt":"length" } // LENGTH(value) == 9

Table of Contents

Methods

prepareFilterEndsWith()  : string

Builds an `ew` (ends with) string filter.

prepareFilterString()  : string

Prepares the filter clause with a string attribute.

RIGHT(doc.name, CHAR_LENGTH(@value)) == @value