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

Public Member Functions

 __construct ($assetid=0)
 
 generateJSCode (&$q_asset, $rule_data)
 
 defaultError (&$q_asset, $rule_data)
 
 ruleDescription (&$q_asset, $rule_data)
 
- Public Member Functions inherited from Form_Question_Rule
 __construct ($assetid=0)
 
 evaluate ($answer, $rule_data)
 
 generateJSCode (&$q_asset, $rule_data)
 
 defaultError (&$q_asset, $rule_data)
 
 ruleDescription (&$q_asset, $rule_data)
 
- 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 ()
 

Static Public Member Functions

static getOperators ()
 
 valueTest ($answer, $operator, &$comparison)
 
 evaluate ($answer, $rule_data, &$q_asset)
 
- Static Public Member Functions inherited from Form_Question_Rule
static isValidationRule ()
 
static isSelectiveEmailRule ()
 
static getOperators ()
 

Additional Inherited Members

- Data Fields inherited from Asset
 $id = 0
 
 $version = ''
 
 $name = ''
 
 $short_name = ''
 
 $status
 
 $languages = ''
 
 $charset = ''
 
 $force_secure = '0'
 
 $created
 
 $created_userid
 
 $updated
 
 $updated_userid
 
 $published
 
 $published_userid
 
 $status_changed
 
 $status_changed_userid
 
 $_is_cacheable = FALSE
 
 $vars = Array()
 
 $_available_keywords = Array()
 
 $data_path_suffix = ''
 
 $data_path = ''
 
 $data_path_public = ''
 
 $_ser_attrs = FALSE
 
- 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 30 of file form_question_rule_type_file_type.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 40 of file form_question_rule_type_file_type.inc.

Member Function Documentation

defaultError ( $q_asset,
  $rule_data 
)

returns a default error message for this rule

Parameters
objectForm_Question &$q_asset the question asset that failed
array$rule_datathe rule data
Returns
string the error message public

Definition at line 206 of file form_question_rule_type_file_type.inc.

evaluate (   $answer,
  $rule_data,
$q_asset 
)
static

processes a test on a single static value

Used when we are using rules outside of validating a form - for example selective emails.

Because the Form Question Rule classes will not be instantiable by Matrix NOR will be instantiated manually in code, this function MUST called statically.

The value being tested in this case should be the file name of the uploaded file.

Parameters
mixed$answerthe answer being passed to us
string$operatorthe operator being used to compare
mixed&$comparisoneither a value or a form_question asset (based on comparison question id), being used to compare

public

Returns
boolean true only if rule succeeds

Definition at line 119 of file form_question_rule_type_file_type.inc.

generateJSCode ( $q_asset,
  $rule_data 
)

writes JavaScript code for client side validation

Parameters
objectform_question &$q_asset reference to the question asset
string$operatorthe operator being used to compare
mixed&$comparisoneither a value or a form_question asset (based on comparison question id), being used to compare

public

Returns
boolean

Definition at line 187 of file form_question_rule_type_file_type.inc.

static getOperators ( )
static

Returns a list of operators for this rule type

public

Returns
array (mixed => string) an array of descriptions indexed by operator id (which can be anything, generally string or (int)0|1 for a boolean value)

Definition at line 54 of file form_question_rule_type_file_type.inc.

ruleDescription ( $q_asset,
  $rule_data 
)

returns a description of the rule

Parameters
objectForm_Question &$q_asset the question asset that failed
array$rule_datathe rule data
Returns
string the error message public

Definition at line 230 of file form_question_rule_type_file_type.inc.

valueTest (   $answer,
  $operator,
$comparison 
)
static

processes a test on a single static value

Used when we are using rules outside of validating a form - for example selective emails.

Because the Form Question Rule classes will not be instantiable by Matrix NOR will be instantiated manually in code, this function MUST called statically.

The value being tested in this case should be the file name of the uploaded file.

Parameters
mixed$answerthe answer being passed to us
string$operatorthe operator being used to compare
mixed&$comparisoneither a value or a form_question asset (based on comparison question id), being used to compare

public

Returns
boolean true only if rule succeeds

Definition at line 83 of file form_question_rule_type_file_type.inc.


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