Inheritance diagram for arJoin:

Collaboration diagram for arJoin:

Public Member Functions
	asSQLStatement (ActiveRecord $ar)

	setLeft ()

	setRght ()

	setInner ()

	setFields ($fields)

	getFields ()

	setOnFirstField ($on_first_field)

	getOnFirstField ()

	setOnSecondField ($on_second_field)

	getOnSecondField ()

	setOperator ($operator)

	getOperator ()

	setTableName ($table_name)

	getTableName ()

	setType ($type)

	getType ()

	setBothExternal ($both_external)

	getBothExternal ()

	setFullNames ($full_names)

	getFullNames ()

	isIsMapped ()

	setIsMapped ($is_mapped)

Public Member Functions inherited from arStatement
	asSQLStatement (ActiveRecord $ar)

	getTableNameAs ()

	setTableNameAs ($table_name_as)

Data Fields
const	TYPE_NORMAL = self::TYPE_INNER

const	TYPE_LEFT = 'LEFT'

const	TYPE_RIGHT = 'RIGHT'

const	TYPE_INNER = 'INNER'

Protected Attributes
	$type = self::TYPE_NORMAL

	$table_name = ''

	$fields = array( '*' )

	$operator = '='

	$on_first_field = ''

	$on_second_field = ''

	$full_names = false

	$both_external = false

	$is_mapped = false

Protected Attributes inherited from arStatement
	$table_name_as = ''

Detailed Description

Class arJoin.

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

Version: 2.0.7

Definition at line 11 of file class.arJoin.php.

Member Function Documentation

◆ asSQLStatement()

arJoin::asSQLStatement ( ActiveRecord $ar )

Parameters

ActiveRecord $ar

Returns: string

Reimplemented from arStatement.

Definition at line 60 of file class.arJoin.php.

                                                         {
                $return = ' ' . $this->getType() . ' ';
                $return .= ' JOIN ' . $this->getTableName() . ' AS ' . $this->getTableNameAs();
                if ($this->getBothExternal()) {
                        $return .= ' ON ' . $this->getOnFirstField() . ' ' . $this->getOperator() . ' ';
                } else {
                        $return .= ' ON ' . $ar->getConnectorContainerName() . '.' . $this->getOnFirstField() . ' ' . $this->getOperator() . ' ';
                }
                $return .= $this->getTableNameAs() . '.' . $this->getOnSecondField();
 
                return $return;
        }

References getBothExternal(), ActiveRecord\getConnectorContainerName(), getOnFirstField(), getOnSecondField(), getOperator(), getTableName(), arStatement\getTableNameAs(), and getType().

Here is the call graph for this function:

◆ getBothExternal()

arJoin::getBothExternal ( )

Returns: boolean

Definition at line 196 of file class.arJoin.php.

                                          {
                return $this->both_external;
        }

References $both_external.

Referenced by asSQLStatement().

Here is the caller graph for this function:

◆ getFields()

arJoin::getFields ( )

Returns: array

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

                                    {
                return $this->fields;
        }

References $fields.

◆ getFullNames()

arJoin::getFullNames ( )

Returns: boolean

Definition at line 212 of file class.arJoin.php.

                                       {
                return $this->full_names;
        }

References $full_names.

◆ getOnFirstField()

arJoin::getOnFirstField ( )

Returns: string

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

                                          {
                return $this->on_first_field;
        }

References $on_first_field.

Referenced by asSQLStatement().

Here is the caller graph for this function:

◆ getOnSecondField()

arJoin::getOnSecondField ( )

Returns: string

Definition at line 132 of file class.arJoin.php.

                                           {
                return $this->on_second_field;
        }

References $on_second_field.

Referenced by asSQLStatement().

Here is the caller graph for this function:

◆ getOperator()

arJoin::getOperator ( )

Returns: string

Definition at line 148 of file class.arJoin.php.

                                      {
                return $this->operator;
        }

References $operator.

Referenced by asSQLStatement().

Here is the caller graph for this function:

◆ getTableName()

arJoin::getTableName ( )

Returns: string

Definition at line 164 of file class.arJoin.php.

                                       {
                return $this->table_name;
        }

References $table_name.

Referenced by asSQLStatement(), and arJoinCollection\getSaveTableName().

Here is the caller graph for this function:

◆ getType()

arJoin::getType ( )

Returns: string

Definition at line 180 of file class.arJoin.php.

                                  {
                return $this->type;
        }

References $type.

Referenced by asSQLStatement().

Here is the caller graph for this function:

◆ isIsMapped()

arJoin::isIsMapped ( )

Returns: boolean

Definition at line 220 of file class.arJoin.php.

                                     {
                return $this->is_mapped;
        }

References $is_mapped.

◆ setBothExternal()

arJoin::setBothExternal ( $both_external )

Parameters

boolean $both_external

Definition at line 188 of file class.arJoin.php.

                                                        {
                $this->both_external = $both_external;
        }

References $both_external.

◆ setFields()

arJoin::setFields ( $fields )

Parameters

array $fields

Definition at line 92 of file class.arJoin.php.

                                           {
                $this->fields = $fields;
        }

References $fields, and fields.

◆ setFullNames()

arJoin::setFullNames ( $full_names )

Parameters

boolean $full_names

Definition at line 204 of file class.arJoin.php.

                                                  {
                $this->full_names = $full_names;
        }

