* The MIT License:
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
class Js_Pref_Voter
{
var $options, // Array( JS idx => name of cand, party, "all others" or "-" )
$n_options, // count($options)
$real_cands, // Like parameter $candidates of constructor but without any parties
$n_real_cands; // count($real_cands)
// UI strings
var $shared_pos_str, $up_symbol, $down_symbol, $del_symbol;
var $js_to_candid, // Array( JS array idx => cand id )
$party_cands; // Array( party's JS array id (or False) => Array( cand's JS array idx ))
// The constructor.
// Parameter $candidates has the following format:
//
// array( [party_name => array( cand id => cand name, ... ) | cand id cand name ], ... )
//
// I.e. the array can contain both candidates that are in some party and those who are not.
// Nested parties are not allowed. Example:
//
// $ice_creams = Array(
// "Fruits" => Array(
// 1 => "banana",
// 2 => "pineapple",
// 3 => "orange",
// 4 => "mango"),
// "Berries" => Array(
// 5 => "strawberry",
// 6 => "blueberry",
// 7 => "blackberry",
// 8 => "lingonberry"),
// "Classics" => Array(
// 9 => "vanilla",
// 10 => "chocolate chips",
// 11 => "toffe"),
// "Specials" => Array(
// 12 => "tofu based",
// 13 => "liqorice",
// 14 => "green tea",
// 15 => "garlic"),
// 16 => "Grandma's home made"
// );
function Js_Pref_Voter( $candidates,
$up_sym = '',
$down_sym = '',
$del_sym = '',
$shared_pos_str = "...",
$all_others_str = "(all others)" )
{
// Build some arrays from candidate list
$this->real_cands = Array();
$this->options = Array( 0=>'-' );
$this->js_to_candid = Array();
$this->party_cands = Array();
$i = 1;
foreach( $candidates as $party => $cands )
{
if ( is_array( $cands ))
{
$this->options[] = '(' . $party . ')';
$cur_party = $i;
$this->party_cands[$cur_party] = Array();
$i++;
foreach( $cands as $candid => $c )
{
$this->party_cands[$cur_party][] = $i;
$this->js_to_candid[$i] = $candid;
$this->options[] = " " . $c;
$this->real_cands[$candid] = $c;
$i++;
}
}
else if ( is_string( $cands ))
{
$candid = $party;
$this->options[] = $cands;
$this->party_cands[false][] = $i;
$this->js_to_candid[$i] = $candid;
$this->real_cands[$candid] = $cands;
$i++;
}
}
$this->options[] = $all_others_str;
$this->n_options = count($this->options);
$this->n_real_cands = count($this->real_cands);
// Save appearance preferences
$this->shared_pos_str = $shared_pos_str;
$this->up_symbol = $up_sym;
$this->down_symbol = $down_sym;
$this->del_symbol = $del_sym;
}
// Returns an array of form Array( => Array(, ...), ... )
// or False if $vote is not a valid vote string as generated by the Javascript.
// You may wish to pass the result to Expand_Parties
function Parse_Vote_String($vote)
{
$res = Array();
$counts = array_fill(1, $this->n_options, 0);
foreach( explode("_", $vote) as $str )
{
$pair = explode("-", $str);
if ( count($pair) == 2 )
{
$pos = (int)$pair[0];
$cand = (int)$pair[1];
// Check that both position and candidate
// are within range
if ( $pos < 1 || $pos > $this->n_options ||
$cand < 1 || $cand > $this->n_options )
return False;
if ( !isset($res[$pos]))
$res[$pos] = Array();
$res[$pos][] = $cand;
// Check that each candidate exist at most once
if ( ++$counts[$cand] > 1)
return false;
}
}
if ( count($res) > $this->n_options)
return false;
return $res;
}
/*
function Make_Matrix()
{
$names = array();
$mtx = array();
$candid_to_row = array();
foreach( $this->real_cands as $id=>$name )
{
$row = array();
foreach( $this->real_cands as $id2=>$name2 )
$row[] = 0;
$mtx[] = $row;
$names[] = $name;
$candid_to_row[$id] = count($mtx)-1;
}
}
*/
// "Expands" array from Parse_Vote_String() by
// replacing all parties with their members and then
// "all others" by non-mentioned candidates.
function Expand_Parties( $vote_array )
{
// Build a list of explicitly mentioned individuals
$mentioned_explicitly = array();
foreach( $vote_array as $slot )
foreach( $slot as $i )
if ( isset( $this->js_to_candid[$i] )) // is a real candidate?
$mentioned_explicitly[$i] = True;
// Expand parties
foreach( $vote_array as $slot_i => $slot )
foreach( $slot as $i_idx => $i )
if ( isset($this->party_cands[$i])) // is a party?
{
foreach( $this->party_cands[$i] as $c )
if ( !isset($mentioned_explicitly[$c]))
{
$vote_array[$slot_i][] = $c;
$mentioned_explicitly[$c] = True;
}
unset($vote_array[$slot_i][$i_idx]);
}
// Expand "all others"
$ao_idx = count($this->options)-1;
foreach( $vote_array as $slot_i => $slot )
foreach( $slot as $i_idx => $i )
if ( $i == $ao_idx )
{
unset($vote_array[$slot_i][$i_idx]);
foreach( $this->js_to_candid as $c => $db_candid )
if ( !isset($mentioned_explicitly[$c]))
{
$vote_array[$slot_i][] = $c;
$mentioned_explicitly[$c] = True;
}
break;
}
// Clean up empty positions, if any
foreach( $vote_array as $i => $slot )
if ( count($slot) == 0 )
unset( $vote_array[$i] );
// Sanity checks (debug / defensive programming)
$mentioned = array();
foreach( $vote_array as $slot_i => $slot )
foreach( $slot as $i_idx => $i )
{
assert( !isset( $mentioned[$i] )); // must not be a duplicate
assert( isset( $this->js_to_candid[$i] )); // must be persons
$mentioned[$i] = True;
}
return $vote_array;
}
// Prints out a Javascript code that should be positioned in the section
// of the page. Parameter $pre_fill may contain an array as returned by Parse_Vote_Strings().
// If $pre_fill is not empty, the ballot split is pre-filled accordingly.
function Print_Ballot_Filler_Head( $pre_fill = Array() )
{
?>
',
$down_sym = '
',
$del_sym = '
',
$shared_pos_str = "...",
$all_others_str = "(all others)" )
{
// Build some arrays from candidate list
$this->real_cands = Array();
$this->options = Array( 0=>'-' );
$this->js_to_candid = Array();
$this->party_cands = Array();
$i = 1;
foreach( $candidates as $party => $cands )
{
if ( is_array( $cands ))
{
$this->options[] = '(' . $party . ')';
$cur_party = $i;
$this->party_cands[$cur_party] = Array();
$i++;
foreach( $cands as $candid => $c )
{
$this->party_cands[$cur_party][] = $i;
$this->js_to_candid[$i] = $candid;
$this->options[] = " " . $c;
$this->real_cands[$candid] = $c;
$i++;
}
}
else if ( is_string( $cands ))
{
$candid = $party;
$this->options[] = $cands;
$this->party_cands[false][] = $i;
$this->js_to_candid[$i] = $candid;
$this->real_cands[$candid] = $cands;
$i++;
}
}
$this->options[] = $all_others_str;
$this->n_options = count($this->options);
$this->n_real_cands = count($this->real_cands);
// Save appearance preferences
$this->shared_pos_str = $shared_pos_str;
$this->up_symbol = $up_sym;
$this->down_symbol = $down_sym;
$this->del_symbol = $del_sym;
}
// Returns an array of form Array(