chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added documentation to the extraFieldOption class

Browse Source
skala
Yannick Warnier 13 years ago
parent 6ae7543c8e
commit 5524559cc3
1 changed files with 106 additions and 19 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 125
      main/inc/lib/extra_field_option.lib.php

125
main/inc/lib/extra_field_option.lib.php
Unescape View File

@ -1,9 +1,18 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Declaration of the ExtraFieldOption class
*/
/**
* Handles the extra fields for various objects (users, sessions, courses)
*/
class ExtraFieldOption extends Model {
public $columns = array('id', 'field_id', 'option_value', 'option_display_text', 'option_order', 'tms');
/**
* Gets the table for the type of object for which we are using an extra field
* @param string Type of object (course, user or session)
*/
public function __construct($type) {
$this->type = $type;
switch ($this->type) {
@ -18,17 +27,30 @@ class ExtraFieldOption extends Model {
break;
}
}
/**
* Gets the number of options already available in the table for this item type
* @return int Number of options available
*/
public function get_count() {
$row = Database::select('count(*) as count', $this->table, array(), 'first');
return $row['count'];
}
/**
* Gets the number of options available for this field
* @param int Field ID
* @return int Number of options
*/
public function get_count_by_field_id($field_id) {
$row = Database::select('count(*) as count', $this->table, array('where' => array('field_id = ?' => $field_id)), 'first');
return $row['count'];
}
/**
* Returns a list of options for a specific field, separated by ";"
* @param int Field ID
* @param bool Indicates whether we want the results to be given with their id
* @param string Order by clause (without the "order by") to be added to the SQL query
* @return string List of options separated by ;
*/
public function get_field_options_to_string($field_id, $add_id_in_array = false, $ordered_by = null) {
$options = self::get_field_options_by_field($field_id, $add_id_in_array, $ordered_by);
$new_options = array();
@ -40,13 +62,22 @@ class ExtraFieldOption extends Model {
return $string;
}
}
/**
* Delete all the options of a specific field
* @param int Field ID
* @result void
*/
public function delete_all_options_by_field_id($field_id) {
$field_id = intval($field_id);
$sql = "DELETE FROM {$this->table} WHERE field_id = $field_id";
Database::query($sql);
}
/**
* Saves an option into the corresponding *_field_options table
* @param array Parameters to be considered for the insertion
* @param bool Whether to show the query (sent to the parent save() method)
* @return bool True on success, false on error
*/
public function save($params, $show_query = false) {
$field_id = intval($params['field_id']);
@ -133,7 +164,13 @@ class ExtraFieldOption extends Model {
}
return true;
}
/**
* Save one option item at a time
* @param array Parameters specific to the option
* @param bool Whether to show the query (sent to parent save() method)
* @param bool Whether to insert even if the option already exists
* @return bool True on success, false on failure
*/
public function save_one_item($params, $show_query = false, $insert_repeated = true) {
$field_id = intval($params['field_id']);
if (empty($field_id)) {
@ -153,8 +190,14 @@ class ExtraFieldOption extends Model {
parent::save($params, $show_query);
}
}
return true;
}
/**
* Get the complete row of a specific option of a specific field
* @param int Field ID
* @param string Value of the option
* @return mixed The row on success or false on failure
*/
public function get_field_option_by_field_and_option($field_id, $option_value) {
$field_id = intval($field_id);
$option_value = Database::escape_string($option_value);
@ -166,7 +209,12 @@ class ExtraFieldOption extends Model {
}
return false;
}
/**
* Get the complete row of a specific option's display text of a specific field
* @param int Field ID
* @param string Display value of the option
* @return mixed The row on success or false on failure
*/
public function get_field_option_by_field_id_and_option_display_text($field_id, $option_display_text) {
$field_id = intval($field_id);
$option_display_text = Database::escape_string($option_display_text);
@ -178,7 +226,13 @@ class ExtraFieldOption extends Model {
}
return false;
}
/**
* Get the complete row of a specific option's display text of a specific field
* @param int Field ID
* @param string Display value of the option
* @param string Value of the option
* @return mixed The row on success or false on failure
*/
public function get_field_option_by_field_id_and_option_display_text_and_option_value($field_id, $option_display_text, $option_value) {
$field_id = intval($field_id);
$option_display_text = Database::escape_string($option_display_text);
@ -191,7 +245,13 @@ class ExtraFieldOption extends Model {
}
return false;
}
/**
* Gets an array of options for a specific field
* @param int The field ID
* @param bool Whether to add the row ID in the result
* @param string Extra ordering query bit
* @result mixed Row on success, false on failure
*/
public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null) {
$field_id = intval($field_id);
$option_value = Database::escape_string($option_value);
@ -217,7 +277,13 @@ class ExtraFieldOption extends Model {
}
return false;
}
/**
* Get options for a specific field as array or in JSON format suited for the double-select format
* @param int Field ID
* @param int Option value ID
* @param bool Return format (whether it should be formatted to JSON or not)
* @return mixed Row/JSON on success
*/
public function get_second_select_field_options_by_field($field_id, $option_value_id, $to_json = false) {
$field_id = intval($field_id);
$option_value_id = intval($option_value_id);
@ -245,6 +311,12 @@ class ExtraFieldOption extends Model {
return $options;
}
/**
* Get options for a specific field as string split by ;
* @param int Field ID
* @param string Extra query bit for reordering
* @return string HTML string of options
*/
public function get_field_options_by_field_to_string($field_id, $ordered_by = null) {
$field = new ExtraField($this->type);
$field_info = $field->get($field_id);
@ -268,7 +340,11 @@ class ExtraFieldOption extends Model {
return null;
}
/**
* Get the maximum order value for a specific field
* @param int Field ID
* @return int Current max ID + 1 (we start from 0)
*/
public function get_max_order($field_id) {
$field_id = intval($field_id);
$sql = "SELECT MAX(option_order) FROM {$this->table} WHERE field_id = $field_id";
@ -280,12 +356,18 @@ class ExtraFieldOption extends Model {
}
return $max;
}
/**
* Update the option using the given params
* @param array Parameters with the data to be saved
*/
public function update($params) {
parent::update($params);
}
//Form
/**
* Display a form with the options for the field_id given in REQUEST
* @return void Prints output
*/
function display() {
// action links
echo '<div class="actions">';
@ -295,7 +377,12 @@ class ExtraFieldOption extends Model {
echo '</div>';
echo Display::grid_html('extra_field_options');
}
/**
* Returns an HTML form for the current field
* @param string URL to send the form to (action=...)
* @param string Type of action to offer through the form (edit, usually)
* @return string HTML form
*/
public function return_form($url, $action) {
$form_name = $this->type.'_field';
$form = new FormValidator($form_name, 'post', $url);
@ -334,5 +421,5 @@ class ExtraFieldOption extends Model {
//$form->addRule('field_variable', get_lang('ThisFieldIsRequired'), 'required');
$form->addRule('option_value', get_lang('ThisFieldIsRequired'), 'required');
return $form;
}
}
}
}

Write Preview
Loading…
Cancel
Save