db_select
Refer to image attached for actual look of this parameter type.

Description:  Creates a select box filled with options from all unique, non-empty (row != '') rows from any column of any table in the database, and automatically pre-selects the value id from another column in that table that you specify.  NOTE:  You do not make strings for the options that this select box outputs, because they are coming from the database column you specified.

Syntax:
Selected value ; Column to determine a match for the Selected Value : Table to get all of the info from ; Column to be outputted in <options> : custom


Here is an example parameter value:
This says to pre-select within the select box, the first id_member (should be the Admin) from the {db_prefix}members table, and output all <option> tags with the real_name of those members.  Note:  {db_prefix} must be supplied in here for your table names, since that is how we know that it's a table and not a column.

You can also do this:
And this will do the same thing.

If custom is defined, it will allow you to add values into the real_name column or whatever column is defined here within the table.  So it would use an insert.  custom is, ofcourse, OPTIONAL for you to use for this value.  If you don't use it, than your value could look like this instead:


Using custom wouldn't be appropriate for the SMF members table, though it would be appropriate for the dp_shoutboxes table where you could create different templates to use for each shoutbox.

This parameter returns a type STRING for you to use in your modules.  In this case the string returned would be '1'.

file_input
Refer to image attached for actual look of this parameter type.

Syntax for this parameter type is as follows:

Quantity of Files Allowed : Mime Types Allowed (each separated by a semicolon) or you can type in all to allow for all possible mime types : Thumbnail Image Dimensions (separated by semicolon).  If strict is defined (which I have decided to use a semicolon for to separate from the other definitions of width and height), than the image will be resized down and the original image will be destroyed.

If the value is empty.  The default values will be set:

So, this says only allow 1 file input and must be image and don't bother creating any thumbnail for it.  Just move the image.

Note:  You must define width and/or height, or no thumbnail image will be created.

More Examples of possible values for this parameter type:

Will create a thumbnail image from the original no bigger than 20x20 pixels (AND will KEEP THE ORIGINAL IMAGE, since strict is not defined).  0 means that we want them to be able to upload an INFINITE amount of files for this parameter.

Will create a thumbnail image only if the width of the image > 175 pixels and the file being uploaded is either gif and/or tiff.  If the file is CSS, it just moves the file along it's way.  Allows for only 2 of these files uploaded.  Since strict isn't defined in here, we will also keep the original image as well.

If the image uploaded is bigger than 100x100 pixels, it will resize it.  The original image will be lost unless it is smaller than or equal to a width of 100px and a height of 100px, since strict is defined in here!  Only allows for up to 10 images uploaded.

AN EXAMPLE OF A WRONG VALUE:Ok, this is an example of a WRONG parameter_value.  The reason why it is wrong here is because strict is defined, yet, no width and/or height is defined.  So, in such a case, this definition of strict will be ignored.  So this is the same as saying:  1:image/jpeg;image/png
And actually would be just better to keep it set the right way.  If you just want it to be strict on a width and/or a height value, than you MUST define the width and/or height value to be strict on.  For example, if I want uploads for images, I don't care about the height, but I need the image width to be restricted to 120 pixels.  I would do this:  So, you don't need to define the height in here and if it's undefined, it will only check the width.  Though, the image will still get resized proportionally ofcourse, taking into account the width and the height.

IMPORTANT NOTE:  This is an extremely UNIQUE parameter as it's the only 1 that does not have the value returned from it within the parameter_value column of the dp_module_parameters table within the database.  The values returned from this that you can use within your module will be an ARRAY of string values.  For example $params['(parameter name)'] will look like this if your parameter name is "files":

URL for accessing files will look like this (where id = the id_file): 
Direct Download:  index.php?action=dreamFiles;id=1
Image Viewing:  index.php?action=dreamFiles;id=1;image
Important:  $params['files'] = empty string where there are no files uploaded yet for that parameter name.  So you can handle that as well.

---

The following is an example of using it within a function for your module and just outputs all of the information that can be obtained foreach file for the 'myfiles' parameter name.

---

Please Note:  If you want to allow for PHP files to be uploaded, the mime type for this is:

application/x-httpd-php

Ofcourse, if you want all files to be able to be uploaded, you can also set the mime type to:  all

Remember, setting the mime type to all will allow "ALL" types of files to be uploaded, but even still it checks that the file is of the correct mime type and file extension.  So if the mime type isn't defined within the AllowedFileExtensions() function for that extension, than it can not be uploaded even if "ALL" is defined, since the mime-type identifies the correct file extension.  This is done for security reasons, though I believe I got every mime type, with the exception of the .htaccess file extension ofcourse.

Refer to the AllowedFileExtensions function, found in Subs-DreamPortal.php, for a Complete List of all allowed mime-types for the file_input parameter type.

