Inheritance diagram for arViewField:

Collaboration diagram for arViewField:

Public Member Functions
	__construct ($name, $txt=null, $position=0, $visible=true, $custom_field=false)

	setPosition ($position)

	getPosition ()

	setTxt ($txt)

	getTxt ()

	setVisible ($visible)

	getVisible ()

	setCustomField ($custom_field)

	getCustomField ()

	setTxtPrefix ($txt_prefix)

	getTxtPrefix ()

	getGetFunctionName ()

	getSetFunctionName ()

	setIsCreatedByField ($is_created_by_field)

	setIsCreationDateField ($is_creation_date_field)

	getIsCreationDateField ()

	getIsCreatedByField ()

	setIsModifiedByField ($is_modified_by_field)

	getIsModifiedByField ()

	setIsModificationDateField ($is_modification_date_field)

	getIsModificationDateField ()

Public Member Functions inherited from arField
	loadFromArray ($name, array $array)

	loadFromStdClass ($name, stdClass $stdClass)

	getAttributesForConnector ()

	getAttributesForDescription ()

	isDateField ()

	setFieldType ($field_type)

	getFieldType ()

	setHasField ($has_field)

	getHasField ()

	setLength ($length)

	getLength ()

	setName ($name)

	getName ()

	setNotNull ($not_null)

	getNotNull ()

	setPrimary ($primary)

	getPrimary ()

	setUnique ($unique)

	getUnique ()

	setSequence ($sequence)

	getSequence ()

	setIndex ($index)

	getIndex ()

Static Public Member Functions
static	setAllowedAttributes ($allowed_attributes)

static	getAllowedAttributes ()

static	castFromFieldToViewField (arField $field)

Static Public Member Functions inherited from arField
static	isAllowedAttribute ($type, $field_name)

static	isDateFieldType ($field_type)

Protected Attributes
	$txt_prefix = ""

	$txt = ""

	$position = 1000

	$visible = false

	$custom_field = false

	$get_function_name = ""

	$set_function_name = ""

	$is_created_by_field = false

	$is_modified_by_field = false

	$is_creation_date_field = false

	$is_modification_date_field = false

Protected Attributes inherited from arField
	$fieldtype

	$length = null

	$is_primary = false

	$name = ''

	$not_null = false

	$unique = false

	$has_field = false

	$sequence = false

	$index = false

Additional Inherited Members
Data Fields inherited from arField
const	FIELD_TYPE_TEXT = 'text'

const	FIELD_TYPE_INTEGER = 'integer'

const	FIELD_TYPE_FLOAT = 'float'

const	FIELD_TYPE_DATE = 'date'

const	FIELD_TYPE_TIME = 'time'

const	FIELD_TYPE_TIMESTAMP = 'timestamp'

const	FIELD_TYPE_CLOB = 'clob'

Static Protected Attributes inherited from arField
static	$allowed_attributes

static	$date_fields

Detailed Description

GUI-Class arViewField.

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: 2.0.7

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

Constructor & Destructor Documentation

◆ __construct()

arViewField::__construct	(	$name,
		$txt = `null`,
		$position = `0`,
		$visible = `true`,
		$custom_field = `false`
	)

Parameters

	$name
null	$txt
int	$position
bool	$visible
bool	$custom_field

Definition at line 67 of file class.arViewField.php.

    {
        $this->name = $name;
        $this->position = $position;
        $this->txt = $txt;
        $this->visible = $visible;
        $this->custom_field = $custom_field;
 
        $camel_case = ActiveRecord::_toCamelCase($this->getName(), true);
        $this->get_function_name = "get" . $camel_case;
        $this->set_function_name = "set" . $camel_case;
    }

References $custom_field, arField\$name, $position, $txt, $visible, ActiveRecord\_toCamelCase(), and arField\getName().

Here is the call graph for this function:

Member Function Documentation

◆ castFromFieldToViewField()

static arViewField::castFromFieldToViewField ( arField $field )

static

Parameters

arField $field

Returns: arViewField

Definition at line 288 of file class.arViewField.php.

    {
        require_once('./Services/ActiveRecord/Views/Index/class.arIndexTableField.php');
        require_once('./Services/ActiveRecord/Views/Edit/class.arEditField.php');
        require_once('./Services/ActiveRecord/Views/Display/class.arDisplayField.php');
 
        $field_class = get_called_class();
        $obj = new $field_class($field->getName());
        foreach (get_object_vars($field) as $key => $name) {
            $obj->$key = $name;
        }
 
        return $obj;
    }

References $key, arField\$name, and arField\getName().

Here is the call graph for this function:

◆ getAllowedAttributes()

static arViewField::getAllowedAttributes ( )

static

Returns: array

Definition at line 169 of file class.arViewField.php.

    {
        return self::$allowed_attributes;
    }