References $full_names.

Referenced by arJoinCollection\getSaveTableName().

Here is the caller graph for this function:

◆ setInner()

arJoin::setInner ( )

Definition at line 84 of file class.arJoin.php.

                                   {
                $this->setType(self::TYPE_INNER);
        }

References setType().

Here is the call graph for this function:

◆ setIsMapped()

arJoin::setIsMapped ( $is_mapped )

Parameters

boolean $is_mapped

Definition at line 228 of file class.arJoin.php.

                                                {
                $this->is_mapped = $is_mapped;
        }

References $is_mapped.

Referenced by arJoinCollection\getSaveTableName().

Here is the caller graph for this function:

◆ setLeft()

arJoin::setLeft ( )

Definition at line 74 of file class.arJoin.php.

                                  {
                $this->setType(self::TYPE_LEFT);
        }

References setType().

Here is the call graph for this function:

◆ setOnFirstField()

arJoin::setOnFirstField ( $on_first_field )

Parameters

string $on_first_field

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

                                                         {
                $this->on_first_field = $on_first_field;
        }

References $on_first_field.

◆ setOnSecondField()

arJoin::setOnSecondField ( $on_second_field )

Parameters

string $on_second_field

Definition at line 124 of file class.arJoin.php.

                                                           {
                $this->on_second_field = $on_second_field;
        }

References $on_second_field.

◆ setOperator()

arJoin::setOperator ( $operator )

Parameters

string $operator

Definition at line 140 of file class.arJoin.php.

                                               {
                $this->operator = $operator;
        }

References $operator.

◆ setRght()

arJoin::setRght ( )

Definition at line 79 of file class.arJoin.php.

                                  {
                $this->setType(self::TYPE_RIGHT);
        }

References setType().

Here is the call graph for this function:

◆ setTableName()

arJoin::setTableName ( $table_name )

Parameters

string $table_name

Definition at line 156 of file class.arJoin.php.

                                                  {
                $this->table_name = $table_name;
        }

References $table_name.

◆ setType()

arJoin::setType ( $type )

Parameters

string $type

Definition at line 172 of file class.arJoin.php.

                                       {
                $this->type = $type;
        }

References $type.

Referenced by setInner(), setLeft(), and setRght().

Here is the caller graph for this function:

Field Documentation

◆ $both_external

arJoin::$both_external = false

protected

Definition at line 48 of file class.arJoin.php.

Referenced by getBothExternal(), and setBothExternal().

◆ $fields

arJoin::$fields = array( '*' )

protected

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

Referenced by getFields(), and setFields().

◆ $full_names

arJoin::$full_names = false

protected

Definition at line 44 of file class.arJoin.php.

Referenced by getFullNames(), and setFullNames().

◆ $is_mapped

arJoin::$is_mapped = false

protected

Definition at line 52 of file class.arJoin.php.

Referenced by isIsMapped(), and setIsMapped().

◆ $on_first_field

arJoin::$on_first_field = ''

protected

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

Referenced by getOnFirstField(), and setOnFirstField().

◆ $on_second_field

arJoin::$on_second_field = ''

protected

Definition at line 40 of file class.arJoin.php.

Referenced by getOnSecondField(), and setOnSecondField().

◆ $operator

arJoin::$operator = '='

protected

Definition at line 32 of file class.arJoin.php.

Referenced by getOperator(), and setOperator().

◆ $table_name

arJoin::$table_name = ''

protected

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

Referenced by getTableName(), and setTableName().

◆ $type

arJoin::$type = self::TYPE_NORMAL

protected

Definition at line 20 of file class.arJoin.php.

Referenced by getType(), and setType().

◆ TYPE_INNER

const arJoin::TYPE_INNER = 'INNER'

Definition at line 16 of file class.arJoin.php.

Referenced by ActiveRecordList\innerjoin().

◆ TYPE_LEFT

const arJoin::TYPE_LEFT = 'LEFT'

Definition at line 14 of file class.arJoin.php.

Referenced by ActiveRecordList\leftjoin().

◆ TYPE_NORMAL

const arJoin::TYPE_NORMAL = self::TYPE_INNER

Definition at line 13 of file class.arJoin.php.

◆ TYPE_RIGHT

const arJoin::TYPE_RIGHT = 'RIGHT'

Definition at line 15 of file class.arJoin.php.

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

Services/ActiveRecord/Connector/Join/class.arJoin.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ asSQLStatement()

◆ getBothExternal()

◆ getFields()

◆ getFullNames()

◆ getOnFirstField()

◆ getOnSecondField()

◆ getOperator()

◆ getTableName()

◆ getType()

◆ isIsMapped()

◆ setBothExternal()

◆ setFields()

◆ setFullNames()

◆ setInner()

◆ setIsMapped()

◆ setLeft()

◆ setOnFirstField()

◆ setOnSecondField()

◆ setOperator()

◆ setRght()

◆ setTableName()

◆ setType()

Field Documentation

◆ $both_external

◆ $fields

◆ $full_names

◆ $is_mapped

◆ $on_first_field

◆ $on_second_field

◆ $operator

◆ $table_name

◆ $type

◆ TYPE_INNER

◆ TYPE_LEFT

◆ TYPE_NORMAL

◆ TYPE_RIGHT