Class CMS_dialog_href

Description
Description | Methods (details) Constants (details)

Class CMS_dialog_href

Class to manage XHTML formulars relative to an CMS_href object

Located in /automne/classes/dialogs/dialoghref.php (line 31) 

CMS_grandFather
   |
   --CMS_dialog_href
Class Constant Summary
Description | Constants (details) | Methods (details)
MESSAGE_PAGE_EXISTING_FILE = 202
MESSAGE_PAGE_EXTERNALLINK = 277
MESSAGE_PAGE_FIELD_EDITFILE = 192
MESSAGE_PAGE_INTERNALLINK = 276
MESSAGE_PAGE_LINKFILE = 200
MESSAGE_PAGE_LINK_DESTINATION = 1420
MESSAGE_PAGE_LINK_LABEL = 934
MESSAGE_PAGE_LINK_SHOW = 1006
MESSAGE_PAGE_NOLINK = 275
MESSAGE_PAGE_NO_FILE = 10
MESSAGE_PAGE_POPUP_HEIGHT = 291
MESSAGE_PAGE_POPUP_WIDTH = 290
MESSAGE_PAGE_TARGET_BLANK = 1024
MESSAGE_PAGE_TARGET_POPUP = 1025
MESSAGE_PAGE_TARGET_TOP = 1023
MESSAGE_PAGE_TREEH1 = 1049
Method Summary
Description | Constants (details) Methods (details)
boolean create ([ $datas = ''], [ $module = MOD_STANDARD_CODENAME],  $resourceID, [ $fieldID = ''], array $datas,, string $module,, integer $resourceID,, integer $fieldID,)
boolean doPost ([ $module = MOD_STANDARD_CODENAME],  $resourceID, [ $fieldID = ''], string $module,, integer $resourceID,, integer $fieldID,)
CMS_href &getHref ()
string, getHTML ([ $module = MOD_STANDARD_CODENAME], [string $dataLocation = RESOURCE_DATA_LOCATION_EDITED], string $module,)
string getHTMLFields ( $cms_language, [ $module = MOD_STANDARD_CODENAME], [ $dataLocation = RESOURCE_DATA_LOCATION_EDITED], [ $options = false], CMS_language $cms_language,, string $module,, constant $dataLocation,, array $options,)
void __construct (CMS_href $href, [ $prefixname = ''])
boolean setHref ( $href, CMS_href $href,)
Methods
Description | Constants (details) Methods (details)
create (line 204)

Get datas vars from a form formatted by such a Automne.LinkField class and build a CMS_href

  • return: true on success, false on failure
  • access: public
boolean create ([ $datas = ''], [ $module = MOD_STANDARD_CODENAME],  $resourceID, [ $fieldID = ''], array $datas,, string $module,, integer $resourceID,, integer $fieldID,)
  • array $datas,: the datas sent by the Automne.LinkField return
  • string $module,: the module concerned by this link
  • integer $resourceID,: ID to prepend the filename uploaded with
  • integer $fieldID,: optional field ID to surcharge file name representation ("r".$resourceID."_f".$fieldID."_")
  • $datas
  • $module
  • $resourceID
  • $fieldID
doPost (line 125)

Get POST vars from a form formatted by such a CMS_dialog_href class and build a CMS_href

Uses : _POST['link'] : array $link, the $_POST['link'] built by submiting the form data : array ( 'internal'=>, 'external'=>, 'file'=>, 'edit_file'=>, 'popup'=> array ('width'=>,'height'=>), 'type'=> )

  • return: true on success, false on failure
  • access: public
boolean doPost ([ $module = MOD_STANDARD_CODENAME],  $resourceID, [ $fieldID = ''], string $module,, integer $resourceID,, integer $fieldID,)
  • string $module,: the module concerned by this link
  • integer $resourceID,: ID to prepend the filename uploaded with
  • integer $fieldID,: optional field ID to surcharge file name representation ("r".$resourceID."_f".$fieldID."_")
  • $module
  • $resourceID
  • $fieldID
getHref (line 90)

Get : The href

  • access: public
CMS_href &getHref ()
getHTML (line 290)

Get : a XHTML render of the "A" tag

  • return: the XHTML Tag
  • access: public
string, getHTML ([ $module = MOD_STANDARD_CODENAME], [string $dataLocation = RESOURCE_DATA_LOCATION_EDITED], string $module,)
  • string $module,: the module concerned by this link
  • string $dataLocation: Where does the data lies ? @see CMS_resource constants
  • $module
getHTMLFields (line 320)

Returns XHTML formatted form fields for this Href

  • return: HTML formated expected
  • access: public
string getHTMLFields ( $cms_language, [ $module = MOD_STANDARD_CODENAME], [ $dataLocation = RESOURCE_DATA_LOCATION_EDITED], [ $options = false], CMS_language $cms_language,, string $module,, constant $dataLocation,, array $options,)
  • CMS_language $cms_language,: the language to build the form with
  • string $module,: the module codename (default : MOD_STANDARD_CODENAME)
  • constant $dataLocation,: the current data location (RESOURCE_DATA_LOCATION_EDITED (default), RESOURCE_DATA_LOCATION_PUBLIC, etc.)
  • array $options,: array of possible link options (default false : all options actived) Example : Array ( 'label' => true|false, // Link has label ? 'internal' => true|false, // Link can target an Automne page ? 'external' => true|false, // Link can target an external resource ? 'file' => true|false, // Link can target a file ? 'destination'=> true|false, // Can select a destination for the link ? 'no_admin' => true|false, // Deprecated : Remove all admin class reference (default = false) 'admin' => true|false, // Use admin JS and classes instead of direct actions (default = true) 'currentPage'=> int|false, // Current page to open tree panel (default : CMS_tree::getRoot()) )
  • $cms_language
  • $module
  • $dataLocation
  • $options
Constructor __construct (line 74)

Constructor.

  • access: public
void __construct (CMS_href $href, [ $prefixname = ''])
setHref (line 102)

Set : The CMS_href

  • return: true on success, false on failure
  • access: public
boolean setHref ( $href, CMS_href $href,)
  • CMS_href $href,: the HREF to use in this dialog
  • $href

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()
Class Constants
Description | Constants (details) | Methods (details)
MESSAGE_PAGE_EXISTING_FILE = 202 (line 39)
MESSAGE_PAGE_EXTERNALLINK = 277 (line 36)
MESSAGE_PAGE_FIELD_EDITFILE = 192 (line 38)
MESSAGE_PAGE_INTERNALLINK = 276 (line 35)
MESSAGE_PAGE_LINKFILE = 200 (line 41)
MESSAGE_PAGE_LINK_DESTINATION = 1420 (line 49)
MESSAGE_PAGE_LINK_LABEL = 934 (line 44)
MESSAGE_PAGE_LINK_SHOW = 1006 (line 48)
MESSAGE_PAGE_NOLINK = 275 (line 34)
MESSAGE_PAGE_NO_FILE = 10 (line 40)
MESSAGE_PAGE_POPUP_HEIGHT = 291 (line 43)
MESSAGE_PAGE_POPUP_WIDTH = 290 (line 42)
MESSAGE_PAGE_TARGET_BLANK = 1024 (line 45)
MESSAGE_PAGE_TARGET_POPUP = 1025 (line 47)
MESSAGE_PAGE_TARGET_TOP = 1023 (line 46)
MESSAGE_PAGE_TREEH1 = 1049 (line 37)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:30:01 +0100 by phpDocumentor 1.4.3