arWhere Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for arWhere:

Collaboration diagram for arWhere:

Public Member Functions
	asSQLStatement (ActiveRecord $activeRecord, ilDBInterface $db)
	setFieldname (string $fieldname)
	getFieldname ()
	setOperator (string $operator)
	getOperator ()
	setValue ($value)
	getValue ()
	setType (int $type)
	getType ()
	setStatement (string $statement)
	getStatement ()
	setLink (string $link)
	getLink ()
Public Member Functions inherited from arStatement
	asSQLStatement (ActiveRecord $activeRecord, ilDBInterface $db)
	getTableNameAs ()
	setTableNameAs (string $table_name_as)

Data Fields
const	TYPE_STRING = 1
const	TYPE_REGULAR = 2

Protected Attributes
int	$type = self::TYPE_REGULAR
string	$fieldname = ''
	$value
string	$operator='='
string	$statement = ''
string	$link = 'AND'
Protected Attributes inherited from arStatement
string	$table_name_as = ''

Additional Inherited Members
Protected Member Functions inherited from arStatement
	wrapFields (array $fields, ilDBInterface $db)
	wrapField (string $field, ilDBInterface $db)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class arWhere

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

2.0.7

Definition at line 24 of file class.arWhere.php.

Member Function Documentation

asSQLStatement()

arWhere::asSQLStatement	(	ActiveRecord	$activeRecord,
		ilDBInterface	$db
	)

Parameters

ilDBInterface

$db

Build WHERE Statement

Exceptions

arException

Definition at line 43 of file class.arWhere.php.

References $value, ActiveRecord\getArConnector(), ActiveRecord\getArFieldList(), ActiveRecord\getConnectorContainerName(), getFieldname(), getOperator(), getStatement(), getType(), getValue(), setOperator(), and setStatement().

                                                                                 : string
    {
        $type = null;
        if ($this->getType() === self::TYPE_REGULAR) {
            $arField = $activeRecord->getArFieldList()->getFieldByName($this->getFieldname());
            $type = 'text';
            if ($arField instanceof arField) {
                $type = $arField->getFieldType();
                $statement = $activeRecord->getConnectorContainerName() . '.' . $this->getFieldname();
            } else {
                $statement = $this->getFieldname();
            }

            if (is_array($this->getValue())) {
                if (in_array($this->getOperator(), ['IN', 'NOT IN', 'NOTIN'])) {
                    $statement .= ' ' . $this->getOperator() . ' (';
                } else {
                    $statement .= ' IN (';
                }
                $values = [];
                foreach ($this->getValue() as $value) {
                    $values[] = $activeRecord->getArConnector()->quote($value, $type);
                }
                $statement .= implode(', ', $values);
                $statement .= ')';
            } else {
                if ($this->getValue() === null) {
                    $operator = 'IS';
                    if (in_array($this->getOperator(), ['IS', 'IS NOT'])) {
                        $operator = $this->getOperator();
                    }
                    $this->setOperator($operator);
                }
                $statement .= ' ' . $this->getOperator();
                $statement .= ' ' . $activeRecord->getArConnector()->quote($this->getValue(), $type);
            }
            $this->setStatement($statement);
        }

        return $this->getStatement();
    }

Here is the call graph for this function:

getFieldname()

arWhere::getFieldname

(

)

Definition at line 90 of file class.arWhere.php.

References $fieldname.

Referenced by asSQLStatement().

                                  : string
    {
        return $this->fieldname;
    }

Here is the caller graph for this function:

getLink()

arWhere::getLink

(

)

Definition at line 146 of file class.arWhere.php.

References $link.

                             : string
    {
        return $this->link;
    }

getOperator()

arWhere::getOperator

(

)

Definition at line 100 of file class.arWhere.php.

Referenced by asSQLStatement().

                                 : string
    {
        return $this->operator;
    }

Here is the caller graph for this function:

getStatement()

arWhere::getStatement

(

)

Definition at line 136 of file class.arWhere.php.

References $statement.

Referenced by asSQLStatement().

                                  : string
    {
        return $this->statement;
    }

Here is the caller graph for this function:

getType()

arWhere::getType

(

)

Definition at line 126 of file class.arWhere.php.

References $type.

Referenced by asSQLStatement().

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

getValue()

arWhere::getValue

(

)

Returns

mixed|null

Definition at line 116 of file class.arWhere.php.

References $value.

Referenced by asSQLStatement().

    {
        return $this->value;
    }

Here is the caller graph for this function:

setFieldname()

arWhere::setFieldname

(

string

$fieldname

)

Definition at line 85 of file class.arWhere.php.

References $fieldname.

                                                   : void
    {
        $this->fieldname = $fieldname;
    }

setLink()

arWhere::setLink

(

string

$link

)

Definition at line 141 of file class.arWhere.php.

References $link.

                                         : void
    {
        $this->link = $link;
    }

setOperator()

arWhere::setOperator

(

string

$operator

)

Definition at line 95 of file class.arWhere.php.

Referenced by asSQLStatement().

                                                 : void
    {
        $this->operator = $operator;
    }

Here is the caller graph for this function:

setStatement()

arWhere::setStatement

(

string

$statement

)

Definition at line 131 of file class.arWhere.php.

References $statement.

Referenced by asSQLStatement().

                                                   : void
    {
        $this->statement = $statement;
    }

Here is the caller graph for this function:

setType()

arWhere::setType

(

int

$type

)

Definition at line 121 of file class.arWhere.php.

References $type.

                                      : void
    {
        $this->type = $type;
    }

setValue()

arWhere::setValue

(

$value

)

Parameters

mixed

$value

Definition at line 108 of file class.arWhere.php.

References $value.

                                    : void
    {
        $this->value = $value;
    }

Field Documentation

$fieldname

string arWhere::$fieldname = ''

protected

Definition at line 29 of file class.arWhere.php.

Referenced by getFieldname(), and setFieldname().

$link

string arWhere::$link = 'AND'

protected

Definition at line 36 of file class.arWhere.php.

Referenced by getLink(), and setLink().

$operator='='

string arWhere::$operator='='

protected

Definition at line 34 of file class.arWhere.php.

$statement

string arWhere::$statement = ''

protected

Definition at line 35 of file class.arWhere.php.

Referenced by getStatement(), and setStatement().

$type

int arWhere::$type = self::TYPE_REGULAR

protected

Definition at line 28 of file class.arWhere.php.

Referenced by getType(), and setType().

$value

arWhere::$value

protected

Definition at line 33 of file class.arWhere.php.

Referenced by asSQLStatement(), getValue(), and setValue().

TYPE_REGULAR

const arWhere::TYPE_REGULAR = 2

Definition at line 27 of file class.arWhere.php.

TYPE_STRING

const arWhere::TYPE_STRING = 1

Definition at line 26 of file class.arWhere.php.

Referenced by ActiveRecordList\where().

---

The documentation for this class was generated from the following file:

• Services/ActiveRecord/Connector/Where/class.arWhere.php