ILIAS  release_8 Revision v8.24
Public Member Functions | Data Fields | Private Attributes
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 ()
 

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)

Reimplemented from ilAbstractSearch.

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

48 {
49 parent::__construct($qp_obj);
50 $this->setFields(array('title','description'));
51 }
ilAbstractSearch\setFields
setFields(array $a_fields)
Definition: class.ilAbstractSearch.php:54
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:37

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 105 of file class.ilObjectSearch.php.

105 : string
106 {
107 $in = ' AND ' . $this->db->in('type', (array) $this->object_types, false, 'text');
108 if ($this->getIdFilter()) {
109 $in .= ' AND ';
110 $in .= $this->db->in('obj_id', $this->getIdFilter(), false, 'integer');
111 }
112 return $in;
113 }

References 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 126 of file class.ilObjectSearch.php.

126 : ?ilDate
127 {
128 return $this->cdate_date;
129 }
ilDate
Class for single dates.
Definition: class.ilDate.php:34

References $cdate_date.

Referenced by performSearch().

+ Here is the caller graph for this function:

◆ getCreationDateFilterOperator()

ilObjectSearch::getCreationDateFilterOperator ( )

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

131 : ?int
132 {
133 return $this->cdate_operator;
134 }

References $cdate_operator.

Referenced by performSearch().

+ Here is the caller graph for this function:

◆ performSearch()

ilObjectSearch::performSearch ( )

Reimplemented from ilAbstractSearch.

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

56 : ilSearchResult
57 {
58 $in = $this->__createInStatement();
59 $where = $this->__createWhereCondition();
60
61
62
63 $cdate = '';
64 if ($this->getCreationDateFilterDate() instanceof ilDate) {
65 if ($this->getCreationDateFilterOperator()) {
66 switch ($this->getCreationDateFilterOperator()) {
67 case self::CDATE_OPERATOR_AFTER:
68 $cdate = 'AND create_date >= ' . $this->db->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
69 break;
70
71 case self::CDATE_OPERATOR_BEFORE:
72 $cdate = 'AND create_date <= ' . $this->db->quote($this->getCreationDateFilterDate()->get(IL_CAL_DATE), 'text') . ' ';
73 break;
74
75 case self::CDATE_OPERATOR_ON:
76 $cdate = 'AND ' . $this->db->like(
77 'create_date',
78 'text',
79 $this->getCreationDateFilterDate()->get(IL_CAL_DATE) . '%'
80 );
81 break;
82 }
83 }
84 }
85
86 $locate = $this->__createLocateString();
87
88 $query = "SELECT obj_id,type " .
89 $locate .
90 "FROM object_data " .
91 $where . " " . $cdate . ' ' . $in . ' ' .
92 "ORDER BY obj_id DESC";
93
94 ilLoggerFactory::getLogger('src')->debug('Object search query: ' . $query);
95
96 $res = $this->db->query($query);
97 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
98 $this->search_result->addEntry((int) $row->obj_id, (string) $row->type, $this->__prepareFound($row));
99 }
100 return $this->search_result;
101 }
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:8
ilAbstractSearch\$search_result
ilSearchResult $search_result
Definition: class.ilAbstractSearch.php:24
ilLoggerFactory\getLogger
static getLogger(string $a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:89
$res
$res
Definition: ltiservices.php:69
$query
$query
Definition: proxy_ylocal.php:13

References $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)

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

116 : void
117 {
118 $this->cdate_date = $day;
119 }

Referenced by ilSearchGUI\parseCreationFilter().

+ Here is the caller graph for this function:

◆ setCreationDateFilterOperator()

ilObjectSearch::setCreationDateFilterOperator ( int  $a_operator)

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

121 : void
122 {
123 $this->cdate_operator = $a_operator;
124 }

Referenced by ilSearchGUI\parseCreationFilter().

+ 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(), ilSearchGUI\parseOperatorFromCreationFilter(), and performSearch().

◆ CDATE_OPERATOR_BEFORE

const ilObjectSearch::CDATE_OPERATOR_BEFORE = 1

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

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

◆ CDATE_OPERATOR_ON

const ilObjectSearch::CDATE_OPERATOR_ON = 3

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

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

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