Phenotype API Documentation

Class PhenotypeComponentStandard

Description
Description | Descendents | Vars (details) | Methods (details)

Located in /class/PhenotypeComponent.class.php (line 25) 

PhenotypeBase
   |
   --PhenotypeComponentStandard
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
PhenotypeComponent
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $bez
mixed $block_nr
mixed $com_id
mixed $formid
mixed $id
mixed $loaded
mixed $myLayout
mixed $name
mixed $pag_id
mixed $pos
integer $tool_type
mixed $visible
Array $_form
Method Summary
Description | Descendents | Vars (details) | Methods (details)
PhenotypeComponentStandard __construct ([ $id = -1])
void addnew ( $pag_id,  $ver_id,  $dat_id_content,  $block_nr, [ $dat_id = 0])
void delete ()
void displayEditForm ([ $context = 0])
void displayXML ()
void edit ( $context)
void fetchEditForm ([ $context = 0])
mixed fget (string $property)
void form_content_selectbox ( $title,  $property,  $con_id, [ $addzerodots = true], [ $statuscheck = true], [ $sql_where = ""])
void form_document_selector ( $title,  $property, [ $folder = ""], [ $changefolder = true], [ $infoline = true], [ $type_filter = ""], [ $grp_id = 0])
void form_enumeration ( $title,  $property, [ $start = 3], [ $max = 99])
void form_headline ( $title)
void form_html ( $title,  $property,  $width,  $rows)
void form_imageupload ( $title,  $property, [ $path = "_upload"], [ $grp_id = 2])
void form_image_selector ( $title,  $property, [ $folder = ""], [ $changefolder = true], [ $x = 0], [ $y = 0], [ $grp_id = 0], [ $_options = array()])
void form_link ( $title,  $property, [ $link_name = true], [ $link_target = true], [ $link_pageselector = false], [ $link_text = false], [ $link_popup = false], [ $link_source = false], [ $link_type = false], [ $link_type_options = array()])
void form_richtext ( $title,  $property,  $width,  $rows, [ $filter = 1])
void form_selectbox ( $title,  $property,  $_options, [ $addzerodots = true])
void form_textarea ( $title,  $property,  $width,  $rows)
void form_textfield ( $title,  $property,  $width)
void form_wrap ( $methodname, [ $_params = array ()])
void fset ( $property, unknown_type $bez, unknown_type $val)
void getEditLabel ()
void init ( $row)
void initForm (integer $context)
void initRendering ()
void load ( $id)
void movedown ()
void moveup ()
void rawXMLExport ([ $tool_type = -1])
void rawXMLImport ( $buffer)
void render (int $context)
void renderXML ()
void setDefaultProperties ()
void setFullSearch ()
void store ()
void update ( $context)
void _debug_print_form_xy_fetch (string $property)
void __call ( $methodname,  $params)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $bez (line 52)
mixed $block_nr (line 50)
mixed $com_id = 0 (line 31)

Unique Page Component Identifier

  • access: public
mixed $formid (line 57)
mixed $id (line 47)
mixed $loaded = 0 (line 59)
mixed $myLayout = -1 (line 55)
mixed $name = "" (line 37)

Page Component Name

  • access: public
mixed $pag_id (line 49)
mixed $pos (line 51)
integer $tool_type (line 45)

old component identifier, please use com_id instead

mixed $visible (line 53)
Array $_form = array () (line 67)

Array with information about the editing form

  • access: protected

Inherited Variables

Inherited from PhenotypeBase

PhenotypeBase::$charset
 PhenotypeBase::$_props
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor __construct (line 105)
  • access: public
PhenotypeComponentStandard __construct ([ $id = -1])
  • $id
Redefinition of:
PhenotypeBase::__construct()
addnew (line 186)
void addnew ( $pag_id,  $ver_id,  $dat_id_content,  $block_nr, [ $dat_id = 0])
  • $pag_id
  • $ver_id
  • $dat_id_content
  • $block_nr
  • $dat_id
delete (line 273)
void delete ()
displayEditForm (line 386)
void displayEditForm ([ $context = 0])
  • $context
displayXML (line 320)
void displayXML ()
edit (line 287)
void edit ( $context)
  • $context
fetchEditForm (line 407)
void fetchEditForm ([ $context = 0])
  • $context
fget (line 168)
mixed fget (string $property)
  • string $property: name of the form field to be fetched (without formid)
form_content_selectbox (line 630)
  • access: public
void form_content_selectbox ( $title,  $property,  $con_id, [ $addzerodots = true], [ $statuscheck = true], [ $sql_where = ""])
  • $title
  • $property
  • $con_id
  • $addzerodots
  • $statuscheck
  • $sql_where
form_document_selector (line 1154)
  • access: public
void form_document_selector ( $title,  $property, [ $folder = ""], [ $changefolder = true], [ $infoline = true], [ $type_filter = ""], [ $grp_id = 0])
  • $title
  • $property
  • $folder
  • $changefolder
  • $infoline
  • $type_filter
  • $grp_id
form_enumeration (line 506)
  • access: public
