Changeset 265

Timestamp:

03/09/08 08:57:37 (9 months ago)

Author:

kevin

Message:

Added generic keyword support and profile_radio_group display category.

Files:

• prfext/README.txt (modified) (13 diffs)
• prfext/function_search.php (modified) (1 diff)
• prfext/lib.php (modified) (9 diffs)
• prfext/radioGroup.gif (added)

prfext/README.txt

@@ -33 +33 @@
-
-Four profile fields work immediately without further configuration.
+
+*Keyword fields*
+        
+When using any fields with prfext field types, you can use the "keyword_tag" 
+parameter to make this field act like Elgg keywords - they are searchable 
+and linked in the profile display.
-
-*Dates*
@@ -60 +66 @@
-        "required" => false,
-        "user_type" => "person",
+        "keyword_tag" => false
-        ));
-        
@@ -66 +73 @@
-Regardless of the date format displayed, the date values are always
-stored in the database in the ISO standard YYYY-MM-DD.
+
+Notice in this case that keyword_tag is set to false. In this case
+this field will not be searchable. You can also leave "keyword_tag"
+off altogether unless you want it to be true.
-
-*Smaller fields*
@@ -93 +104 @@
-will encourage people to enter only a few words for their minibio.
-
+$data['profile:details'][] = (object)(array(
+        "name" => __gettext("Town"),
+        "internal_name" => "town",
+        "field_type" => "profile_shorttext",
+        "description" => "",
+        "category" => __gettext("Location"),
+        "col1" => true,
+        "invisible" => false,
+        "required" => false,
+        "user_type" => "",
+        "keyword_tag" => true,
+        ));
+        
+provides a small amount of room for a town name. Notice that
+"keyword_tag" is set to true to make this field searchable. It
+will be linked in profiles if there are other people from
+the same town, and people will be able to search for these towns
+in the Elgg search box.
+
-*Selects, radio buttons and checkbox groups*
-
-display
+choices
-to register new display types with the Elgg profile system. You can use this
-function to define selects, radio buttons and checkbox groups and then use
-these new display types in your profile field descriptions.
-
-
-
-display($your_field_display_type,$prfext_display_category,$is_keyword_tag
+f
+
+choices($your_field_display_type,$prfext_display_category
-
-The valid prfext display categories are:
@@ -109 +139 @@
-profile_selectg
-profile_radio
+profile_radio_group
-profile_vertical_radio
-profile_checkbox
@@ -115 +146 @@
-You can find detailed examples explaining how to use these categories below.
-
-*New keyword display types*
-        
-The $is_keyword_tag parameter of prfext_display makes profile fields using 
-this display type act like Elgg keywords - they are searchable and linked
-in the profile display.
-
-*Simple select example*
-
-Here's a simple example:
-
-
-
-
-
+
+
+
-
-The values can be any phrase (including blanks) but must not include commas. The word 'null'
@@ -145 +169 @@
-        "required" => false,
-        "user_type" => "person",
+        "keyword_tag" => true,
-        ));
+        
+Notice the use of the "keyword_tag" value to make this field act like an
+Elgg keyword tag field.
-        
-You can use the same display type multiple times - for example, you might want
@@ -156 +184 @@
-For example:
-
-
+
+
-
-sets hockey as the default (pre-selected) value.
@@ -169 +198 @@
-There are two forms of radio buttons:
-
-
+
+
-
-presents 5 horizontal radio buttons.
-
-
+
+
-
-presents 5 vertical radio buttons, with one option displayed per line
@@ -184 +215 @@
-For example,
-
-display('sports','profile_radio',false
+choices('sports','profile_radio'
-    array(
-        'gb'=>'United Kingdom',
@@ -197 +228 @@
-In the profile, the appropriate label would be displayed instead of
-the internal code. This works for any of the available prfext display
-listed above
+defined by prfext_choices
-
-Display labels can be any Unicode string and can include commas, unlike
-internal values.
-
-Note that it is the internal values that would be used as searchable tags,
-and in this example, this profile field has $is_keyword__tag set
-to false to avoid creating potentially obscure searchable tags like 'be'.
-
-*Checkbox group example*
-
-Checkbox groups allow you to return more than one value.
-
-
-
-
+
+
+
+
+
-
-Similarly,
-
-
+
+
-
-returns a vertical list of 5 checkboxes, one option per line.
@@ -225 +255 @@
-For example,
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-*Select with option groups*
@@ -246 +300 @@
-Italy.
-
-display('countryregion','profile_selectg',false
+choices('countryregion','profile_selectg'
-            array(
-            'Northwestern Europe' =>  array(

prfext/function_search.php

@@ -32 +32 @@
-        $field_type = $CFG->prfext_keyword_field_names[$parameter[0]]->field_type;
-        $field_display_name = $CFG->prfext_keyword_field_names[$parameter[0]]->field_display_name;
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-                        }
-                    }
-                }
+            } else if ($display_type == 'profile_radio_group') {
+                $rows = $options[0];
+                $cols = $options[1];
+                if (prfext_array_is_associative($rows)) {
+                    $tp = explode(":",$tag);
+                    $display_value = $rows[$tp[0]] .': '. $cols[$tp[1]];
+                }
+            } else if (prfext_array_is_associative($options)) {
+                $display_value = $options[$tag];
-            }
-        } else if (prfext_array_is_associative($options)) {
-            $display_value = $options[$tag];
-        }
-

prfext/lib.php

@@ -29 +29 @@
-profile_radio,
-profile_vertical_radio,
+profile_radio_group,
-profile_checkbox,
-profile_vertical_checkbox,
@@ -68 +69 @@
-    foreach($data['profile:details'] as $field) {
-        $field_type = $field->field_type;
-
+
+
+
-            $d = new stdClass;
-            $d->field_type = $field_type;
@@ -84 +87 @@
-                                    'display_type' =>  $display_type,
-                                    'is_keyword_tag' => $is_keyword_tag,
+                                    'default_value' => $default_value,
+                                    'options' => $options
+                                    );
+    $CFG->display_field_module[$name] = 'prfext';
+    
+}
+
+function prfext_choices($name,$display_type,$default_value,$options) {
+    global $CFG;
+    
+    $CFG->prfext_data[$name] = (object) array(
+                                    'display_type' =>  $display_type,
-                                    'default_value' => $default_value,
-                                    'options' => $options
@@ -312 +327 @@
-        $run_result .= "<textarea name=\"".$cleanid."\" id=\"".$cleanid."\" style=\"width: 250px; height: 100px\">".htmlspecialchars(stripslashes($default_value), ENT_COMPAT, 'utf-8')."</textarea>";
-      break;
+      
+      case "profile_radio_group":
+          $r = rand();
+          $form_name_prefix = 'g'.$r;
+          $rowsLen = count($options[0]);
+          $columnsLen = count($options[1]);
+    
+          $run_result .= "
+              <script language=\"JavaScript\">
+              function select_field$form_name_prefix(form){
+                var result;
+                var contentFlag = false;
+                result = '';
+                for(i=0;i<$rowsLen;i++) {
+                  result += ',';
+                  for(j=0;j<$columnsLen;j++) {
+                    if (form['$form_name_prefix'+'_'+i][j].checked == true){
+                      result += form['$form_name_prefix'+'_'+i][j].value;
+                      contentFlag=true;
+                    }
+                  }
+                }
+    
+                if (!contentFlag){
+                  result = '';
+                }
+    
+                form['$cleanid'].value = result.substr(1);
+                if (form['$cleanid'].value == '') {
+                    form['$cleanid'].value = 'null';
+                }
+              }
+              </script>";
+
+          if ($default_value) {
+              $default_array_temp = explode(",",$default_value);
+              $default_array = array();
+              foreach($default_array_temp as $value) {
+                  if (count($v2 = explode(":",$value)) > 1) {
+                      $default_array[] = $v2[1];
+                  } else {
+                      $default_array[] = $value;
+                  }
+              }                      
+          }
+
+          $flagCorner = true;
+          $i = 0;
+          $rows = $options[0];
+          $columns = $options[1];
+
+          $run_result .= '<table width=100%>';
+          $run_result .= '<tr><td>&nbsp;</td>';
+          
+          $has_labels = prfext_array_is_associative($columns);
+          
+          if ($has_labels) {
+              foreach($columns as $col_k => $col_v){
+                $run_result .= '<td>'.$col_v.'</td>';
+              }
+    
+              foreach($rows as $row_k => $row_v){
+                $run_result .= '<tr><td>'.$row_v.'</td>';
+    
+                foreach($columns as $col_k => $col_v){
+                    $run_result .= '<td>'."<input type=\"radio\" onclick=\"select_field$form_name_prefix(this.form)\" name=\"".$form_name_prefix.'_'.$i."\" value=\"".$row_k.':'.$col_k."\" id=\"".$form_name_prefix.$i."\" ";
+                    if($default_value && $col_k == $default_array[$i]){
+                      $run_result .= " checked=\"true\" ";
+                    }
+                    $run_result .='></input></td>';
+                }
+    
+                $i++;
+                $run_result .='</tr>';
+              }
+          } else {         
+
+              foreach($columns as $column){
+                $run_result .= '<td>'.$column.'</td>';
+              }
+    
+              foreach($rows as $row){
+                $run_result .= '<tr><td>'.$row.'</td>';
+    
+                foreach($columns as $column){
+                    $run_result .= '<td>'."<input type=\"radio\" onclick=\"select_field$form_name_prefix(this.form)\" name=\"".$form_name_prefix.'_'.$i."\" value=\"".$row.':'.$column."\" id=\"".$form_name_prefix.$i."\" ";
+                    if($default_value && $column == $default_array[$i]){
+                      $run_result .= " checked=\"true\" ";
+                    }
+                    $run_result .='></input></td>';
+                }
+    
+                $i++;
+                $run_result .='</tr>';
+              }
+          }
+
+          $run_result .="
+          </table>
+          <input type=\"hidden\" name=\"".$cleanid."\" value=\"".$parameter[1]."\" id=\"".$cleanid."\" />";
+
+      break;
-    
-   }
@@ -319 +436 @@
-
-/*
-ata
+isplay
-display_output_field parameter array
-
@@ -328 +445 @@
-                        0 => data
-                        1 => type of input field
-input name to display (for forms etc
-reference name (for tag fields and so on
+reference name (for tag fields and so on
+input name to display (for forms etc
-                        4 => ID number (if any)
-                        5 => Owner (if not specified, current $page_owner is assumed)
@@ -348 +465 @@
-        $value = empty($parameter[0])?$d->default_value:$parameter[0];
-        $display_type = $d->display_type;
-        $is_keyword_tag = $d->is_keyword_tag;
-    } else {
-        $value = $parameter[0];
-        $display_type = $name;
+    }
+    if (!isset($CFG->prfext_keyword_field_names)) {
+        prfext_set_keyword_cache();
+    }
+    
+    if (isset($CFG->prfext_keyword_field_names[$parameter[2]])) {
+        $is_keyword_tag = true;
+    } else {        
-        $is_keyword_tag = false;
-    }
@@ -430 +554 @@
-      break;
-      
+      case 'profile_radio_group':
+        $final = '';
+        $options = $d->options;
+        $rows = $options[0];
+        $columns = $options[1];
+        $rowsLen = count($rows);
+        $rowsValue = explode(',',$value);
+        
+        $has_labels = prfext_array_is_associative($rows);
+        
+        if ($has_labels) {
+            for ($i = 0; $i < $rowsLen; $i++){
+                $rv = $rowsValue[$i];
+                if ($rv != ''){
+                    $v = explode(':',$rv);
+                    $item = $rows[$v[0]] . ' : <i>'. $columns[$v[1]] .'</i>';
+                    if ($is_keyword_tag && prfext_tag_count($rv) > 1) {
+                        $item = prfext_add_tag_link($item,$name,$rv);
+                    }
+                    $final .= ', ' . $item;
+                }
+            }
+        } else {
+            $i = 0;
+            foreach ($rows as $option){
+                $rv = $rowsValue[$i];
+                if ($rv != ''){
+                    $v = explode(':',$rv);
+                    $item = $option . ' : <i>'. $v[1] .'</i>';
+                    if ($is_keyword_tag && prfext_tag_count($rv) > 1) {
+                        $item = prfext_add_tag_link($item,$name,$rv);
+                    }
+                    $final .= ', ' . $item;
+                }
+                $i++;
+            }
+        }
+
+        return substr($final,1);
+
+      break;
+      
-      default:
-$options = $d->options;
-if (prfext_array_is_associative($options)) {
+if (isset($d->options) && prfext_array_is_associative($d->options)) {
+    $options = $d->options;
-            if ($is_keyword_tag && prfext_tag_count($value) > 1) {
-                return prfext_add_tag_link($options[$value],$name,$value);
@@ -453 +619 @@
-    global $CFG,$page_owner;
-    return "<a href=\"".$CFG->wwwroot."search/index.php?".$tagtype
-\n
+
-}    
-