Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Form_Question_Type_Select Class Reference
Inheritance diagram for Form_Question_Type_Select:
Form_Question Asset MySource_Object Form_Question_Type_Country

Public Member Functions

 Form_Question_Type_Select ($assetid=0, $data=Array())
 
 getAllowedRules ()
 
 _getAllowedLinks ()
 
 getHtmlField ()
 
 getOptions ()
 
 getSummary ($answer=NULL)
 
 getXML ($answer)
 
 isSelected ($option)
 
 isEmptyOption ($option)
 
 getOptionName ($option_code)
 
 importOptionsFromCSV ($filename)
 
- Public Member Functions inherited from Form_Question
 Form_Question ($formid=0, $data=Array())
 
 setAttrValue ($name, $value)
 
 saveAttributes ($dont_run_updated=FALSE)
 
 _updated ($update_parents=TRUE)
 
 canClone ()
 
 _getName ($short_name=FALSE)
 
 getVal ($field='')
 
 getAnswerByOffset ($offset=0)
 
 getOffsetByAnswer ($answer='')
 
 isSelection ()
 
 getSelectionTypeQuestions ()
 
getMySection ()
 
 getMySectionName ()
 
 generateJSCode ()
 
 getAllowedRules ()
 
addRule ($rule_code, $operator, $value)
 
removeRule (&$deleted_rule)
 
 getRules ()
 
 getRuleCount ()
 
 isEditable ()
 
 getHtmlField ()
 
 populate (Asset $parent=NULL)
 
 setValue ($value)
 
 setExtraData (Array $data=NULL)
 
 hasValidValue ($answer=NULL, $mute_errors=FALSE)
 
 saveValue ()
 
 getValue ()
 
 getSummary ()
 
 getExtraData ()
 
 getXML ()
 
 getErrors ()
 
 readAccess ($assetids=Array())
 
 writeAccess ($lock_type='', $assetids=Array())
 
 adminAccess ($lock_type='', $assetids=Array())
 
 liveEditAccess ($lock_type)
 
 checkAccess ($perm, $lock_type, $assetids=Array())
 
 _checkPermissionAccess ($perm, $assetids=Array())
 
 stickValue ($value)
 
 unstickValue ()
 
 getStickyValue ()
 
 _getCookieName ()
 
 processStatusChange ($new_status, $update_parent=TRUE)
 
 getHtmlLabel ()
 
- Public Member Functions inherited from Asset
 Asset ($assetid=0)
 
 create (Array &$link)
 
 load ($assetid)
 
 _loadDataPaths ()
 
 reload ()
 
 canDelete ()
 
 delete ($release_lock=TRUE, $check_locked=TRUE)
 
 useSystemVersion ()
 
 loadSystemVersion ()
 
 saveSystemVersion ()
 
 clearSystemVersion ()
 
 revertToSystemVersion ()
 
 revertNoticeLinksToSystemVersion ()
 
 _updated ($update_parents=TRUE)
 
 type ()
 
 getTypeAncestors ($include_asset=TRUE)
 
 incrementVersion ($number='micro', $update_parents=TRUE)
 
 getLanguages ()
 
 setLanguages (Array $languages)
 
 setCharset ($charset)
 
 setForceSecure ($force_secure)
 
 remapAssetids (Array $map)
 
 morph ($new_type_code)
 
 _morphCleanup ($new_type_code)
 
 onRequestKeywords (Asset $broadcaster, Array $vars=Array())
 
 canClone ()
 
 cloneComponents (Asset $clone, Array $components, $override=FALSE)
 
 cloneComponentsAdditional (Asset $clone, Array $components)
 
 cloneLinks (Asset $clone)
 
 getStatus ()
 
 getAvailableStatii ()
 
 getStatusDescription ()
 
 processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
 
 setDate ($date_type, $time=NULL, $userid=NULL)
 
 lockTypes ()
 
 canForceablyAcquireLock ($lock_type)
 
 getEditingLocks ($keywords)
 
 _getAllowedLinks ()
 
 createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 canCreateLink (Asset $minor, $link_type, $exclusive)
 
 canMoveLink (Asset $minor, Asset $old_major, $link_type)
 
 describeLink ($linkid)
 
 isDeletableLink ($linkid)
 
 canDeleteLink ($linkid)
 
 deleteLink ($linkid, $check_locked=TRUE)
 
 linksUpdated ()
 
 canCloneLink ()
 
 saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
 
 setAttrValue ($name, $value)
 
 attr ($name)
 
