Phenotype API Documentation

Class PhenotypeIncludeStandard

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

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

PhenotypeBase
   |
   --PhenotypeIncludeStandard
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
PhenotypeInclude
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $context
unknown_type $disableLayout
mixed $html
mixed $id
unknown_type $magicProperties
mixed $params
boolean $protectGlobalRequestObject
boolean $smartActions
mixed $view_ajax
mixed $view_error
mixed $view_none
mixed $view_post
mixed $view_success
Method Summary
Description | Descendents | Vars (details) | Methods (details)
PhenotypeIncludeStandard __construct ([ $p1 = ""], [ $p2 = ""])
void disableLayout ()
void display ()
void displayXML ()
void execute ()
void executeSmartAction ()
void initRendering ()
void rawXMLExport ([ $inc_id = -1])
void rawXMLImport ( $buffer)
void redirect ([unknown_type $action = index], unknown_type $_params)
void renderXML ()
void __call ( $methodname,  $params)
void __get ( $k)
void __set ( $k,  $v)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $context = 0 (line 32)
  • access: public
unknown_type $disableLayout = false (line 53)

reserved for future usage

  • access: protected
mixed $html (line 31)
  • access: public
mixed $id (line 27)
  • access: public
unknown_type $magicProperties = false (line 46)

enable/disable magic properties

  • access: protected
mixed $params (line 30)
  • access: public
boolean $protectGlobalRequestObject = true (line 63)

When smartActions are enabled the request object tries to guess the selected action. If no action parameter is given, the first smartParam will become the action. That results in a "shift" of all other params. This shift may interfere with other includes. Therefore the request object is cloned by default. You may turn this protection off (might help you when debugging smartActions).

  • access: protected
boolean $smartActions = false (line 39)

enable/disable smartActions

  • access: protected
mixed $view_ajax = "Ajax" (line 72)
  • access: protected
mixed $view_error = "Error" (line 71)
  • access: protected
mixed $view_none = false (line 74)
  • access: protected
mixed $view_post = "Post" (line 73)
  • access: protected
mixed $view_success = "Success" (line 70)
  • access: protected

Inherited Variables

Inherited from PhenotypeBase

PhenotypeBase::$charset
 PhenotypeBase::$_props
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor __construct (line 92)

If set to true page layout rendering is canceled, when executing this include

Attention: That also means, that the whole rendering process is stopped after execution of this Include, so be sure, to place it in the right order

  • access: public
PhenotypeIncludeStandard __construct ([ $p1 = ""], [ $p2 = ""])
  • $p1
  • $p2
Redefinition of:
PhenotypeBase::__construct()
disableLayout (line 564)

reserved for future usage

currently there's a problem with the output buffer, if we don't know from beginning, that the layout should be disabled

  • access: public
void disableLayout ()
display (line 204)

Please implement this method for normale includes

You don't need it when using smartActions

void display ()
displayXML (line 208)
void displayXML ()
execute (line 139)
void execute ()
executeSmartAction (line 383)

action/view dispatcher if smartActions are enabled

  • access: protected
void executeSmartAction ()
initRendering (line 112)
void initRendering ()
rawXMLExport (line 226)
void rawXMLExport ([ $inc_id = -1])
  • $inc_id
rawXMLImport (line 277)
void rawXMLImport ( $buffer)
  • $buffer
redirect (line 595)

Jump to another action (via http-redirect)

We don't have a forward function, you may call executeActionXY manually

  • access: public
void redirect ([unknown_type $action = index], unknown_type $_params)
  • unknown_type $action
  • unknown_type $_params
renderXML (line 180)
void renderXML ()
__call (line 371)
  • access: public
void __call ( $methodname,  $params)
  • $methodname
  • $params
__get (line 578)
  • access: public
void __get ( $k)
  • $k
__set (line 571)
  • access: public
void __set ( $k,  $v)
  • $k
  • $v

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:43:03 +0200 by phpDocumentor 1.4.2

Bookmark and Share