Class Hook_catalogue_field_short_trans

Description

Located in /sources/hooks/modules/catalogue_fields/short_trans.php (line 21)


	
			
Method Summary
?tempcode get_field_inputter (string $_cf_name, string $_cf_description, array $field, ?string $actual_value, boolean $new)
array get_field_value_row_bits (AUTO_LINK $cf_id, [?boolean $required = NULL], [?string $default = NULL])
?array get_search_inputter (array $row)
string inputted_to_field_value (boolean $editing, AUTO_LINK $id)
?array inputted_to_sql_for_search (array $row, integer $i)
mixed render_field_value (mixed $ev)
Methods
get_field_inputter (line 100)

Convert a field value to something renderable.

  • return: The Tempcode for the input field (NULL: skip the field - it's not input)
?tempcode get_field_inputter (string $_cf_name, string $_cf_description, array $field, ?string $actual_value, boolean $new)
  • string $_cf_name: The field name
  • string $_cf_description: The field description
  • array $field: The field details
  • ?string $actual_value: The actual current value of the field (NULL: none)
  • boolean $new: Whether this is for a new entry
get_field_value_row_bits (line 63)

Get some info bits relating to our field type, that helps us look it up / set defaults.

  • return: Tuple of details (row-type,default-value-to-use,db row-type)
array get_field_value_row_bits (AUTO_LINK $cf_id, [?boolean $required = NULL], [?string $default = NULL])
  • AUTO_LINK $cf_id: The field ID
  • ?boolean $required: Whether the row is required (NULL: don't try and find a default value)
  • ?string $default: The given default value (NULL: don't try and find a default value)
get_search_inputter (line 34)

Get special Tempcode for inputting this field.

  • return: List of specially encoded input detail rows (NULL: nothing special)
?array get_search_inputter (array $row)
  • array $row: The row for the field to input
inputted_to_field_value (line 113)

Find the posted value from the get_field_inputter field

  • return: The value
string inputted_to_field_value (boolean $editing, AUTO_LINK $id)
  • boolean $editing: Whether we were editing (because on edit, files might need deleting)
  • AUTO_LINK $id: The ID of the catalogue field
inputted_to_sql_for_search (line 46)

Get special SQL from POSTed parameters for this field.

  • return: Tuple of SQL details (array: extra trans fields to search, array: extra plain fields to search, string: an extra table segment for a join, string: the name of the field to use as a title, if this is the title, extra WHERE clause stuff) (NULL: nothing special)
?array inputted_to_sql_for_search (array $row, integer $i)
  • array $row: The row for the field to input
  • integer $i: We're processing for the ith row
render_field_value (line 80)

Convert a field value to something renderable.

  • return: Rendered field (tempcode or string)
mixed render_field_value (mixed $ev)
  • mixed $ev: The raw value

Documentation generated on Sun, 02 Jan 2011 23:24:37 +0000 by phpDocumentor 1.4.3