checklist
Refer to image attached for actual look of this parameter type.  You can also take a look at the Statistics and Who's Online Module to see this parameter type in action.

Description:  Creates a checklist for your module, ability to allow for default checked options, and whether to allow them to be ordered or not, as well as supplying a default ordering of the checklist also. 

Note:  This parameter type is very similar to the list_groups parameter type, except you can define your own strings for the check box options.  But unlike the list_groups parameter type, defining -3 for the first value definition will not select all checkboxes.  Since you have to define the checkboxes manually in here, to select them all, you will need to place the offsets of each possible checkbox (starting at 0) within the first definition separated by commas in order to have all selected by default.

Syntax:
Selected Check box options (each separated by a comma) : Checkbox Options and $txt index string definitions (each separated by a semicolon) : [optional] (whether to allow them to be ordered or not and separate with a semicolon the default order of all check options, which will than be separated by a comma).

Possible Parameter Type Value Example:

---

---

This says, make check options that have array index of 0 (members),1 (posts), and 2 (topics) selected by default for this parameter.  Allow them to order it.  Since no order has been given, the default order will be 0,1,2,3,4,5 (the Admin will have the option to change this order with Up and Down links next to each Check Options $txt[] definition when modifying the module).

This will return an array of 2 string values accessible from the $params array:

• $params['(Parameter name)']['checked'] = string of all checked values separated by commas.  In the example above will return '0,1,2'.  Note:  If all check boxes/options have been unchecked, this will return a string of '-2' instead.
• $params['(Parameter name)']['order'] = string of all checked and unchecked values separated by commas and ordered in the order the Admin has defined for this.  In the example above, will return '0,1,2,3,4,5'.

---

Tip:  With these 2 values returned you can extrapolate the unchecked values using array_diff() after exploding both strings into arrays.  This is why I added the order array index to the $params, since you may want to provide a checklist of display options and choices, and if something is unchecked, you still need to know what is actually unchecked and the order of the unchecked checkboxes may still be important.  So this is the whole purpose of the order array index.  Note:  The checked array index will automatically be returned in the order in which the check options are in.

---

The $txt[] definitions of the labels for each check box are defined within the parameter value, in our example above they are and would be defined within your language file(s) as follows:

• members = $txt['dpmod_(Module Name)_(Parameter name)_members']
• posts = $txt['dpmod_(Module Name)_(Parameter name)_posts']
• topics = $txt['dpmod_(Module Name)_(Parameter name)_topics']
• categories = $txt['dpmod_(Module Name)_(Parameter name)_categories']
• boards = $txt['dpmod_(Module Name)_(Parameter name)_boards']
• online = $txt['dpmod_(Module Name)_(Parameter name)_online']

Note:  This string never changes it's position when declared.  So this is important for how you define each option within the module itself.  Array indexes for the following will always remain and never change, since this is how you should check whether these are checked or not within your modules:

members = 0
posts = 1
topics = 2
categories = 3
boards = 4
online = 5

all values unchecked = checked returns -2

Here are more Examples of Possible values for this parameter type based on the example above:

---

---

This says make check options 1 (posts), 2 (topics), and 5 (online) checked by default.  And since order is not defined in this value, the user will not be able to order the check options and the order that will always be returned, for this parameter, will be '0,1,2,3,4,5'.

---

---

This says, uncheck all check options.  Allow them to order it, and set the order to be reversed (so will be shown as:  online;boards;categories;topics;posts;members)

---

---

This says, check all check options, and allow ordering.  Note:  You'll notice that 5,4,3,2,1,0 was defined twice in here.  This is important, since if you don't define it at the end after order; it will simply redefine it as 0,1,2,3,4,5 and will return as checked, this string '0,1,2,3,4,5', instead of '5,4,3,2,1,0'.  So please remember that the order must always have all possible array indexes from 0 to count(array(members, posts, topics, categories, boards, online)) - 1, or leave the order definition blank to load from lowest array index to highest array index of the check options.

Another Example:

---

---

This says, check the following array indexes from the check options:
5 (online)
3 (categories)
1 (posts)
checked returns:  '5,3,1' and order returns:  '5,4,3,2,1,0'.  This will work since the order is still the same.  This will also allow the Admin to order it.

Here's an EXAMPLE of a WRONG parameter value for this type:

---

---

The reason this is wrong is because checked options must be returned relative to the order in which they are in.  So the order is set to:  5,4,3,2,1,0, but the checked values are set at:  0,2,4.  The order does not match here and is exactly the opposite.  So, this can be fixed by either setting order to this:  Example:  order;0,1,2,3,4,5 OR leaving it blank:  Example:  order.  Or we can change the checked string value to this instead:  4,2,0

Questions, comments, suggestions, etc. are welcome.

int
Refer to image attached for actual look of this parameter type.