attrByRef ($name)
 
 getAttribute ($name, $mute_errors=FALSE)
 
 getAssetKeywords ($descriptions=FALSE)
 
 getAvailableKeywords ()
 
 getKeywordReplacement ($keyword)
 
 getAssetWebPathKeywordReplacement ()
 
 getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
 
 processCustomKeywords ($keywords=Array())
 
 getContent ()
 
 setContent ()
 
 getEffectiveLastUpdatedTime ($assetids)
 
 readAccess (Array $assetids=Array())
 
 writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
 
 adminAccess ($lock_type='', Array $assetids=Array())
 
 backendAccess ()
 
 liveEditAccess ($lock_type)
 
 canliveEdit ($lock_type)
 
 effectiveUnrestricted ()
 
 checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
 
 accessEffective ()
 
 permissionsUpdated ()
 
 printFrontend ()
 
 printFrontendAsset (Asset $asset, $design=NULL)
 
 getValidProtocols ()
 
 printHead ()
 
 printBody ()
 
 getCurrentPaintLayoutName ()
 
 getCurrentDesignName ()
 
 printBodyWithPaintLayout ($layout_id='')
 
 initLimbo ()
 
 printLimbo ()
 
 paintBackend (Backend_Outputter $o)
 
 getPrefix ()
 
 processBackend (Backend_Outputter $o, Array &$link)
 
 getEI ()
 
 getEditFns ()
 
 getBackendHref ($screen='', $backend_page=TRUE)
 
 getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
 
 getURLs ()
 
 getHref ($base_url=NULL, $ignore_rollback=FALSE)
 
 getWebDataPath ()
 
 getWebPaths ()
 
 saveWebPaths ($paths, $auto_add_remaps=TRUE)
 
 getLookups ($field='')
 
 getDesignLookups ()
 
 getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
 
 deleteLookupValue ($layout_name, $layout_value)
 
 setPaintLayouts ($layouts)
 
 updateLookups ($auto_add_remaps=TRUE)
 
 setLookupValues (Array $values)
 
 getAssetStatusDescriptionKeywordReplacement ()
 
 getAssetStatusColourKeywordReplacement ()
 
 replaceKeywordsInString ($string)
 
 fastTrack ($tasks)
 
 unFastTrack ($tasks)
 
 shouldFastTrack ($task, $assetid=NULL)
 
 getFaskTrackedTaskAssetids ($task)
 
 getDependantParentsURL ()
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Additional Inherited Members

- Data Fields inherited from Form_Question
 $_formid = 0
 
 $_questionid = 0
 
 $section_name = ''
 
 $section_id = 0
 
 $value = NULL
 
 $extra_data = Array()
 
 $submission_errors = NULL
 
 $active_form = NULL
 
 $failed_rules = Array()
 
- Protected Member Functions inherited from Asset
 _preCreateCheck (Array &$link)
 
 _createAdditional (Array &$link)
 
 _abortCreate ($trigger_level_changed=FALSE, $linkid=0)
 
 _loadVars ()
 
 _getName ($short_name=FALSE, $contextid=NULL)
 
 _getKeywordReplacement ($keyword)
 
 _checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)
 
 makeAndSaveInitialWebPath ($path, $parent_link=NULL)
 

Detailed Description

Definition at line 33 of file form_question_type_select.inc.

Member Function Documentation

_getAllowedLinks ( )

Returns an array of all the permitted link type, the type asset and the cardinality

Returns
array private
See Also
Asset::_getAllowLinks()

Definition at line 73 of file form_question_type_select.inc.

Form_Question_Type_Select (   $assetid = 0,
  $data = Array() 
)

Constructor

Parameters
int$assetidthe asset id to be loaded
array$datathe section's entry for this question (contains all question data)

Definition at line 44 of file form_question_type_select.inc.

getAllowedRules ( )

returns an array of the types of rules that are allowed upon this asset

Returned array is 'short name' => 'full name'

Returns
array public

Definition at line 59 of file form_question_type_select.inc.

getHtmlField ( )

generates the html for this question to display it in the frontend or backend

Returns
string public

Definition at line 86 of file form_question_type_select.inc.

getOptionName (   $option_code)

Get option name

Get the name for one particular option, specified by option code. Assumes option id is valid

Parameters
string$option_codeunique option id for this question
Returns
array public

Definition at line 255 of file form_question_type_select.inc.

getOptions ( )

returns the options currently in the dropdown list

Returns
array public

Definition at line 113 of file form_question_type_select.inc.

getSummary (   $answer = NULL)

returns a summary for this question

Parameters
string$answerThe answer the print the summary for (optional)
Returns
mixed array|string public

Definition at line 151 of file form_question_type_select.inc.

getXML (   $answer)

returns an answer summary in XML format (suitable for submission logs)

Parameters
mixed$answerthe answer for the question
Returns
string public

Definition at line 188 of file form_question_type_select.inc.

importOptionsFromCSV (   $filename)

Replace options with an imported CSV file.

If 1 column: value only - key is sequentially assigned (from 0) If 2 columns: key, value If 3 columns: key, value, default [1|0]

Parameters
string$filenameThe (temp) file name to import
Returns
void

Definition at line 273 of file form_question_type_select.inc.

isEmptyOption (   $option)

returns TRUE if this particuar option is an –Leave Empty– option

Parameters
string$optionthe value to check
Returns
boolean public

Definition at line 236 of file form_question_type_select.inc.

isSelected (   $option)

returns TRUE if this particuar option is selected

Parameters
string$optionthe value to check
Returns
boolean public

Definition at line 216 of file form_question_type_select.inc.


The documentation for this class was generated from the following file: