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';
43 require_once 'lib/wikilens/Utils.php';
44 require_once 'lib/WikiTheme.php';
45 require_once 'lib/wikilens/Buddy.php';
46 require_once 'lib/wikilens/RatingsDb.php';
48 class WikiPlugin_PreferenceApp
53 return _("PreferenceApp");
56 function getDescription()
58 return _("Analyze preferences based on voting budget and ratings.");
61 function getDefaultArguments()
65 'lockedBudget' => null,
66 'pageTextLabel' => null,
68 'roundCalc' => "true",
69 'neutralRating' => "3",
70 'declareBudget' => "true");
73 // info arg allows multiple columns
74 // info=mtime,hits,summary,version,author,locked,minor
75 // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
77 function run($dbi, $argstr, &$request, $basepage)
80 extract($this->getArgs($argstr, $request));
81 if ($pageTextLabel == null && $category != null && $group == null) {
84 if ($category == null || $pageTextLabel == null) {
85 return HTML::div(array('class' => "error"), "PreferencesApp Error: You must declare at least parameters category and pageTextLabel.");
88 $dbi = $request->getDbh();
89 $rdbi = RatingsDb::getTheRatingsDb();
91 $CATEGORY = $category;
92 $PAGE_TEXT_LABEL = $pageTextLabel;
93 $NEUTRAL_RATING = (int)$neutralRating;
95 $active_user = $request->getUser();
96 $active_userid = $active_user->_userid;
98 $html->pushContent("");
100 //Load participating Users
101 $users_array = array();
102 if ($group != null) {
103 $users_array = getMembers($group, $rdbi);
105 $people_iter = $rdbi->sql_get_users_rated();
106 while ($people_array = $people_iter->next()) {
107 $users_array[] = $people_array['pagename'];
111 foreach ($users_array as $person_indv) {
112 if ($declareBudget == "true") {
113 $get_array = getPageTextData($person_indv, $dbi, $PAGE_TEXT_LABEL, "cans");
114 if (count($get_array) == 1) {
115 $cans_text = $get_array[0];
116 if (is_numeric($cans_text) && $cans_text >= 0) {
117 $canBudget[$person_indv] = $cans_text; //Load the persons budget
119 $canBudget[$person_indv] = 0;
121 $people[] = $person_indv;
124 $canBudget[$person_indv] = $lockedBudget;
125 $people[] = $person_indv;
128 if (count($people) < 1) {
129 return fmt("Nobody has used %s on their homepage", $PAGE_TEXT_LABEL);
131 //Get all pages from Category
133 $category_page = $dbi->getPage($CATEGORY);
134 $iter = $category_page->getLinks();
135 while ($item = $iter->next()) {
136 array_push($pageids, $item->getName());
138 $ratingTotals = array();
139 foreach ($people as $person) {
140 $ratings_iter = $rdbi->sql_get_rating(0, $person, $pageids);
141 $ratingTotals[$person] = 0;
142 while ($ratings_array = $ratings_iter->next()) {
143 $can_rating = $ratings_array['ratingvalue'];
144 if ($can_rating >= $NEUTRAL_RATING) {
145 $ratingTotals[$person] += $can_rating;
151 $canTotals = array();
152 $peopleTotals = array();
153 foreach ($pageids as $soda) {
154 $canTotals[$soda] = 0;
156 foreach ($people as $person) {
157 foreach ($pageids as $soda) {
158 $peopleTotals[$person][$soda] = 0;
161 foreach ($people as $person) {
162 foreach ($pageids as $page) {
163 $can_rating_iter = $rdbi->sql_get_rating(0, $person, $page);
164 $can_rating_array = $can_rating_iter->next();
165 $can_rating = $can_rating_array['ratingvalue'];
166 if ($can_rating >= $NEUTRAL_RATING) {
167 $calc = (($can_rating / $ratingTotals[$person]) * $canBudget[$person]);
168 if ($roundCalc == "true") {
169 $adjustedCans = round($calc);
171 $adjustedCans = round($calc, 2);
173 $peopleTotals[$person][$page] = $adjustedCans;
175 $canTotals[$page] = $canTotals[$page] + $adjustedCans;
179 $outputArray = array();
180 foreach ($people as $person) {
181 foreach ($pageids as $page) {
182 $outputArray[$person][$page] = 0;
186 $table = HTML::table(array('cellpadding' => '5', 'cellspacing' => '1', 'border' => '0'));
188 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
189 $td->pushContent(" ");
190 $tr->pushContent($td);
192 foreach ($people as $person) {
193 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
194 $td->pushContent(HTML::a(array('href' => WikiURL($person),
197 SplitPagename($person)));
198 //$td->pushContent(WikiLink(" $person "));
199 $tr->pushContent($td);
201 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
202 $td->pushContent(_("Total Units"));
203 $tr->pushContent($td);
204 $td = HTML::td(array('bgcolor' => '#FFFFFF'));
205 $td->pushContent(_("Total Voters"));
206 $tr->pushContent($td);
207 $table->pushContent($tr);
209 for ($i = 0; $i < count($pageids); $i++) {
211 for ($j = 0; $j < count($people); $j++) {
212 $td = HTML::td(array('align' => 'right'));
213 $cans_per_soda = $peopleTotals[$people[$j]][$pageids[$i]];
214 $total_cans = $total_cans + $cans_per_soda;
215 $outputArray[$people[$j]][$pageids[$i]] = $cans_per_soda;
219 foreach ($people as $person) {
221 $min_cans = 9999999; //9 million, serving as "infinity"
223 foreach ($pageids as $page) {
224 $cur_soda_cans = $outputArray[$person][$page];
225 if ($cur_soda_cans < $min_cans && $cur_soda_cans > 0) {
226 $min_cans = $cur_soda_cans;
229 $total_cans = $total_cans + $cur_soda_cans;
231 if ($total_cans != $canBudget[$person] && $total_cans > 0) {
232 $diff = $canBudget[$person] - $total_cans;
233 $outputArray[$person][$min_soda] = $outputArray[$person][$min_soda] + $diff;
236 for ($i = 0; $i < count($pageids); $i++) {
238 $td = HTML::td(array('align' => 'left', 'bgcolor' => '#f7f7f7'));
239 $td->pushContent(HTML::a(array('href' => WikiURL($pageids[$i]),
242 SplitPagename($pageids[$i])));
243 $tr->pushContent($td);
246 for ($j = 0; $j < count($people); $j++) {
247 $td = HTML::td(array('align' => 'right', 'bgcolor' => '#f7f7f7'));
248 $output = $outputArray[$people[$j]][$pageids[$i]];
249 $total_cans = $total_cans + $output;
255 $td->pushContent($output);
256 $tr->pushContent($td);
258 if ($total_cans == "") {
261 if ($total_voters == "") {
264 $td = HTML::td(array('align' => 'right'));
265 $td->pushContent($total_cans);
266 $tr->pushContent($td);
267 $td = HTML::td(array('align' => 'right'));
268 $td->pushContent($total_voters);
269 $tr->pushContent($td);
270 $table->pushContent($tr);
274 $td = HTML::td(array('align' => 'left'));
275 $td->pushContent(HTML::strong(_("Total Budget")));
276 $tr->pushContent($td);
279 for ($i = 0; $i < count($people); $i++) {
280 $td = HTML::td(array('align' => 'right'));
282 foreach ($pageids as $page) {
283 $cans_for_soda = $cans_for_soda + $outputArray[$people[$i]][$page];
285 $cans = $cans_for_soda;
286 $cans_total = $cans_total + $cans;
292 $td->pushContent(HTML::strong($cans));
293 $tr->pushContent($td);
295 $td = HTML::td(array('align' => 'right'));
296 $td->pushContent(HTML::strong($cans_total));
297 $tr->pushContent($td);
298 $td = HTML::td(array('align' => 'right'));
299 $td->pushContent(HTML::strong($total_voters));
300 $tr->pushContent($td);
301 $table->pushContent($tr);
303 $table2 = HTML::table(array('bgcolor' => '#dedfdf'));
304 $table2->pushContent(HTML::tr(HTML::td($table)));
305 $html->pushContent($table2);
316 // c-hanging-comment-ender-p: nil
317 // indent-tabs-mode: nil