SurveySearch Class Reference

Class for search actions in ILIAS survey tool. More...

Collaboration diagram for SurveySearch:

Public Member Functions
	__construct ($search_text="", $concatenation=self::CONCAT_AND, $search_field="all", $search_type="all")
	SurveySearch constructor. More...
	search ()
	Executes a search. More...

Data Fields
const	CONCAT_AND = 0
const	CONCAT_OR = 1
	$search_terms
	$concatenation
	$search_field
	$search_type
	$search_results
	$ilDB

Protected Attributes
	$rbacsystem

Detailed Description

Class for search actions in ILIAS survey tool.

The SurveySearch class defines and encapsulates basic methods and attributes to search the ILIAS survey tool for questions.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version

$Id$

Definition at line 34 of file class.SurveySearch.php.

Constructor & Destructor Documentation

__construct()

SurveySearch::__construct	(		$search_text = "",
			$concatenation = self::CONCAT_AND,
			$search_field = "all",
			$search_type = "all"
	)

SurveySearch constructor.

The constructor takes possible arguments an creates an instance of the SurveySearch object.

Parameters

string	$title	A title string to describe the question
string	$description	A description string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator public

Definition at line 110 of file class.SurveySearch.php.

References $concatenation, $DIC, $ilDB, $search_field, and $search_type.

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $ilDB = $DIC->database();

        $this->ilDB = $ilDB;

        $this->search_terms = explode(" +", $search_text);
        $this->concatenation = $concatenation;
        $this->search_field = $search_field;
        $this->search_type = $search_type;
        $this->search_results = array();
    }

Member Function Documentation

search()

SurveySearch::search

(

)

Executes a search.

Executes a search

public

Definition at line 133 of file class.SurveySearch.php.

References $ilDB, PHPMailer\PHPMailer\$params, $rbacsystem, $result, and $row.

    {
        $ilDB = $this->ilDB;
        
        $where = "";
        $fields = array();
        if (strcmp($this->search_type, "all") != 0) {
            $where = "svy_qtype.type_tag = " . $ilDB->quote($this->search_type, 'text');
        }
        foreach ($this->search_terms as $term) {
            switch ($this->search_field) {
                case "all":
                    $fields["$term"] = array();
                    array_push($fields["$term"], $ilDB->like("svy_question.title", 'text', "%" . $term . "%"));
                    array_push($fields["$term"], $ilDB->like("svy_question.description", 'text', "%" . $term . "%"));
                    array_push($fields["$term"], $ilDB->like("svy_question.author", 'text', "%" . $term . "%"));
                    array_push($fields["$term"], $ilDB->like("svy_question.questiontext", 'text', "%" . $term . "%"));
                    break;
                default:
                    $fields["$term"] = array();
                    array_push($fields["$term"], $ilDB->like("svy_question." . $this->search_field, 'text', "%" . $term . "%"));
                    break;
            }
        }
        $cumulated_fields = array();
        foreach ($fields as $params) {
            array_push($cumulated_fields, "(" . join(" OR ", $params) . ")");
        }
        $str_where = "";
        if ($this->concatenation == self::CONCAT_AND) {
            $str_where = "(" . join(" AND ", $cumulated_fields) . ")";
        } else {
            $str_where = "(" . join(" OR ", $cumulated_fields) . ")";
        }
        if ($str_where) {
            $str_where = " AND $str_where";
        }
        if ($where) {
            $str_where .= " AND (" . $where . ")";
        }
        $result = $ilDB->query("SELECT svy_question.*, svy_qtype.type_tag, object_reference.ref_id FROM " .
            "svy_question, svy_qtype, object_reference WHERE svy_question.questiontype_fi = svy_qtype.questiontype_id " .
            "AND svy_question.original_id IS NULL AND svy_question.obj_fi = object_reference.obj_id AND " .
            "svy_question.obj_fi > 0$str_where");
        $result_array = array();
        $rbacsystem = $this->rbacsystem;
        if ($result->numRows() > 0) {
            while ($row = $ilDB->fetchAssoc($result)) {
                if (($row["complete"] == 1) and ($rbacsystem->checkAccess('write', $row["ref_id"]))) {
                    array_push($result_array, $row);
                }
            }
        }
        $this->search_results = &$result_array;
    }

Field Documentation

$concatenation

SurveySearch::$concatenation

Definition at line 60 of file class.SurveySearch.php.

Referenced by __construct().

$ilDB

SurveySearch::$ilDB

Definition at line 96 of file class.SurveySearch.php.

Referenced by __construct(), and search().

$rbacsystem

SurveySearch::$rbacsystem

protected

Definition at line 39 of file class.SurveySearch.php.

Referenced by search().

$search_field

SurveySearch::$search_field

Definition at line 69 of file class.SurveySearch.php.

Referenced by __construct().

$search_results

SurveySearch::$search_results

Definition at line 87 of file class.SurveySearch.php.

$search_terms

SurveySearch::$search_terms

Definition at line 51 of file class.SurveySearch.php.

$search_type

SurveySearch::$search_type

Definition at line 78 of file class.SurveySearch.php.

Referenced by __construct().

CONCAT_AND

const SurveySearch::CONCAT_AND = 0

Definition at line 41 of file class.SurveySearch.php.

CONCAT_OR

const SurveySearch::CONCAT_OR = 1

Definition at line 42 of file class.SurveySearch.php.

---

The documentation for this class was generated from the following file:

• Modules/Survey/classes/class.SurveySearch.php