com.lokorin.dfcrafters.lib
[ class tree: com.lokorin.dfcrafters.lib ] [ index: com.lokorin.dfcrafters.lib ] [ all elements ]

Class: TableField

Source Location: /_includes/lib_admin_panel.php

Class Overview


Describes a table field with a connected value in $_REQUEST. The table field tries to capture it's connected value if possible.


Author(s):

  • Andreas Launila

Variables

Methods



Class Details

[line 251]
Describes a table field with a connected value in $_REQUEST. The table field tries to capture it's connected value if possible.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$displayName =

[line 261]

The name that should be displayed to the user.



Tags:

access:  private

Type:   string


[ Top ]

$requestName =

[line 256]

The name used to identify field in $_REQUEST.



Tags:

access:  private

Type:   string


[ Top ]

$tableField =

[line 266]

The name of the corresponding field in the table.



Tags:

access:  private

Type:   string


[ Top ]

$value =

[line 271]

The value of the field (used for different things, e.g. identification).



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 280]

TableField __construct( string $requestName, string $displayName, string $tableField, [string $value = false])

Constructor for TableField.



Tags:

access:  public


Parameters:

string   $requestName   The name used to identify field in $_REQUEST.
string   $displayName   The name to display to the user.
string   $tableField   The corresponding field in the table.
string   $value   The value of the field.

[ Top ]

method getDisplayName [line 302]

string getDisplayName( )

Gets the display name of the field.



Tags:

return:  A name.
access:  public


[ Top ]

method getRequestName [line 294]

string getRequestName( )

Gets the request name of the field.



Tags:

return:  An $_REQUEST name.
access:  public


[ Top ]

method getTableField [line 310]

string getTableField( )

Gets the name of the table field connected to this instance.



Tags:

return:  A table field name.
access:  public


[ Top ]

method getValue [line 318]

string getValue( )

Gets the value of the field.



Tags:

return:  A value.
access:  public


[ Top ]

method hasValue [line 330]

boolean hasValue( )

Checks if the field has a value set or not.



Tags:

return:  True if the field has a value, false otherwise.
access:  public


[ Top ]

method setValue [line 338]

void setValue( $newVal $newVal)

Sets a new value for the field.



Tags:

access:  public


Parameters:

$newVal   $newVal   The new value to assign.

[ Top ]


Documentation generated on Tue, 10 Jan 2006 17:06:23 +0100 by phpDocumentor 1.3.0RC4