phramework doc
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • Phramework
    • Authentication
    • Database
      • Operations
    • Exceptions
    • Extensions
    • Models
    • URIStrategy
    • Validate
    • Viewers

Classes

  • Cache
  • Compress
  • Email
  • Execute
  • Filter
  • Language
  • Operator
  • Request
  • Response
  • Upload
  • Util

Class Operator

Operator's related model

Namespace: Phramework\Models
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 1.0.0
Located at Models/Operator.php

Methods summary

public static string[]
# getOperators( )

Returns

string[]

Since

1.2.0
public static string
# validate( string $operator, string $attributeName = 'operator' )

Check if a string is a valid operator

Check if a string is a valid operator

Parameters

$operator
$attributeName
[Optional] Attribute's name, used for thrown exception

Returns

string
Returns the operator

Throws

Phramework\Exceptions\IncorrectParametersException
public static integer
# getByClassFlags( integer $classFlags )

Get operators

Get operators

Parameters

$classFlags

Returns

integer
Operator class

Throws

Exception
When invalid operator class flags are given
public static string[2]
# parse( string $operatorValueString )

Parameters

$operatorValueString

Returns

string[2]
[operator, operand]

Example

list($operator, $operand) = Operator::parse('>=5');
public static string[]
# getNullableOperators( )

Returns

string[]
public static string[]
# getLikeOperators( )

Returns

string[]
public static string[]
# getEqualityOperators( )

Returns

string[]
public static string[]
# getInArrayOperators( )

Returns

string[]
public static string[]
# getOrderableOperators( )

Returns

string[]

Constants summary

string OPERATOR_ISSET
# 'isset'
string OPERATOR_NOT_ISSET
# '!isset'
string OPERATOR_GREATER
# '>'
string OPERATOR_GREATER_EQUAL
# '>='
string OPERATOR_LESS
# '<'
string OPERATOR_LESS_EQUAL
# '<='
string OPERATOR_EQUAL
# '='
string OPERATOR_NOT_EQUAL
# '!='
string OPERATOR_ISNULL
# 'ISNULL'
string OPERATOR_NOT_ISNULL
# '!ISNULL'
string OPERATOR_EMPTY
# 'empty'
string OPERATOR_NOT_EMPTY
# '!empty'
string OPERATOR_LIKE
# '~~'
string OPERATOR_NOT_LIKE
# '!~~'
string OPERATOR_IN
# 'IN'
string OPERATOR_NOT_IN
# 'NOT IN'
string OPERATOR_IN_ARRAY

∈, is an element of array (URL encoded : %E2%88%88")

∈, is an element of array (URL encoded : %E2%88%88")

# '∈'
string OPERATOR_NOT_IN_ARRAY

∉, is not an element of array (URL encoded : %E2%88%89)

∉, is not an element of array (URL encoded : %E2%88%89)

# '∉'
integer CLASS_COMPARABLE
# 1
integer CLASS_ORDERABLE
# 2
integer CLASS_LIKE
# 4
integer CLASS_IN_ARRAY
# 32
integer CLASS_NULLABLE
# 64
integer CLASS_JSONOBJECT
# 128

Properties summary

protected static string[] $operators
# [ Operator::OPERATOR_EMPTY, Operator::OPERATOR_EQUAL, Operator::OPERATOR_GREATER, Operator::OPERATOR_GREATER_EQUAL, Operator::OPERATOR_ISSET, Operator::OPERATOR_LESS, Operator::OPERATOR_LESS_EQUAL, Operator::OPERATOR_NOT_EMPTY, Operator::OPERATOR_NOT_EQUAL, Operator::OPERATOR_NOT_ISSET, Operator::OPERATOR_ISNULL, Operator::OPERATOR_NOT_ISNULL, Operator::OPERATOR_IN, Operator::OPERATOR_NOT_IN, Operator::OPERATOR_LIKE, Operator::OPERATOR_NOT_LIKE, Operator::OPERATOR_IN_ARRAY, Operator::OPERATOR_NOT_IN_ARRAY ]
phramework doc API documentation generated by ApiGen