arJoin Class Reference

Class arJoin. More...

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 Member Functions
	asStatementText (ActiveRecord $ar, $as=' AS ')

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

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

References asStatementText().

    {
        return $this->asStatementText($ar, ' AS ');
    }

Here is the call graph for this function:

asStatementText()

arJoin::asStatementText ( ActiveRecord  $ar,   $as = ' AS '  )

protected

Parameters

\ActiveRecord	$ar
string	$as

Returns

string

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

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

Referenced by asSQLStatement().

    {
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBothExternal()

arJoin::getBothExternal

(

)

Returns

boolean

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

References $both_external.

Referenced by asStatementText().

    {
        return $this->both_external;
    }

Here is the caller graph for this function:

getFields()

arJoin::getFields

(

)

Returns

array

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

References $fields.

    {
        return $this->fields;
    }

getFullNames()

arJoin::getFullNames

(

)

Returns

boolean

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

References $full_names.

    {
        return $this->full_names;
    }

getOnFirstField()

arJoin::getOnFirstField

(

)

Returns

string

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

References $on_first_field.

Referenced by asStatementText().

    {
        return $this->on_first_field;
    }

Here is the caller graph for this function:

getOnSecondField()

arJoin::getOnSecondField

(

)

Returns

string

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

References $on_second_field.

Referenced by asStatementText().

    {
        return $this->on_second_field;
    }

Here is the caller graph for this function:

getOperator()

arJoin::getOperator

(

)

Returns

string

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

Referenced by asStatementText().

    {
        return $this->operator;
    }

Here is the caller graph for this function:

getTableName()

arJoin::getTableName

(

)

Returns

string

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

References $table_name.

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

    {
        return $this->table_name;
    }

Here is the caller graph for this function:

getType()

arJoin::getType

(

)

Returns

string

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

References $type.

Referenced by asStatementText().

    {
        return $this->type;
    }

Here is the caller graph for this function:

isIsMapped()

arJoin::isIsMapped

(

)

Returns

boolean

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

References $is_mapped.

    {
        return $this->is_mapped;
    }

setBothExternal()

arJoin::setBothExternal

(

$both_external

)

Parameters

boolean

$both_external

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

References $both_external.

    {
        $this->both_external = $both_external;
    }

setFields()

arJoin::setFields

(

$fields

)

Parameters

array

$fields

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

References $fields, and fields.

    {
        $this->fields = $fields;
    }

setFullNames()

arJoin::setFullNames

(

$full_names

)

Parameters

boolean

$full_names

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

References $full_names.

Referenced by arJoinCollection\getSaveTableName().

    {
        $this->full_names = $full_names;
    }

Here is the caller graph for this function:

setInner()

arJoin::setInner

(

)

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

References setType().

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

Here is the call graph for this function:

setIsMapped()

arJoin::setIsMapped

(

$is_mapped

)

Parameters

boolean

$is_mapped

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

References $is_mapped.

Referenced by arJoinCollection\getSaveTableName().

    {
        $this->is_mapped = $is_mapped;
    }

Here is the caller graph for this function:

setLeft()

arJoin::setLeft

(

)

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

References setType().

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

Here is the call graph for this function:

setOnFirstField()

arJoin::setOnFirstField

(

$on_first_field

)

Parameters

string

$on_first_field

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

References $on_first_field.

    {
        $this->on_first_field = $on_first_field;
    }

setOnSecondField()

arJoin::setOnSecondField

(

$on_second_field

)

Parameters

string

$on_second_field

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

References $on_second_field.

    {
        $this->on_second_field = $on_second_field;
    }

setOperator()

arJoin::setOperator

(

$operator

)

Parameters

string

$operator

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

    {
        $this->operator = $operator;
    }

setRght()

arJoin::setRght

(

)

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

References setType().

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

Here is the call graph for this function:

setTableName()

arJoin::setTableName

(

$table_name

)

Parameters

string

$table_name

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

References $table_name.

    {
        $this->table_name = $table_name;
    }

setType()

arJoin::setType

(

$type

)

Parameters

string

$type

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

References $type.

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

    {
        $this->type = $type;
    }

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.

$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