The parameter value for this holds an integer value.  Exactly like SMF's settings for int, it can not have a negative value, and can not hold a string.  If these are inputted into this field and saved, the value will return 0 as the integer.

The maximum value depends on the system. 32 bit systems have a maximum signed integer range of up to 2147483647. So for example on such a system, 1000000000000 will return 2147483647. The maximum signed integer value for 64 bit systems goes up to 9223372036854775807.

Returns an integer value.

select
Refer to image attached for actual look of this parameter type.

Description:  Creates a select box with options to choose from for your module when modifying it.  Could look like the image attached.  Note:  The image attached is an example of one of the parameters in the Download System module that I created which takes advantage of this parameter type.

Syntax:
Selected Array Value from the next list : List of possible values (separated by semicolons)

Here is the example for the image attached:

0 means to have ID_FILE selected by default since it's the first possible value separated by a semicolon.  If I placed 1 in here, than rating would be the value that gets returned for this parameter.

It is EXTREMELY important to note that the text strings for each option in the select box MUST be within your language file(s) using this syntax for the $txt[] variables' index:
So in this example, you would need a language string for each option value.  The option values in this example are: ID_FILE, rating, views, commenttotal, totaldownloads, and filesize.  I happened to use the columns of the database table that it will query as option values, but you can use anything as an option value.  Just remember that it must be an index of the $txt[] array, so you can't use spaces and any crazy characters, if you know what I mean.  Numbers and letter are fine to use for option values and are recommended to only use these and/or underscores is fine also.

The return value from this parameter is the option value that is selected within the first definition.  So, if the 1st definition is 3, than the value for this parameter returned to the module would be:  commenttotal.  The customizer decides what to do with that return value.

IMPORTANT NOTE:  The highest possible value for the 1st number within this parameter value, just before the colon, is 5.  You should not set this any higher than 5, since there are 6 option values after the colon.

Any questions, comments, suggestions?  All welcome!

large_text
Refer to image attached for actual look of this parameter type.

Value holds the string of information that was inputted into this textarea.  Can be anything really.  The Customizer determines what to do with this text.  If the parameter value is empty, will return an empty string, otherwise returns the entire text inputted into this text area within the $params['(parameter name)'] variable.  This does not support BBC and/or Smilies by default.  If you want bbc and smilies to be allowed for this than you will have to use the parse_bbc() SMF function on this.

list_groups
Refer to image attached for actual look of this parameter type.

Description:  Lists all groups available within the forum, ability to allow for default checked groups, unallowed groups, and whether to allow them to be ordered or not, as well as supplying a default ordering of groups also.

Syntax:
Selected Group Id Values (each separated by a comma) : Unallowed Group Ids Values (each separated by a comma) : (whether to allow them to be ordered or not and separate with a semicolon the default order of all groups).

Possible Value Example:
This says, make groups 1 (Administrator) and 2 (Global Moderator) selected by default for this parameter.  Do not allow the Admin to select groups -1 (Guests) and 0 (Regular Members) for this parameter.  Allow them to order it, and make the default order 2,1 (which will place Global Moderator above the Administrator when viewing it by default, the Admin will have the option to change this order with Up and Down links next to each Groups name).

This will return a STRING value of all selected groups in the order in which they are selected and separated by comma's.  For Example:  the String "2,1,3" is a possible return value with the order of Global Moderator, Admin, and Moderator.  If no group is checked, it will return a string value of -2 (which is no groups).  To use this within your modules, you can do an explode on it and use the comma (,) as the delimiter.  You should also check if the value equals -2 also to make sure a group was selected.

Here are more Examples of Possible values for this parameter type:
This says make groups 1 and 2 enabled by default.  Groups -1 (Guests) and 0 (Regular Members) will not be shown as an option to check within the Admin, and also, if these values somehow appear within the first definition, they will not be added unless they are gone from the second definition.  And lastly, order, which says to create Up and Down links when modifying it to allow for a more flexible display of groups within modules.

This says, check groups 1 and 2 by default.  Show all possible groups to the Admin and let them order it however they want.

This says, check group ids -1, and 0 (Guests and Regular Members) for this module by default.  Allow them to use all group ids available for this module and DO NOT allow them to order it!

IMPORTANT NOTE:  To have all groups checked by default, after installation of the module, set the first value definition (just before the first colon) of the parameter value, to -3.  Parameter Value Example:  -3:-1,0:order

This says make all groups checked by default and do not allow them to select Guest and Regular Members, and allow them to order it.  Please be aware that you will need to check for a value of -3 within the module and perform the proper task if the return value for the $params array equals the string value of -3.  Ofcourse this is only used to check all groups by default.  That is directly after the module is installed.  If the user makes a change to this when modifying the module, this will change from -3, to the actual group id value of all checked Groups.

Questions, comments, suggestions, etc. are welcome.