ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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.

52 {
53 parent::__construct($qp_obj);
54
55 $this->setFields(array('title','description'));
56 }
setFields($a_fields)
Set fields to search.
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References ILIAS\GlobalScreen\Provider\__construct(), and ilAbstractSearch\setFields().

+ Here is the call graph for this function:

Member Function Documentation

◆ __createInStatement()

ilObjectSearch::__createInStatement ( )

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

116 {
117 global $DIC;
118
119 $ilDB = $DIC['ilDB'];
120
121 $in = ' AND ' . $ilDB->in('type', (array) $this->object_types, false, 'text');
122 if ($this->getIdFilter()) {
123 $in .= ' AND ';
124 $in .= $ilDB->in('obj_id', $this->getIdFilter(), false, 'integer');
125 }
126 return $in;
127 }
if(php_sapi_name() !='cli') $in
Definition: Utf8Test.php:37
getIdFilter()
Get Id filter.
global $ilDB
$DIC
Definition: xapitoken.php:46

References $DIC, $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 143 of file class.ilObjectSearch.php.

144 {
145 return $this->cdate_date;
146 }

References $cdate_date.

Referenced by performSearch().

+ Here is the caller graph for this function:

◆ getCreationDateFilterOperator()

ilObjectSearch::getCreationDateFilterOperator ( )

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

149 {
151 }

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.

62 {
63 global $DIC;
64
65 $ilDB = $DIC['ilDB'];
66
67 $in = $this->__createInStatement();
68 $where = $this->__createWhereCondition();
69
70
71
72 $cdate = '';
73 if ($this->getCreationDateFilterDate() instanceof ilDate) {
74 if ($this->getCreationDateFilterOperator()) {
75 switch ($this->getCreationDateFilterOperator()) {
77 $cdate = 'AND create_date >= ' . $ilDB->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
78 break;
79
81 $cdate = 'AND create_date <= ' . $ilDB->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
82 break;
83
85 $cdate = 'AND ' . $ilDB->like(
86 'create_date',
87 'text',
88 $this->getCreationDateFilterDate()->get(IL_CAL_DATE) . '%'
89 );
90 break;
91 }
92 }
93 }
94
95 $locate = $this->__createLocateString();
96
97 $query = "SELECT obj_id,type " .
98 $locate .
99 "FROM object_data " .
100 $where . " " . $cdate . ' ' . $in . ' ' .
101 "ORDER BY obj_id DESC";
102
103 ilLoggerFactory::getLogger('src')->debug('Object search query: ' . $query);
104
105 $res = $this->db->query($query);
106 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
107 $this->search_result->addEntry($row->obj_id, $row->type, $this->__prepareFound($row));
108 }
110 }
const IL_CAL_DATE
__createLocateString()
build locate string in case of AND search
Class for single dates.
static getLogger($a_component_id)
Get component logger.
$query
foreach($_POST as $key=> $value) $res

References $DIC, $ilDB, $in, $query, $res, 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 133 of file class.ilObjectSearch.php.

134 {
135 $this->cdate_date = $day;
136 }

Referenced by ilSearchGUI\parseCreationFilter().

+ Here is the caller graph for this function:

◆ setCreationDateFilterOperator()

ilObjectSearch::setCreationDateFilterOperator (   $a_operator)

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

139 {
140 $this->cdate_operator = $a_operator;
141 }

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: