Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Form_Edit_Fns Class Reference
Inheritance diagram for Form_Edit_Fns:
Asset_Edit_Fns MySource_Object Form_Email_Edit_Fns Form_Ecommerce_Edit_Fns

Public Member Functions

 Form_Edit_Fns ()
 
 paintSectionLinks (&$asset, &$o, $prefix)
 
 processSectionLinks (&$asset, &$o, $prefix)
 
 paintQuestionLinks (&$asset, &$o, $prefix)
 
 processQuestionLinks (&$asset, &$o, $prefix)
 
 paintUseBodycopy (&$asset, &$o, $prefix)
 
 processUseBodycopy (&$asset, &$o, $prefix)
 
 paintAddQuestions (&$asset, &$o, $prefix)
 
 processAddQuestions (&$asset, &$o, $prefix)
 
 paintAddSections (&$asset, &$o, $prefix)
 
 processAddSections (&$asset, &$o, $prefix)
 
 paintSubmissions (&$asset)
 
 processSubmissions (&$asset)
 
 paintSimpleFormatting (&$asset, &$o, $prefix)
 
 processSimpleFormatting (&$asset, &$o, $prefix)
 
 paintComplexFormatting (&$asset, &$o, $prefix)
 
 processComplexFormatting (&$asset, &$o, $prefix)
 
 paintCaptchaFontField (&$asset, &$o, $prefix)
 
 processCaptchaFontField (&$asset, &$o, $prefix)
 
 generateStandardContentFile (&$asset)
 
 generateQuestionsContentFile (&$asset)
 
 generateGenericSection (&$asset)
 
 paintMollomQuestionToCheck (&$asset, &$o, $prefix)
 
 processMollomQuestionToCheck (&$asset, &$o, $prefix)
 
 paintSubmissionLimit (&$asset, &$o, $prefix)
 
 processSubmissionLimit (&$asset, &$o, $prefix)
 
- Public Member Functions inherited from Asset_Edit_Fns
 Asset_Edit_Fns ()
 
 paintPaths (&$asset, &$o, $prefix)
 
 paintEditRemapURLs (&$asset, &$o, $prefix)
 
 processPaths (&$asset, &$o, $prefix)
 
 processEditRemapURLs (&$asset, &$o, $prefix)
 
 paintURLs (&$asset, &$o, $prefix)
 
 paintAddRemapURLs (&$asset, &$o, $prefix)
 
 processAddRemapURLs (&$asset, &$o, $prefix)
 
 isWorkflowComplete (&$asset)
 
 paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
 
 processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)
 
 isSearchInstalled (&$asset, $prefix)
 
 isBeingCreated (&$asset)
 
 isNotBeingCreated (&$asset)
 
 paintAutomaticRemapSetting (&$asset, &$o, $prefix)
 
 paintCreateLink (&$asset, &$o, $prefix)
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Protected Member Functions

 _getBodycopiesList ()
 

Additional Inherited Members

- Data Fields inherited from Asset_Edit_Fns
 $static_screens
 

Detailed Description

Definition at line 32 of file form_edit_fns.inc.

Member Function Documentation

_getBodycopiesList ( )
protected

Returns a list of bodycopies recognised, by POST data suffix => bodycopy name

