Skip to content

Commit 43c3174

Browse files
committed
misc minor doc fixes
1 parent 04c1f60 commit 43c3174

21 files changed

Lines changed: 36 additions & 32 deletions

clients/forms/edit_submission.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
// handle POST requests
7575
$failed_validation = false;
7676
if (isset($_POST) && !empty($_POST)) {
77-
// add the view ID to the request hash, for use by the ft_update_submission function
77+
// add the view ID to the request hash, for use by the Submissions::updateSubmission method
7878
$request["view_id"] = $view_id;
7979
$request["editable_field_ids"] = $editable_field_ids;
8080
list($success, $message) = Submissions::updateSubmission($form_id, $submission_id, $request);

global/code/Emails.class.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1511,7 +1511,7 @@ private static function getFormEmailFieldHeaders($form_email_id, $submission_inf
15111511

15121512

15131513
/**
1514-
* This function is tightly coupled with ft_get_email_components and has gotten increasingly more awful as
1514+
* This function is tightly coupled with Emails::getEmailComponents and has gotten increasingly more awful as
15151515
* time passed. It examines the content of an email template and detects any field and file attachments.
15161516
* Field attachments are files that have been uploaded through a form field; file attachments are just files
15171517
* on the server that want to be sent out. It then returns the updated email template (i.e. minus the
@@ -1521,6 +1521,7 @@ private static function getFormEmailFieldHeaders($form_email_id, $submission_inf
15211521
* @param string $template_str the email template (HTML or text)
15221522
* @param integer $form_id
15231523
* @param array $submission_placeholders
1524+
* @return array
15241525
*/
15251526
private static function extractEmailAttachmentInfo($template_str, $form_id, $submission_placeholders)
15261527
{
@@ -1605,7 +1606,7 @@ private static function extractEmailAttachmentInfo($template_str, $form_id, $sub
16051606

16061607

16071608
/**
1608-
* Strongly coupled with the ft_get_email_components function, this does the legwork to find out exactly what
1609+
* Strongly coupled with the Emails::getEmailComponents method, this does the legwork to find out exactly what
16091610
* text and HTML (Smarty) content should be in the emails. Returns BOTH, regardless of whether the template is
16101611
* only using one.
16111612
*
@@ -1614,6 +1615,7 @@ private static function extractEmailAttachmentInfo($template_str, $form_id, $sub
16141615
* @param array $email_template
16151616
* @param boolean $is_test
16161617
* @param array $test_settings
1618+
* @return array
16171619
*/
16181620
private static function getEmailTemplateContent($form_id, $submission_id, $email_template, $is_test, $test_settings)
16191621
{

global/code/FieldSizes.class.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,11 @@ public static function generateFieldTypeSizesMapJs($namespace = "page_ns")
7474

7575

7676
/**
77-
* The counterpart function to ft_generate_field_type_sizes_map_js: this generate a hash of field size keys (1char, tiny, etc)
77+
* The counterpart function to FieldSizes::generateFieldTypeSizesMapJs: this generate a hash of field size keys (1char, tiny, etc)
7878
* to their label (in the appropriate language).
7979
*
8080
* @param string $namespace
81+
* @return string
8182
*/
8283
public static function generateFieldTypeSizeLabels($namespace = "page_ns")
8384
{

global/code/FieldTypes.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,7 @@ public static function getFileFieldTypeIds()
912912
* anything else you want
913913
* field_types - all, or any that are relevant. But it should be an array, anyway
914914
* value - the actual value stored in the field
915-
* settings - (from ft_get_settings())
915+
* settings - (from Settings::get())
916916
* @return string
917917
*/
918918
public static function generateViewableField($params)

global/code/Fields.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -937,7 +937,7 @@ public static function getNumFormFields($form_id)
937937

938938
/**
939939
* A getter function to retrieve everything about a form field from the database column name. This is used in
940-
* the ft_search_submissions function.
940+
* the Submissions::searchSubmissions method.
941941
*
942942
* @param integer $form_id
943943
* @param string $col_name

global/code/General.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1142,8 +1142,8 @@ public static function generatePassword($length = 8)
11421142

11431143

11441144
/**
1145-
* This was added in 2.1.0. and replaces ft_build_and_cache_upgrade_info() which really wasn't necessary.
1146-
* It returns a hash of information to pass in a hidden form when the user clicks "Update".
1145+
* Returns a hash of information to pass in a hidden form when the user clicks "Update".
1146+
* @return array
11471147
*/
11481148
public static function getFormtoolsInstalledComponents()
11491149
{

global/code/Hooks.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ function_name = :function_name
257257

258258
/**
259259
* This processes all template hooks for a particular template location (e.g. edit client page, at the top).
260-
* It works similarly to the ft_process_hooks function, except there are no options to override values in the
260+
* It works similarly to the Hooks::processHooks function, except there are no options to override values in the
261261
* template. This is used purely to insert content into the templates.
262262
*
263263
* @param string $location

global/code/Menus.class.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -539,9 +539,8 @@ public static function getAdminMenu()
539539
}
540540

541541
/**
542-
* A wrapper function for ft_get_client_menu (and getAdminMenu). Returns all info
543-
* about a menu, regardless of type. If it's an admin menu, it'll be returned with an empty "clients"
544-
* hash key.
542+
* A wrapper function for Menus::getClientMenu (and getAdminMenu). Returns all info about a menu, regardless of
543+
* type. If it's an admin menu, it'll be returned with an empty "clients" hash key.
545544
*
546545
* @param integer $menu_id
547546
* @return
@@ -627,7 +626,7 @@ public static function getMenuItems($menu_id)
627626
/**
628627
* Called whenever an item is removed from a menu - OUTSIDE of the main administrator update menu
629628
* pages (client & admin). This updates the order to ensure its consistent (i.e. no gaps). Note:
630-
* this doesn't update the cached menu. If that's needed, you need to call the ft_cache_account_menu
629+
* this doesn't update the cached menu. If that's needed, you need to call the Menus::cacheAccountMenu
631630
* function separately
632631
*
633632
* @param integer $menu_id

global/code/Modules.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -776,10 +776,10 @@ public static function getModuleNamespace($module_folder)
776776
}
777777

778778
/**
779-
* Sets one or more module settings. This basically acts as a wrapper function for ft_set_settings,
779+
* Sets one or more module settings. This basically acts as a wrapper function for Settings::set(),
780780
* which ensures that the module field is set appropriately.
781781
*
782-
* @param array $setting_name a hash of "setting_name" => "setting_value"
782+
* @param array hash of "setting_name" => "setting_value"
783783
*/
784784
public static function setModuleSettings($settings)
785785
{

global/code/OptionLists.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ public static function getOptionList($list_id)
320320
* [1] => ...
321321
*
322322
* Whether or not the option list is grouped is found in the "is_grouped" field in the ft_option_lists
323-
* table. That info is not returned by this function - only by ft_get_option_list().
323+
* table. That info is not returned by this function - only by OptionsLists::getOptionList().
324324
*
325325
* @param integer $list_id the option list ID
326326
* @return array

0 commit comments

Comments
 (0)