4 * Copyright (C) 2004 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * PreferenceApp is used to analyze a category of items that a group
25 * of people have rated. A user is grouped to be analyzed in the group by
26 * 1) having rated at least one item in the database and 2) matching the optional
27 * criteria for declaring a budget on their homepage.
29 * An example of a budget decleration would be "TotalSoda: 50" on my homepage.
31 * PreferenceApp will output a matrix style table shows "how much" fractionally
32 * a group of people prefer an item over other items. For example, if my soda
33 * budget is 100 then PreferenceApp might assign 20 units of my budget to Moutain Dew.
35 * Author: mcassano circa April 2004
38 * <<PreferenceApp category="Soda" pageTextLabel="TotalSoda" roundCalc="true" >>
41 require_once 'lib/PageList.php';
42 require_once 'lib/InlineParser.php';
44 require_once 'lib/wikilens/Utils.php';
45 require_once 'lib/WikiTheme.php';
46 require_once 'lib/wikilens/Buddy.php';
47 require_once 'lib/wikilens/RatingsDb.php';
49 class WikiPlugin_PreferenceApp
54 return _("PreferenceApp");
57 function getDescription()
59 return _("Analyzes preferences based on voting budget and ratings.");
62 function getDefaultArguments()
66 'lockedBudget' => null,
67 'pageTextLabel' => null,
69 'roundCalc' => "true",
70 'neutralRating' => "3",
71 'declareBudget' => "true");
74 // info arg allows multiple columns
75 // info=mtime,hits,summary,version,author,locked,minor
76 // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
78 function run($dbi, $argstr, &$request, $basepage)
81 extract($this->getArgs($argstr, $request));
82 if ($pageTextLabel == null && $category != null && $group == null) {
85 if ($category == null || $pageTextLabel == null) {
86 return HTML::div(array('class' => "error"), "PreferencesApp Error: You must declare at least parameters category and pageTextLabel.");
89 $dbi = $request->getDbh();
90 $rdbi = RatingsDb::getTheRatingsDb();
92 $CATEGORY = $category;
93 $PAGE_TEXT_LABEL = $pageTextLabel;
94 $NEUTRAL_RATING = (int)$neutralRating;
96 $active_user = $request->getUser();
97 $active_userid = $active_user->_userid;
99 $html->pushContent("");
101 //Load participating Users
102 $users_array = array();
103 if ($group != null) {
104 $users_array = getMembers($group, $rdbi);
106 $people_iter = $rdbi->sql_get_users_rated();
107 while ($people_array = $people_iter->next()) {
108 $users_array[] = $people_array['pagename'];
112 foreach ($users_array as $person_indv) {
113 if ($declareBudget == "true") {
114 $get_array = getPageTextData($person_indv, $dbi, $PAGE_TEXT_LABEL, "cans");
115 if (count($get_array) == 1) {
116 $cans_text = $get_array[0];
117 if (is_numeric($cans_text) && $cans_text >= 0) {
118 $canBudget[$person_indv] = $cans_text; //Load the persons budget
120 $canBudget[$person_indv] = 0;
122 $people[] = $person_indv;
125 $canBudget[$person_indv] = $lockedBudget;
126 $people[] = $person_indv;
129 if (count($people) < 1) {
130 return fmt("Nobody has used %s on their homepage", $PAGE_TEXT_LABEL);
132 //Get all pages from Category
134 $category_page = $dbi->getPage($CATEGORY);
135 $iter = $category_page->getLinks();
136 while ($item = $iter->next()) {
137 array_push($pageids, $item->getName());
139 $ratingTotals = array();
140 foreach ($people as $person) {
141 $ratings_iter = $rdbi->sql_get_rating(0, $person, $pageids);
142 $ratingTotals[$person] = 0;
143 while ($ratings_array = $ratings_iter->next()) {
144 $can_rating = $ratings_array['ratingvalue'];
145 if ($can_rating >= $NEUTRAL_RATING) {
146 $ratingTotals[$person] += $can_rating;
152 $canTotals = array();
153 $peopleTotals = array();
154 foreach ($pageids as $soda) {
155 $canTotals[$soda] = 0;
157 foreach ($people as $person) {
158 foreach ($pageids as $soda) {
159 $peopleTotals[$person][$soda] = 0;
162 foreach ($people as $person) {
163 foreach ($pageids as $page) {
164 $can_rating_iter = $rdbi->sql_get_rating(0, $person, $page);
165 $can_rating_array = $can_rating_iter->next();
166 $can_rating = $can_rating_array['ratingvalue'];
167 if ($can_rating >= $NEUTRAL_RATING) {
168 $calc = (($can_rating / $ratingTotals[$person]) * $canBudget[$person]);
169 if ($roundCalc == "true") {
170 $adjustedCans = round($calc);
172 $adjustedCans = round($calc, 2);
174 $peopleTotals[$person][$page] = $adjustedCans;
176 $canTotals[$page] = $canTotals[$page] + $adjustedCans;
180 $outputArray = array();
181 foreach ($people as $person) {
182 foreach ($pageids as $page) {
183 $outputArray[$person][$page] = 0;
187 $table = HTML::table(array('cellpadding' => '5', 'cellspacing' => '1', 'border' => '0'));
189 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
190 $td->pushContent(" ");
191 $tr->pushContent($td);
193 foreach ($people as $person) {
194 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
195 $td->pushContent(HTML::a(array('href' => WikiURL($person),
198 SplitPagename($person)));
199 //$td->pushContent(WikiLink(" $person "));
200 $tr->pushContent($td);
202 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
203 $td->pushContent(_("Total Units"));
204 $tr->pushContent($td);
205 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
206 $td->pushContent(_("Total Voters"));
207 $tr->pushContent($td);
208 $table->pushContent($tr);
210 for ($i = 0; $i < count($pageids); $i++) {
212 for ($j = 0; $j < count($people); $j++) {
213 $td = HTML::td(array('align' => 'right'));
214 $cans_per_soda = $peopleTotals[$people[$j]][$pageids[$i]];
215 $total_cans = $total_cans + $cans_per_soda;
216 $outputArray[$people[$j]][$pageids[$i]] = $cans_per_soda;
220 foreach ($people as $person) {
222 $min_cans = 9999999; //9 million, serving as "infinity"
224 foreach ($pageids as $page) {
225 $cur_soda_cans = $outputArray[$person][$page];
226 if ($cur_soda_cans < $min_cans && $cur_soda_cans > 0) {
227 $min_cans = $cur_soda_cans;
230 $total_cans = $total_cans + $cur_soda_cans;
232 if ($total_cans != $canBudget[$person] && $total_cans > 0) {
233 $diff = $canBudget[$person] - $total_cans;
234 $outputArray[$person][$min_soda] = $outputArray[$person][$min_soda] + $diff;
237 for ($i = 0; $i < count($pageids); $i++) {
239 $td = HTML::td(array('align' => 'left', 'bgcolor' => '#f7f7f7'));
240 $td->pushContent(HTML::a(array('href' => WikiURL($pageids[$i]),
243 SplitPagename($pageids[$i])));
244 $tr->pushContent($td);
247 for ($j = 0; $j < count($people); $j++) {
248 $td = HTML::td(array('align' => 'right', 'bgcolor' => '#f7f7f7'));
249 $output = $outputArray[$people[$j]][$pageids[$i]];
250 $total_cans = $total_cans + $output;
256 $td->pushContent($output);
257 $tr->pushContent($td);
259 if ($total_cans == "") {
262 if ($total_voters == "") {
265 $td = HTML::td(array('align' => 'right'));
266 $td->pushContent($total_cans);
267 $tr->pushContent($td);
268 $td = HTML::td(array('align' => 'right'));
269 $td->pushContent($total_voters);
270 $tr->pushContent($td);
271 $table->pushContent($tr);
275 $td = HTML::td(array('align' => 'left'));
276 $td->pushContent(HTML::strong(_("Total Budget")));
277 $tr->pushContent($td);
280 for ($i = 0; $i < count($people); $i++) {
281 $td = HTML::td(array('align' => 'right'));
283 foreach ($pageids as $page) {
284 $cans_for_soda = $cans_for_soda + $outputArray[$people[$i]][$page];
286 $cans = $cans_for_soda;
287 $cans_total = $cans_total + $cans;
293 $td->pushContent(HTML::strong($cans));
294 $tr->pushContent($td);
296 $td = HTML::td(array('align' => 'right'));
297 $td->pushContent(HTML::strong($cans_total));
298 $tr->pushContent($td);
299 $td = HTML::td(array('align' => 'right'));
300 $td->pushContent(HTML::strong($total_voters));
301 $tr->pushContent($td);
302 $table->pushContent($tr);
304 $table2 = HTML::table(array('bgcolor' => '#dedfdf'));
305 $table2->pushContent(HTML::tr(HTML::td($table)));
306 $html->pushContent($table2);
319 // c-hanging-comment-ender-p: nil
320 // indent-tabs-mode: nil