The bodycopy names are not localised here; the bodycopy name is used as a link value between it and the Bodycopies folder so we prefer predictability. The "use bodycopy" functions use the localisation "cms_form_bodycopy_*" (where * is the suffix of the form element - ie. the key of this function's array return) for the localised names of the bodycopies.

Returns
array

Definition at line 427 of file form_edit_fns.inc.

Constructor

Definition at line 40 of file form_edit_fns.inc.

generateGenericSection ( $asset)

generates a generic section where there is no main or looping bodycopy

Parameters
object&$assetthe section asset
Returns
string public

Definition at line 857 of file form_edit_fns.inc.

generateQuestionsContentFile ( $asset)

Generates a content file for the unattached questions part of the form

Parameters
object&$assetthe form asset
Returns
boolean public

Definition at line 833 of file form_edit_fns.inc.

generateStandardContentFile ( $asset)

Generates a content file for the entire form in default, single-page contents mode

Parameters
object&$assetthe form asset
Returns
boolean public

Definition at line 797 of file form_edit_fns.inc.

paintAddQuestions ( $asset,
$o,
  $prefix 
)

Paint the dropdowns to add questions to this section

Return boolean FALSE if attributes write access is not held, TRUE otherwise

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 454 of file form_edit_fns.inc.

paintAddSections ( $asset,
$o,
  $prefix 
)

creates a checkbox to add a new Section

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 529 of file form_edit_fns.inc.

paintCaptchaFontField ( $asset,
$o,
  $prefix 
)

Paints the interface for the CAPTCHA Font field

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 731 of file form_edit_fns.inc.

paintComplexFormatting ( $asset,
$o,
  $prefix 
)

Paint a note giving instructions for complex formatting

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 690 of file form_edit_fns.inc.

paintMollomQuestionToCheck ( $asset,
$o,
  $prefix 
)

Paint the interface for choosing the question for Mollom spam check

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 906 of file form_edit_fns.inc.

paintQuestionLinks ( $asset,
$o,
  $prefix 
)

Paint the links to the bodycopies in this section

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 107 of file form_edit_fns.inc.

paintSectionLinks ( $asset,
$o,
  $prefix 
)

paints the current sections in the form

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 58 of file form_edit_fns.inc.

paintSimpleFormatting ( $asset,
$o,
  $prefix 
)

Paint a note explaining the restrictions of simple formatting

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 650 of file form_edit_fns.inc.

paintSubmissionLimit ( $asset,
$o,
  $prefix 
)

Paint the interface for

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1048 of file form_edit_fns.inc.

paintSubmissions ( $asset)

paint the current submissions for this form

Parameters
object&$assetthe form asset
Returns
boolean public

Definition at line 618 of file form_edit_fns.inc.

paintUseBodycopy ( $asset,
$o,
  $prefix 
)

Paint the dropdowns to add questions to this section

Return boolean FALSE if write access to links is not held, TRUE otherwise

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 349 of file form_edit_fns.inc.

processAddQuestions ( $asset,
$o,
  $prefix 
)

Process the newly added questions

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 493 of file form_edit_fns.inc.

processAddSections ( $asset,
$o,
  $prefix 
)

creates a new section if one was selected to be added

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 551 of file form_edit_fns.inc.

processCaptchaFontField ( $asset,
$o,
  $prefix 
)

Processes the interface for the CAPTCHA Font field

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 759 of file form_edit_fns.inc.

processComplexFormatting ( $asset,
$o,
  $prefix 
)

Process the note giving instructions for complex formatting

Nothing to process, so return FALSE always.

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 714 of file form_edit_fns.inc.

processMollomQuestionToCheck ( $asset,
$o,
  $prefix 
)

Process the interface for choosing the question for Mollom spam check

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 1008 of file form_edit_fns.inc.

processQuestionLinks ( $asset,
$o,
  $prefix 
)

Process the links to the questions in this section

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 310 of file form_edit_fns.inc.

processSectionLinks ( $asset,
$o,
  $prefix 
)

process section links (nothing yet)

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 90 of file form_edit_fns.inc.

processSimpleFormatting ( $asset,
$o,
  $prefix 
)

Process the note explaining the restrictions of simple formatting

We have nothing to process here, so return FALSE always.

Parameters
object&$assetthe asset to which we belong
object&$othe outputter class
string$prefixprefix for the form element
Returns
boolean public

Definition at line 673 of file form_edit_fns.inc.

processSubmissionLimit ( $asset,
$o,
  $prefix 
)

Processes the interface for

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 1079 of file form_edit_fns.inc.

processSubmissions ( $asset)

process the current submissions for this form

Parameters
object&$assetthe form asset
Returns
boolean public

Definition at line 633 of file form_edit_fns.inc.

processUseBodycopy ( $asset,
$o,
  $prefix 
)

Processes the using of, and possible creation of form-level bodycopies

This can be extended to add more bodycopies as required, by extending the $bodycopies array. However, one needs to add an attribute for it ("use_bodycopy_[suffix]") and an interface in paintUseBodycopy().

Parameters
object&$assetthe asset whose interface we are painting
object&$othe outputter class
string$prefixprefix for the form elements
Returns
boolean public

Definition at line 397 of file form_edit_fns.inc.


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