4 * message_list_util.php
6 * Helper functions for message list templates.
8 * The following functions are utility functions for templates. Do not
9 * echo output in these functions.
11 * @copyright 2005-2010 The SquirrelMail Project Team
12 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
14 * @package squirrelmail
19 * @param array $aOrder
22 function calcMessageListColumnWidth($aOrder) {
24 * Width of the displayed columns
34 SQM_COL_ATTACHMENT
=> 1,
35 SQM_COL_INT_DATE
=> 15,
42 * Calculate the width of the subject column based on the
43 * widths of the other columns
45 if (isset($aOrder[SQM_COL_SUBJ
])) {
46 foreach($aOrder as $iCol) {
47 if ($iCol != SQM_COL_SUBJ
) {
48 $aWidthTpl[SQM_COL_SUBJ
] -= $aWidthTpl[$iCol];
53 foreach($aOrder as $iCol) {
54 $aWidth[$iCol] = $aWidthTpl[$iCol];
57 $iCheckTotalWidth = $iTotalWidth = 0;
58 foreach($aOrder as $iCol) { $iTotalWidth +
= $aWidth[$iCol];}
60 $iTotalWidth = ($iTotalWidth) ?
$iTotalWidth : 100; // divide by zero check. shouldn't be needed
62 // correct the width to 100%
63 foreach($aOrder as $iCol) {
64 $aWidth[$iCol] = round( (100 / $iTotalWidth) * $aWidth[$iCol] , 0);
65 $iCheckTotalWidth +
= $aWidth[$iCol];
67 if ($iCheckTotalWidth > 100) { // correction needed
68 $iCol = array_search(max($aWidth),$aWidth);
69 $aWidth[$iCol] -= $iCheckTotalWidth-100;
76 * Function to retrieve correct icon based on provided message flags. This is
77 * a merge/replacement for getFlagIcon() and getFlagText() functions.
79 * @param array $aFlags associative array with seen,deleted,anwered and flag keys.
80 * @param string $icon_theme_path path to user's currently selected icon theme.
81 * @return string $icon full HTML img tag or text icon, depending on of user prefs
84 function getFlagIcon ($aFlags, $icon_theme_path) {
92 * 6 = answered deleted
93 * 7 = answered deleted seen
96 * 10 = flagged deleted
97 * 11 = flagged deleted seen
98 * 12 = flagged answered
99 * 13 = flagged aswered seen
100 * 14 = flagged answered deleted
101 * 15 = flagged anserwed deleted seen
104 * 33 = forwarded seen
105 * 34 = forwarded deleted
106 * 35 = forwarded deleted seen
108 * 41 = flagged forwarded seen
109 * 42 = flagged forwarded deleted
110 * 43 = flagged forwarded deleted seen
114 * Use static vars to avoid initialisation of the array on each displayed row
117 static $flag_icons, $flag_values;
118 if (!isset($flag_icons)) {
119 // This is by no means complete...
120 $flag_icons = array (
121 // Image icon name Text Icon Alt/Title Text
122 // --------------- --------- --------------
123 array ('msg_new.png', $nbsp, '('._("New").')') ,
124 array ('msg_read.png', $nbsp, '('._("Read").')'),
125 // i18n: "D" is short for "Deleted". Make sure that two icon strings aren't translated to the same character (only in 1.5).
126 array ('msg_new_deleted.png', _("D"), '('._("Deleted").')'),
127 array ('msg_read_deleted.png', _("D"), '('._("Deleted").')'),
128 // i18n: "A" is short for "Answered". Make sure that two icon strings aren't translated to the same character (only in 1.5).
129 array ('msg_new_reply.png', _("A"), '('._("Answered").')'),
130 array ('msg_read_reply.png', _("A"), '('._("Answered").')'),
131 array ('msg_new_deleted_reply.png', _("D"), '('._("Answered").')'),
132 array ('msg_read_deleted_reply.png', _("D"), '('._("Answered").')'),
133 // i18n: "F" is short for "Flagged". Make sure that two icon strings aren't translated to the same character (only in 1.5).
134 array ('flagged.png', _("F"), '('._("Flagged").')'),
135 array ('flagged.png', _("F"), '('._("Flagged").')'),
136 array ('flagged.png', _("F"), '('._("Flagged").')'),
137 array ('flagged.png', _("F"), '('._("Flagged").')'),
138 array ('flagged.png', _("F"), '('._("Flagged").')'),
139 array ('flagged.png', _("F"), '('._("Flagged").')'),
140 array ('flagged.png', _("F"), '('._("Flagged").')'),
141 array ('flagged.png', _("F"), '('._("Flagged").')'),
158 // i18n: "O" is short for "Forwarded". Make sure that two icon strings aren't translated to the same character (only in 1.5).
159 array ('msg_new_forwarded.png', _("O"), '('._("Forwarded").')'),
160 array ('msg_read_forwarded.png', _("O"), '('._("Forwarded").')'),
161 array ('msg_new_deleted_forwarded.png', _("D"), '('._("Forwarded").')'),
162 array ('msg_read_deleted_forwarded.png', _("D"), '('._("Forwarded").')'),
168 array ('flagged.png', _("F"), '('._("Flagged").')'),
169 array ('flagged.png', _("F"), '('._("Flagged").')'),
170 array ('flagged.png', _("F"), '('._("Flagged").')'),
173 $flag_values = array('seen' => 1,
182 * The flags entry contain all items displayed in the flag column.
187 foreach ($aFlags as $flag => $flagvalue) {
193 case 'flagged': if ($flagvalue) $index +
= $flag_values[$flag]; break;
198 if (!empty($flag_icons[$index])) {
199 $data = $flag_icons[$index];
201 //FIXME: previously this default was set to the last value of the $flag_icons array (when it was index 15 - flagged anserwed deleted seen) but I don't understand why... am changing it to flagged (index 15 just shows (only) the flag icon anyway)
202 $data = $flag_icons[8]; // default to just flagged
205 $icon = getIcon($icon_theme_path, $data[0], $data[1], $data[2]);
211 * Function to retrieve correct priority icon based on user prefs
213 * @param integer $priority priority value of message
214 * @param string $icon_theme_path path to user's currently selected icon theme.
215 * @return string $icon full HTML img tag or text icon, depending on of user prefs
216 * @author Steve Brown
218 function getPriorityIcon ($priority, $icon_theme_path) {
224 $icon = getIcon($icon_theme_path, 'prio_high.png', create_span('!', 'high_priority'), _("High priority"));
227 $icon = getIcon($icon_theme_path, 'prio_low.png', create_span('↓', 'low_priority'), _("Low priority"));
230 $icon = getIcon($icon_theme_path, 'transparent.png', '', _("Normal priority"), 5);
239 * Function to retrieve correct attchment icon based on user prefs
241 * @param boolean $attach TRUE if the message has an attachment
242 * @param string $icon_theme_path path to user's currently selected icon theme.
243 * @return string $icon full HTML img tag or text icon, depending on of user prefs
244 * @author Steve Brown
246 function getAttachmentIcon ($attach, $icon_theme_path) {
249 $icon_file = $attach ?
'attach.png' : 'transparent.png';
250 $alt_text = $attach ?
_("Attachment") : _("No attachment");
251 $text = $attach ?
'+' : '';
252 $icon = getIcon($icon_theme_path, $icon_file, $text, $alt_text);