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

Public Member Functions

 Form_Question_Type_File_Upload ($assetid=0, $data=Array())
 
 _getAllowedLinks ()
 
 getHtmlField ()
 
 getValue ()
 
 hasValidValue ($answer=NULL, $mute_errors=FALSE)
 
 populate (Asset $parent=NULL)
 
 getAllowedRules ()
 
 getSummary ()
 
 isEditable ()
 
 saveValue (Asset $parent)
 
 onSubmitForm (Asset $parent)
 
 cleanUp (Asset $parent)
 
 createTempFileUpload (Asset $parent)
 
 getTempFileUploadPath (Asset $parent)
 
 getUploadedFileId ()
 
- 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_file_upload.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 58 of file form_question_type_file_upload.inc.

cleanUp ( Asset  $parent)

Clean up after the submission is completed

Once the form is done with the question, this function should be called to clean up the incomplete submission.

Parameters
Asset$parentThe asser that called for the clean-up
Returns
void

Definition at line 623 of file form_question_type_file_upload.inc.

createTempFileUpload ( Asset  $parent)

Create incomplete file upload in the parent's space

Parameters
Asset$parentThe parent asset for this file upload question. This is most likely a Form, but could be the parent of a Simple Form.
Returns
void

Definition at line 642 of file form_question_type_file_upload.inc.

Form_Question_Type_File_Upload (   $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_file_upload.inc.

getAllowedRules ( )

returns an array of the types of rules

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

Returns
array public

Definition at line 222 of file form_question_type_file_upload.inc.

getHtmlField ( )

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

Returns
string public

Definition at line 71 of file form_question_type_file_upload.inc.

getSummary ( )

returns a summary about the answers in this question

Returns
string public

Definition at line 235 of file form_question_type_file_upload.inc.

getTempFileUploadPath ( Asset  $parent)

Returns the filesystem path

Returns
string

Definition at line 672 of file form_question_type_file_upload.inc.

getUploadedFileId ( )

Returns the assetid of the uploaded file

Returns
mixed int|NULL public

Definition at line 692 of file form_question_type_file_upload.inc.

getValue ( )

Returns the value of value var

Returns
string public

Definition at line 108 of file form_question_type_file_upload.inc.

hasValidValue (   $answer = NULL,
  $mute_errors = FALSE 
)

Look at user-specified and internal rules to see if this question currently has a valid value

Returns TRUE if all validation rules pass.

We cannot do our validation at the page level, only at the on-submit level. Any validation made at page level may not be true when the form is finally submitted, and the files are finally created in the Create Location(s) required.

Parameters
mixed$answerCustom value to compare with - if left NULL (or unspecified), use the current value of the question
boolean$mute_errorsIf TRUE, do not add to the "Failed Rules" log, but simply return FALSE
Returns
boolean public

Definition at line 139 of file form_question_type_file_upload.inc.

isEditable ( )

Returns whether questions of this type can be edited once the form has been initially submitted

Returns
boolean public

Definition at line 340 of file form_question_type_file_upload.inc.

onSubmitForm ( Asset  $parent)

Perform on-submit actions and validation

Returns
boolean

Definition at line 409 of file form_question_type_file_upload.inc.

populate ( Asset  $parent = NULL)

Populate the question based on what exists on the form

Returns
void public

Definition at line 178 of file form_question_type_file_upload.inc.

saveValue ( Asset  $parent)

Do any work necessary to make this value "stick", eg create an asset

This gets called once we know the whole form is valid and we want to save all the values.

Returns
void public

Definition at line 355 of file form_question_type_file_upload.inc.


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