Documentation

SalutationField extends StringField
in package

Salutation Query Field Class.

Tags
copyright

YetiForce S.A.

license

YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

author

Tomasz Kur t.kur@yetiforce.com

Table of Contents

$fieldModel  : Vtiger_Field_Model
$fullColumnName  : string
$operator  : string
$queryGenerator  : QueryGenerator
$related  : array<string|int, mixed>
$tableName  : string
$value  : array<string|int, mixed>|string
__clone()  : mixed
Invoked when object is cloning.
__construct()  : mixed
Constructor.
getColumnName()  : string
Get column name.
getColumnNameFromSource()  : string
Get column name from source.
getCondition()  : array<string|int, mixed>|bool
Get condition.
getField()  : Vtiger_Field_Model
Get field model.
getListViewFields()  : bool|Vtiger_Field_Model
Get additional field model for list view.
getModuleName()  : string
Get module name.
getOperator()  : string
Gets real operator.
getOrderBy()  : array<string|int, mixed>
Get order by.
getRelated()  : array<string|int, mixed>
Get related details.
getTableName()  : string
Get table name.
getValue()  : mixed
Get value.
operatorA()  : array<string|int, mixed>
Auto operator, it allows you to use formulas: * and _.
operatorC()  : array<string|int, mixed>
Contains operator.
operatorE()  : array<string|int, mixed>
Equals operator.
operatorEf()  : array<string|int, mixed>
Is equal to selected field operator.
operatorEw()  : array<string|int, mixed>
Ends with operator.
operatorK()  : array<string|int, mixed>
Does not contain operator.
operatorN()  : array<string|int, mixed>
Not equal operator.
operatorNf()  : array<string|int, mixed>
Is not equal to selected field operator.
operatorNy()  : array<string|int, mixed>
Is not empty operator.
operatorS()  : array<string|int, mixed>
Starts with operator.
operatorWca()  : array<string|int, mixed>
Search for a specified pattern in a column.
operatorY()  : array<string|int, mixed>
Is empty operator.
setOperator()  : void
Set operator.
setRelated()  : void
Set related details.
setTableName()  : void
Set table name.
setValue()  : $this
Set value.

Properties

$fieldModel

protected Vtiger_Field_Model $fieldModel

$fullColumnName

protected string $fullColumnName

$related

protected array<string|int, mixed> $related = []

Related detail

$value

protected array<string|int, mixed>|string $value

Methods

__clone()

Invoked when object is cloning.

public __clone() : mixed
Return values
mixed —

__construct()

Constructor.

public __construct(QueryGenerator $queryGenerator[, Vtiger_Field_Model $fieldModel = false ]) : mixed
Parameters
$queryGenerator : QueryGenerator
$fieldModel : Vtiger_Field_Model = false
Return values
mixed —

getColumnName()

Get column name.

public getColumnName() : string
Return values
string —

getColumnNameFromSource()

Get column name from source.

public getColumnNameFromSource() : string
Return values
string —

getCondition()

Get condition.

public getCondition([string|null $operator = null ]) : array<string|int, mixed>|bool
Parameters
$operator : string|null = null
Return values
array<string|int, mixed>|bool —

getField()

Get field model.

public getField() : Vtiger_Field_Model
Return values
Vtiger_Field_Model —

getListViewFields()

Get additional field model for list view.

public getListViewFields() : bool|Vtiger_Field_Model
Return values
bool|Vtiger_Field_Model —

getModuleName()

Get module name.

public getModuleName() : string
Return values
string —

getOperator()

Gets real operator.

public getOperator() : string
Return values
string —

getOrderBy()

Get order by.

public getOrderBy([mixed $order = false ]) : array<string|int, mixed>
Parameters
$order : mixed = false
Return values
array<string|int, mixed> —

getRelated()

Get related details.

public getRelated() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTableName()

Get table name.

public getTableName() : string
Return values
string —

getValue()

Get value.

public getValue() : mixed
Return values
mixed —

operatorA()

Auto operator, it allows you to use formulas: * and _.

public operatorA() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorC()

Contains operator.

public operatorC() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorE()

Equals operator.

public operatorE() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorEf()

Is equal to selected field operator.

public operatorEf() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorEw()

Ends with operator.

public operatorEw() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorK()

Does not contain operator.

public operatorK() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorN()

Not equal operator.

public operatorN() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorNf()

Is not equal to selected field operator.

public operatorNf() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorNy()

Is not empty operator.

public operatorNy() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorS()

Starts with operator.

public operatorS() : array<string|int, mixed>
Return values
array<string|int, mixed> —

operatorWca()

Search for a specified pattern in a column.

public operatorWca() : array<string|int, mixed>

Wildcard - asterisk.

Return values
array<string|int, mixed> —

operatorY()

Is empty operator.

public operatorY() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setOperator()

Set operator.

public setOperator(string $operator) : void
Parameters
$operator : string
Return values
void —

setRelated()

Set related details.

public setRelated(array<string|int, mixed> $relatedInfo) : void
Parameters
$relatedInfo : array<string|int, mixed>
Return values
void —

setTableName()

Set table name.

public setTableName(string $tableName) : void
Parameters
$tableName : string
Return values
void —

setValue()

Set value.

public setValue(mixed $value) : $this
Parameters
$value : mixed
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results