ilObjectSearch Class Reference

Inheritance diagram for ilObjectSearch:

Collaboration diagram for ilObjectSearch:

Public Member Functions
	__construct (ilQueryParser $qp_obj)
	performSearch ()
	__createInStatement ()
	setCreationDateFilterDate (ilDate $day)
	setCreationDateFilterOperator (int $a_operator)
	getCreationDateFilterDate ()
	getCreationDateFilterOperator ()
Public Member Functions inherited from ilAbstractSearch
	__construct (ilQueryParser $qp_obj)
	setFields (array $a_fields)
	getFields ()
	setFilter (array $a_filter)
	setIdFilter (array $a_id_filter)
	getIdFilter ()
	appendToFilter (string $a_type)
	getFilter ()
	__createLocateString ()
	__prepareFound (object $row)
	performSearch ()

Static Public Member Functions
static	raiseContentChanged (int $obj_id)

Data Fields
const	CDATE_OPERATOR_BEFORE = 1
const	CDATE_OPERATOR_AFTER = 2
const	CDATE_OPERATOR_ON = 3

Private Attributes
int	$cdate_operator = null
ilDate	$cdate_date = null

Additional Inherited Members
Protected Attributes inherited from ilAbstractSearch
ilDBInterface	$db
ilQueryParser	$query_parser
ilSearchResult	$search_result
array	$object_types

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjectSearch::__construct

(

ilQueryParser

$qp_obj

)

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

References ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilAbstractSearch\setFields().

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

Here is the call graph for this function:

Member Function Documentation

__createInStatement()

ilObjectSearch::__createInStatement

(

)

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

References ilAbstractSearch\getIdFilter().

Referenced by performSearch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCreationDateFilterDate()

ilObjectSearch::getCreationDateFilterDate

(

)

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

References $cdate_date.

Referenced by performSearch().

                                               : ?ilDate
    {
        return $this->cdate_date;
    }

Here is the caller graph for this function:

getCreationDateFilterOperator()

ilObjectSearch::getCreationDateFilterOperator

(

)

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

References $cdate_operator.

Referenced by performSearch().

                                                   : ?int
    {
        return $this->cdate_operator;
    }

Here is the caller graph for this function:

performSearch()

ilObjectSearch::performSearch

(

)

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

References $res, ilAbstractSearch\$search_result, __createInStatement(), ilAbstractSearch\__createLocateString(), ilDBConstants\FETCHMODE_OBJECT, getCreationDateFilterDate(), getCreationDateFilterOperator(), ilLoggerFactory\getLogger(), and IL_CAL_DATE.

                                   : ilSearchResult
    {
        $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 >= ' . $this->db->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
                        break;

                    case self::CDATE_OPERATOR_BEFORE:
                        $cdate = 'AND create_date <= ' . $this->db->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
                        break;

                    case self::CDATE_OPERATOR_ON:
                        $cdate = 'AND ' . $this->db->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((int) $row->obj_id, (string) $row->type, $this->__prepareFound($row));
        }
        return $this->search_result;
    }

Here is the call graph for this function:

raiseContentChanged()

static ilObjectSearch::raiseContentChanged ( int  $obj_id )

static

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

References $DIC.

Referenced by ilExAssignment\save(), ilWikiPage\update(), and ilExAssignment\update().

                                                            : void
    {
        global $DIC;

        $DIC->event()->raise(
            'Services/Search',
            'contentChanged',
            [
                "obj_id" => $obj_id
            ]
        );
    }

Here is the caller graph for this function:

setCreationDateFilterDate()

ilObjectSearch::setCreationDateFilterDate

(

ilDate

$day

)

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

Referenced by ilSearchGUI\parseCreationFilter().

                                                          : void
    {
        $this->cdate_date = $day;
    }

Here is the caller graph for this function:

setCreationDateFilterOperator()

ilObjectSearch::setCreationDateFilterOperator

(

int

$a_operator

)

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

Referenced by ilSearchGUI\parseCreationFilter().

                                                                  : void
    {
        $this->cdate_operator = $a_operator;
    }

Here is the caller graph for this function:

Field Documentation

$cdate_date

ilDate ilObjectSearch::$cdate_date = null

private

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

Referenced by getCreationDateFilterDate().

$cdate_operator

int 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 ilSearchResult\filter(), and ilSearchGUI\parseOperatorFromCreationFilter().

CDATE_OPERATOR_BEFORE

const ilObjectSearch::CDATE_OPERATOR_BEFORE = 1

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

Referenced by ilSearchResult\filter(), and ilSearchGUI\parseOperatorFromCreationFilter().

CDATE_OPERATOR_ON

const ilObjectSearch::CDATE_OPERATOR_ON = 3

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

Referenced by ilSearchResult\filter(), and ilSearchGUI\parseOperatorFromCreationFilter().

---

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

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