Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
API page: http://api.drupal.org/api/drupal/includes--file.inc/function/file_set_st...
Describe the problem you have found:
The "status" argument is not explained at all. It accepts 2 constants:
FILE_STATUS_PERMANENT
FILE_STATUS_TEMPORARY
Comment | File | Size | Author |
---|---|---|---|
#6 | file_set_status_values-1169080-6.patch | 623 bytes | charlie-s |
#4 | file_set_status_values-1169080.patch | 571 bytes | barbi |
#2 | file_set_status-1169080.patch | 595 bytes | barbi |
Comments
Comment #1
jhodgdonGood catch! The OOP is correct on what the values are. This is a D6 issue only (the function does not exist in D7/8). Probably a good project for a novice contributor.
Comment #2
barbi CreditAttribution: barbi commentedComment #3
jhodgdonCould you please:
- reformat the @param section so it conforms with our doc standards
- format the choices as a list:
A status value to set the file to. One of:
- FILE_STATUS_PERMANENT
- FILE_STATUS_TEMPORARY
Comment #4
barbi CreditAttribution: barbi commentedComment #5
jhodgdonStill not formatted correctly:
http://drupal.org/node/1354#functions
Should be more like:
* @param $mail
* A string containing an email address.
Needs:
- $ before the variable names
- @param $var on one line, description on next line
- Period at end of description
- Also, : before the list
Comment #6
charlie-s CreditAttribution: charlie-s commentedComment #7
jhodgdonThat's better. Thanks! I guess we could also fix the verb at the top of the function to "Sets", but that's kind of a separate issue and anyway much of D6 doesn't follow that standard as it was adopted in D7.
Comment #8
Gábor HojtsyThanks, committed.