ilObjectSearch Class Reference

Inheritance diagram for ilObjectSearch:

Collaboration diagram for ilObjectSearch:

Public Member Functions
	__construct (&$qp_obj)
	Constructor @access public. More...
	performSearch ()
	__createInStatement ()
	setCreationDateFilterDate (ilDate $day)
	Set creation date filter. More...
	setCreationDateFilterOperator ($a_operator)
	getCreationDateFilterDate ()
	getCreationDateFilterOperator ()
Public Member Functions inherited from ilAbstractSearch
	__construct ($qp_obj)
	Constructor @access public. More...
	setFields ($a_fields)
	Set fields to search. More...
	getFields ()
	Get fields to search. More...
	setFilter ($a_filter)
	set object type to search in More...
	setIdFilter ($a_id_filter)
	Set id filter Filters search by given object id. More...
	getIdFilter ()
	Get Id filter. More...
	appendToFilter ($a_type)
	Append object type to filter. More...
	getFilter ()
	get object type to search in More...
	__createLocateString ()
	build locate string in case of AND search More...
	__prepareFound (&$row)
	performSearch ()

Data Fields
const	CDATE_OPERATOR_BEFORE = 1
const	CDATE_OPERATOR_AFTER = 2
const	CDATE_OPERATOR_ON = 3
Data Fields inherited from ilAbstractSearch
	$db = null
	$query_parser = null
	$search_result = null
	$object_types

Private Attributes
	$cdate_operator = null
	$cdate_date = null

Detailed Description

Definition at line 37 of file class.ilObjectSearch.php.

Constructor & Destructor Documentation

__construct()

ilObjectSearch::__construct

(

&

$qp_obj

)

Constructor @access public.

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

    {
        parent::__construct($qp_obj);
 
        $this->setFields(array('title','description'));
    }

References ilAbstractSearch\setFields().

Here is the call graph for this function:

Member Function Documentation

__createInStatement()

ilObjectSearch::__createInStatement

(

)

Definition at line 113 of file class.ilObjectSearch.php.

    {
        global $ilDB;
 
        $in = ' AND ' . $ilDB->in('type', (array) $this->object_types, false, 'text');
        if ($this->getIdFilter()) {
            $in .= ' AND ';
            $in .= $ilDB->in('obj_id', $this->getIdFilter(), false, 'integer');
        }
        return $in;
    }

References $ilDB, $in, and ilAbstractSearch\getIdFilter().

Referenced by performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

getCreationDateFilterDate()

ilObjectSearch::getCreationDateFilterDate

(

)

Definition at line 139 of file class.ilObjectSearch.php.

    {
        return $this->cdate_date;
    }

References $cdate_date.

Referenced by performSearch().

Here is the caller graph for this function:

getCreationDateFilterOperator()

ilObjectSearch::getCreationDateFilterOperator

(

)

Definition at line 144 of file class.ilObjectSearch.php.

    {
        return $this->cdate_operator;
    }

References $cdate_operator.

Referenced by performSearch().

Here is the caller graph for this function:

performSearch()

ilObjectSearch::performSearch

(

)

Reimplemented from ilAbstractSearch.

Definition at line 61 of file class.ilObjectSearch.php.

    {
        global $ilDB;
        
        $in = $this->__createInStatement();
        $where = $this->__createWhereCondition();
        
        
        
        $cdate = '';
        if ($this->getCreationDateFilterDate() instanceof ilDate) {
            if ($this->getCreationDateFilterOperator()) {
                switch ($this->getCreationDateFilterOperator()) {
                    case self::CDATE_OPERATOR_AFTER:
                        $cdate = 'AND create_date >= ' . $ilDB->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
                        break;
                    
                    case self::CDATE_OPERATOR_BEFORE:
                        $cdate = 'AND create_date <= ' . $ilDB->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
                        break;
                    
                    case self::CDATE_OPERATOR_ON:
                        $cdate = 'AND ' . $ilDB->like(
                            'create_date',
                            'text',
                            $this->getCreationDateFilterDate()->get(IL_CAL_DATE) . '%'
                        );
                        break;
                }
            }
        }
        
        $locate = $this->__createLocateString();
 
        $query = "SELECT obj_id,type " .
            $locate .
            "FROM object_data " .
            $where . " " . $cdate . ' ' . $in . ' ' .
            "ORDER BY obj_id DESC";
        
        ilLoggerFactory::getLogger('src')->debug('Object search query: ' . $query);
        
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->search_result->addEntry($row->obj_id, $row->type, $this->__prepareFound($row));
        }
        return $this->search_result;
    }

References $ilDB, $in, $query, $res, $row, ilAbstractSearch\$search_result, __createInStatement(), ilAbstractSearch\__createLocateString(), CDATE_OPERATOR_AFTER, CDATE_OPERATOR_BEFORE, CDATE_OPERATOR_ON, ilDBConstants\FETCHMODE_OBJECT, getCreationDateFilterDate(), getCreationDateFilterOperator(), ilLoggerFactory\getLogger(), and IL_CAL_DATE.

Here is the call graph for this function:

setCreationDateFilterDate()

ilObjectSearch::setCreationDateFilterDate

(

ilDate

$day

)

Set creation date filter.

Definition at line 129 of file class.ilObjectSearch.php.

    {
        $this->cdate_date = $day;
    }

Referenced by ilSearchGUI\parseCreationFilter().

Here is the caller graph for this function:

setCreationDateFilterOperator()

ilObjectSearch::setCreationDateFilterOperator

(

$a_operator

)

Definition at line 134 of file class.ilObjectSearch.php.

    {
        $this->cdate_operator = $a_operator;
    }

Referenced by ilSearchGUI\parseCreationFilter().

Here is the caller graph for this function:

Field Documentation

$cdate_date

ilObjectSearch::$cdate_date = null

private

Definition at line 44 of file class.ilObjectSearch.php.

Referenced by getCreationDateFilterDate().

$cdate_operator

ilObjectSearch::$cdate_operator = null

private

Definition at line 43 of file class.ilObjectSearch.php.

Referenced by getCreationDateFilterOperator().

CDATE_OPERATOR_AFTER

const ilObjectSearch::CDATE_OPERATOR_AFTER = 2

Definition at line 40 of file class.ilObjectSearch.php.

Referenced by ilSearchGUI\parseCreationFilter(), and performSearch().

CDATE_OPERATOR_BEFORE

const ilObjectSearch::CDATE_OPERATOR_BEFORE = 1

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

Referenced by ilSearchGUI\parseCreationFilter(), and performSearch().

CDATE_OPERATOR_ON

const ilObjectSearch::CDATE_OPERATOR_ON = 3

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

Referenced by ilSearchGUI\parseCreationFilter(), and performSearch().

---

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

• Services/Search/classes/class.ilObjectSearch.php