void form_enumeration ( $title,  $property, [ $start = 3], [ $max = 99])
  • $title
  • $property
  • $start
  • $max
form_headline (line 459)
  • access: public
void form_headline ( $title)
  • $title
form_html (line 842)
  • access: public
void form_html ( $title,  $property,  $width,  $rows)
  • $title
  • $property
  • $width
  • $rows
form_imageupload (line 893)
  • access: public
void form_imageupload ( $title,  $property, [ $path = "_upload"], [ $grp_id = 2])
  • $title
  • $property
  • $path
  • $grp_id
form_image_selector (line 1066)
  • access: public
void form_image_selector ( $title,  $property, [ $folder = ""], [ $changefolder = true], [ $x = 0], [ $y = 0], [ $grp_id = 0], [ $_options = array()])
  • $title
  • $property
  • $folder
  • $changefolder
  • $x
  • $y
  • $grp_id
  • $_options
form_link (line 672)
  • access: public
void form_link ( $title,  $property, [ $link_name = true], [ $link_target = true], [ $link_pageselector = false], [ $link_text = false], [ $link_popup = false], [ $link_source = false], [ $link_type = false], [ $link_type_options = array()])
  • $title
  • $property
  • $link_name
  • $link_target
  • $link_pageselector
  • $link_text
  • $link_popup
  • $link_source
  • $link_type
  • $link_type_options
form_richtext (line 781)
  • access: public
void form_richtext ( $title,  $property,  $width,  $rows, [ $filter = 1])
  • $title
  • $property
  • $width
  • $rows
  • $filter
form_selectbox (line 589)
  • access: public
void form_selectbox ( $title,  $property,  $_options, [ $addzerodots = true])
  • $title
  • $property
  • $_options
  • $addzerodots
form_textarea (line 473)
  • access: public
void form_textarea ( $title,  $property,  $width,  $rows)
  • $title
  • $property
  • $width
  • $rows
form_textfield (line 429)
  • access: public
void form_textfield ( $title,  $property,  $width)
  • $title
  • $property
  • $width
form_wrap (line 966)
  • access: public
void form_wrap ( $methodname, [ $_params = array ()])
  • $methodname
  • $_params
fset (line 152)
void fset ( $property, unknown_type $bez, unknown_type $val)
  • unknown_type $bez
  • unknown_type $val
  • $property
getEditLabel (line 1423)
  • access: public
void getEditLabel ()
init (line 75)
void init ( $row)
  • $row
initForm (line 100)

to be implemented by application classes

  • access: public
void initForm (integer $context)
  • integer $context
initRendering (line 361)
void initRendering ()
load (line 127)
void load ( $id)
  • $id
movedown (line 257)
void movedown ()
moveup (line 240)
void moveup ()
rawXMLExport (line 1214)
void rawXMLExport ([ $tool_type = -1])
  • $tool_type
rawXMLImport (line 1278)
void rawXMLImport ( $buffer)
  • $buffer
render (line 1399)

Everytime a component gets displayed this method is called

So you have to implement it for your application page components

void render (int $context)
  • int $context: (as stated in Layout configuration)
renderXML (line 299)
void renderXML ()
setDefaultProperties (line 70)
void setDefaultProperties ()
setFullSearch (line 343)
void setFullSearch ()
store (line 348)
void store ()
update (line 293)
void update ( $context)
  • $context
_debug_print_form_xy_fetch (line 1409)

internal debugging method, intended for core development usage only ...

  • access: protected
void _debug_print_form_xy_fetch (string $property)
  • string $property
__call (line 1428)
  • access: public
void __call ( $methodname,  $params)
  • $methodname
  • $params

Inherited Methods

Inherited From PhenotypeBase

PhenotypeBase::__construct()
PhenotypeBase::check()
PhenotypeBase::clear()
PhenotypeBase::codeA()
PhenotypeBase::codeAH()
PhenotypeBase::codeH()
PhenotypeBase::codeHBR()
PhenotypeBase::codeHKT()
PhenotypeBase::codeI()
PhenotypeBase::codeSQL()
PhenotypeBase::codeX()
PhenotypeBase::get()
PhenotypeBase::getA()
PhenotypeBase::getAH()
PhenotypeBase::getD()
PhenotypeBase::getH()
PhenotypeBase::getHBR()
PhenotypeBase::getHTML()
PhenotypeBase::getI()
PhenotypeBase::getQ()
PhenotypeBase::getS()
PhenotypeBase::getSQL()
PhenotypeBase::getU()
PhenotypeBase::getURL()
PhenotypeBase::getValidationError()
PhenotypeBase::getX()
PhenotypeBase::isValidEmail()
PhenotypeBase::isValidInteger()
PhenotypeBase::isValidProperty()
PhenotypeBase::isValidSelection()
PhenotypeBase::isValidString()
PhenotypeBase::printProperties()
PhenotypeBase::set()
PhenotypeBase::setNoValidationError()
PhenotypeBase::setValidationError()
PhenotypeBase::urlencode()

Documentation generated on Fri, 17 Jul 2009 16:42:47 +0200 by phpDocumentor 1.4.2

Bookmark and Share