Class Editor

Description

The class for the Editor form in full

Located in /classEditor.php (line 102)


	
			
Variable Summary
 mixed $Action
 mixed $BaseTable
 mixed $Fields
 mixed $Id
 mixed $Joins
 mixed $Limit
 mixed $NewWhere
 mixed $Order
 mixed $Query
 mixed $Record
 mixed $SubmitName
 mixed $Template
 mixed $Title
 mixed $Where
Method Summary
 Editor __construct ([ $title = ""], [ $fields = null])
 void AddAttribute ( $field,  $k,  $v)
 void &AddField ( $field, [ $sql = ""], [ $lookup_sql = ""])
 void AndWhere ( $more_where)
 void Assign (string $value_field_name, string $new_value)
 void Available ()
 void GetRecord ([ $where = ""])
 void Id ([string $id = null])
 void Initialise (array $values)
 void IsCreate ()
 void IsSubmit ()
 void IsUpdate ()
 void Layout ( $template)
 void MoreWhere ( $operator,  $more_where)
 void OrWhere ( $more_where)
 void PostToValues ([ $prefix = ''])
 void Render ([ $title_tag = null])
 string ReplaceEditorPart (array $matches)
 void SetBaseTable ( $base_table)
 void SetJoins ( $join_list)
 void SetLookup ( $field,  $lookup_sql)
 void SetOptionList ( $field,  $options, [ $current = null], [ $parameters = null])
 void SetRecord ( $row)
 void SetSql ( $field,  $sql)
 void SetSubmitName ( $new_submit)
 void SetTemplate ( $template)
 void SetWhere ( $where_clause)
 string Title ([string $new_title = null])
 void Value (string $value_field_name)
 void WhereNewRecord ( $where_clause)
 void Write ([boolean $is_update = null])
Variables
mixed $Action (line 105)
mixed $BaseTable (line 108)
mixed $Fields (line 106)
mixed $Id (line 119)
mixed $Joins (line 109)
mixed $Limit (line 113)
mixed $NewWhere (line 111)
mixed $Order (line 112)
mixed $OrderedFields (line 107)
mixed $Query (line 114)
mixed $Record (line 117)
mixed $RecordAvailable (line 116)
mixed $SubmitName (line 118)
mixed $Template (line 115)
mixed $Title (line 104)
mixed $Where (line 110)
Methods
Constructor __construct (line 121)
Editor __construct ([ $title = ""], [ $fields = null])
  • $title
  • $fields
AddAttribute (line 198)
void AddAttribute ( $field,  $k,  $v)
  • $field
  • $k
  • $v
AddField (line 150)
void &AddField ( $field, [ $sql = ""], [ $lookup_sql = ""])
  • $field
  • $sql
  • $lookup_sql
AndWhere (line 261)
void AndWhere ( $more_where)
  • $more_where
Assign (line 180)

Assigns the value of a field in the record currently associated with this editor.

void Assign (string $value_field_name, string $new_value)
  • string $value_field_name
  • string $new_value
Available (line 279)
void Available ()
GetRecord (line 317)
void GetRecord ([ $where = ""])
  • $where
Id (line 189)

Sets or returns the form ID used for differentiating this form from others in the page.

void Id ([string $id = null])
  • string $id
Initialise (line 294)

Set some particular values to the ones from the array.

void Initialise (array $values)
  • array $values: An array of fieldname / value pairs
IsCreate (line 241)
void IsCreate ()
IsSubmit (line 228)
void IsSubmit ()
IsUpdate (line 232)
void IsUpdate ()
Layout (line 273)
void Layout ( $template)
  • $template
MoreWhere (line 253)
void MoreWhere ( $operator,  $more_where)
  • $operator
  • $more_where
OrWhere (line 265)
void OrWhere ( $more_where)
  • $more_where
PostToValues (line 307)

This will assign $_POST values to the internal Values object for each field that exists in the Fields array.

void PostToValues ([ $prefix = ''])
  • $prefix
Render (line 463)

Render the templated component. The heavy lifting is done by the callback...

void Render ([ $title_tag = null])
  • $title_tag
ReplaceEditorPart (line 345)

Replace parts into the form template.

  • return: What we want to replace this match with.
string ReplaceEditorPart (array $matches)
  • array $matches: The matches found which preg_replace_callback is calling us for.
SetBaseTable (line 203)
void SetBaseTable ( $base_table)
  • $base_table
SetJoins (line 207)
void SetJoins ( $join_list)
  • $join_list
SetLookup (line 160)
void SetLookup ( $field,  $lookup_sql)
  • $field
  • $lookup_sql
SetOptionList (line 194)
void SetOptionList ( $field,  $options, [ $current = null], [ $parameters = null])
  • $field
  • $options
  • $current
  • $parameters
SetRecord (line 283)
void SetRecord ( $row)
  • $row
SetSql (line 156)
void SetSql ( $field,  $sql)
  • $field
  • $sql
SetSubmitName (line 224)
void SetSubmitName ( $new_submit)
  • $new_submit
SetTemplate (line 269)
void SetTemplate ( $template)
  • $template
SetWhere (line 245)
void SetWhere ( $where_clause)
  • $where_clause
Title (line 218)

Accessor for the Title for the browse, which could set the title also.

  • return: The current title for the browser
string Title ([string $new_title = null])
  • string $new_title: The new title for the browser
Value (line 170)

Gets the value of a field in the record currently assigned to this editor.

void Value (string $value_field_name)
  • string $value_field_name
WhereNewRecord (line 249)
void WhereNewRecord ( $where_clause)
  • $where_clause
Write (line 486)

Write the record

void Write ([boolean $is_update = null])
  • boolean $is_update: Tell the write whether it's an update or insert. Hopefully it should be able to figure it out though.

Documentation generated on Fri, 13 Jan 2012 23:40:14 +1300 by phpDocumentor 1.4.3