References arField\$allowed_attributes.

◆ getCustomField()

arViewField::getCustomField ( )

Returns: boolean

Definition at line 151 of file class.arViewField.php.

    {
        return $this->custom_field;
    }

References $custom_field.

Referenced by arDisplayGUI\setArFieldData().

Here is the caller graph for this function:

◆ getGetFunctionName()

arViewField::getGetFunctionName ( )

Returns: string

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

    {
        return $this->get_function_name;
    }

References $get_function_name.

◆ getIsCreatedByField()

arViewField::getIsCreatedByField ( )

Returns: boolean

Definition at line 241 of file class.arViewField.php.

    {
        return $this->is_created_by_field;
    }

References $is_created_by_field.

Referenced by arDisplayGUI\setArFieldData().

Here is the caller graph for this function:

◆ getIsCreationDateField()

arViewField::getIsCreationDateField ( )

Returns: boolean

Definition at line 232 of file class.arViewField.php.

    {
        return $this->is_creation_date_field;
    }

References $is_creation_date_field.

◆ getIsModificationDateField()

arViewField::getIsModificationDateField ( )

Returns: boolean

Definition at line 277 of file class.arViewField.php.

    {
        return $this->is_modification_date_field;
    }

References $is_modification_date_field.

◆ getIsModifiedByField()

arViewField::getIsModifiedByField ( )

Returns: boolean

Definition at line 259 of file class.arViewField.php.

    {
        return $this->is_modified_by_field;
    }

References $is_modified_by_field.

Referenced by arDisplayGUI\setArFieldData().

Here is the caller graph for this function:

◆ getPosition()

arViewField::getPosition ( )

Returns: string

Definition at line 93 of file class.arViewField.php.

    {
        return $this->position;
    }

References $position.

Referenced by arViewFields\sortFields().

Here is the caller graph for this function:

◆ getSetFunctionName()

arViewField::getSetFunctionName ( )

Returns: string

Definition at line 205 of file class.arViewField.php.

    {
        return $this->set_function_name;
    }

References $set_function_name.

Referenced by arEditGUI\setDateTimeRecordField(), arEditGUI\setNumericRecordField(), and arEditGUI\setTextRecordField().

Here is the caller graph for this function:

◆ getTxt()

arViewField::getTxt ( )

Returns: string

Definition at line 111 of file class.arViewField.php.

    {
        if ($this->txt) {
            return $this->getTxtPrefix() . $this->txt;
        }
 
        return $this->getTxtPrefix() . $this->getName();
    }

References $txt, arField\getName(), and getTxtPrefix().

Referenced by arEditGUI\addBooleanInputField(), arEditGUI\addClobInputField(), arEditGUI\addDateTimeInputField(), arIndexTableGUI\addFilterField(), arEditGUI\addNumbericInputField(), and arEditGUI\addTextInputField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTxtPrefix()

arViewField::getTxtPrefix ( )

Returns: string

Definition at line 187 of file class.arViewField.php.

    {
        return $this->txt_prefix;
    }

References $txt_prefix.

Referenced by getTxt().

Here is the caller graph for this function:

◆ getVisible()

arViewField::getVisible ( )

Returns: string

Definition at line 133 of file class.arViewField.php.

    {
        return $this->visible;
    }

References $visible.

Referenced by arIndexTableGUI\checkColumnVisibile().

Here is the caller graph for this function:

◆ setAllowedAttributes()

static arViewField::setAllowedAttributes ( $allowed_attributes )

static

Parameters

array $allowed_attributes

Definition at line 160 of file class.arViewField.php.

    {
        self::$allowed_attributes = $allowed_attributes;
    }

References arField\$allowed_attributes.

◆ setCustomField()

arViewField::setCustomField ( $custom_field )

Parameters

boolean $custom_field

Definition at line 142 of file class.arViewField.php.

    {
        $this->custom_field = $custom_field;
    }

References $custom_field.

◆ setIsCreatedByField()

arViewField::setIsCreatedByField ( $is_created_by_field )

Parameters

boolean $is_created_by_field

Reimplemented in arEditField.

Definition at line 214 of file class.arViewField.php.

    {
        $this->is_created_by_field = $is_created_by_field;
    }

References $is_created_by_field.

◆ setIsCreationDateField()

arViewField::setIsCreationDateField ( $is_creation_date_field )

Parameters

$is_creation_date_field

Reimplemented in arEditField.

Definition at line 223 of file class.arViewField.php.

    {
        $this->is_creation_date_field = $is_creation_date_field;
    }

References $is_creation_date_field.

◆ setIsModificationDateField()

arViewField::setIsModificationDateField ( $is_modification_date_field )

Parameters

$is_modification_date_field

Reimplemented in arEditField.

Definition at line 268 of file class.arViewField.php.

    {
        $this->is_modification_date_field = $is_modification_date_field;
    }

References $is_modification_date_field.

◆ setIsModifiedByField()

arViewField::setIsModifiedByField ( $is_modified_by_field )

Parameters

boolean $is_modified_by_field

Reimplemented in arEditField.

Definition at line 250 of file class.arViewField.php.

    {
        $this->is_modified_by_field = $is_modified_by_field;
    }

References $is_modified_by_field.

◆ setPosition()

arViewField::setPosition ( $position )

Parameters

string $position

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

    {
        $this->position = $position;
    }

References $position.

◆ setTxt()

arViewField::setTxt ( $txt )

Parameters

string $txt

Definition at line 102 of file class.arViewField.php.

    {
        $this->txt = $txt;
    }

References $txt.

◆ setTxtPrefix()

arViewField::setTxtPrefix ( $txt_prefix )

Parameters

string $txt_prefix

Definition at line 178 of file class.arViewField.php.

    {
        $this->txt_prefix = $txt_prefix;
    }

References $txt_prefix.

◆ setVisible()

arViewField::setVisible ( $visible )

Parameters

string $visible

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

    {
        $this->visible = $visible;
    }

References $visible.

Referenced by arEditField\setIsCreatedByField(), arEditField\setIsCreationDateField(), arEditField\setIsModificationDateField(), arEditField\setIsModifiedByField(), and arIndexTableField\setVisibleDefault().

Here is the caller graph for this function:

Field Documentation

◆ $custom_field

arViewField::$custom_field = false

protected

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

Referenced by __construct(), arIndexTableField\__construct(), getCustomField(), and setCustomField().

◆ $get_function_name

arViewField::$get_function_name = ""

protected

Definition at line 37 of file class.arViewField.php.

Referenced by getGetFunctionName().

◆ $is_created_by_field

arViewField::$is_created_by_field = false

protected

Definition at line 45 of file class.arViewField.php.

Referenced by getIsCreatedByField(), setIsCreatedByField(), and arEditField\setIsCreatedByField().

◆ $is_creation_date_field

arViewField::$is_creation_date_field = false

protected

Definition at line 53 of file class.arViewField.php.

Referenced by getIsCreationDateField(), setIsCreationDateField(), and arEditField\setIsCreationDateField().

◆ $is_modification_date_field

arViewField::$is_modification_date_field = false

protected

Definition at line 57 of file class.arViewField.php.

Referenced by getIsModificationDateField(), setIsModificationDateField(), and arEditField\setIsModificationDateField().

◆ $is_modified_by_field

arViewField::$is_modified_by_field = false

protected

Definition at line 49 of file class.arViewField.php.

Referenced by getIsModifiedByField(), setIsModifiedByField(), and arEditField\setIsModifiedByField().

◆ $position

arViewField::$position = 1000

protected

Definition at line 25 of file class.arViewField.php.

Referenced by __construct(), arIndexTableField\__construct(), getPosition(), and setPosition().

◆ $set_function_name

arViewField::$set_function_name = ""

protected

Definition at line 41 of file class.arViewField.php.

Referenced by getSetFunctionName().

◆ $txt

arViewField::$txt = ""

protected

Definition at line 21 of file class.arViewField.php.

Referenced by __construct(), arIndexTableField\__construct(), getTxt(), and setTxt().

◆ $txt_prefix

arViewField::$txt_prefix = ""

protected

Definition at line 17 of file class.arViewField.php.

Referenced by getTxtPrefix(), and setTxtPrefix().

◆ $visible

arViewField::$visible = false

protected

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

Referenced by __construct(), arIndexTableField\__construct(), getVisible(), and setVisible().

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

Services/ActiveRecord/Views/class.arViewField.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ castFromFieldToViewField()

◆ getAllowedAttributes()

◆ getCustomField()

◆ getGetFunctionName()

◆ getIsCreatedByField()

◆ getIsCreationDateField()

◆ getIsModificationDateField()

◆ getIsModifiedByField()

◆ getPosition()

◆ getSetFunctionName()

◆ getTxt()

◆ getTxtPrefix()

◆ getVisible()

◆ setAllowedAttributes()

◆ setCustomField()

◆ setIsCreatedByField()

◆ setIsCreationDateField()

◆ setIsModificationDateField()

◆ setIsModifiedByField()

◆ setPosition()

◆ setTxt()

◆ setTxtPrefix()

◆ setVisible()

Field Documentation

◆ $custom_field

◆ $get_function_name

◆ $is_created_by_field

◆ $is_creation_date_field

◆ $is_modification_date_field

◆ $is_modified_by_field

◆ $position

◆ $set_function_name

◆ $txt

◆ $txt_prefix

◆ $visible