ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
ilExportFieldsInfo Class Reference
+ Collaboration diagram for ilExportFieldsInfo:

Public Member Functions

 getType ()
 Get object type. More...
 
 isExportable ($a_field_name)
 Check if field is exportable. More...
 
 getFieldsInfo ()
 Get informations (exportable) about user data profile fields. More...
 
 getExportableFields ()
 Get Exportable Fields. More...
 
 getSelectableFieldsInfo ($a_obj_id)
 Get selectable fields. More...
 
 exportableFieldsToInfoString ()
 Get exportable fields as info string. More...
 
 sortExportFields ()
 sort Exports fields User for Name Presentation Guideline More...
 

Static Public Member Functions

static _getInstanceByType ($a_type)
 Get Singleton Instance. More...
 

Private Member Functions

 __construct ($a_type)
 Private Singleton Constructor. More...
 
 read ()
 Read info about exportable fields. More...
 

Private Attributes

 $settings
 
 $db
 
 $lng
 
 $obj_type = ''
 
 $possible_fields = array()
 

Static Private Attributes

static $instance = null
 

Detailed Description

Definition at line 33 of file class.ilExportFieldsInfo.php.

Constructor & Destructor Documentation

◆ __construct()

ilExportFieldsInfo::__construct (   $a_type)
private

Private Singleton Constructor.

Use getInstance

private

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

References $ilDB, $ilSetting, $lng, and read().

52  {
53  global $ilDB,$ilSetting,$lng;
54 
55  $this->db = $ilDB;
56  $this->lng = $lng;
57  $this->settings = $ilSetting;
58 
59  $this->obj_type = $a_type;
60 
61  $this->read();
62  }
$ilSetting
global $ilSetting
Definition: privfeed.php:40
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilExportFieldsInfo\read
read()
Read info about exportable fields.
Definition: class.ilExportFieldsInfo.php:228
+ Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByType()

static ilExportFieldsInfo::_getInstanceByType (   $a_type)
static

Get Singleton Instance.

public

Definition at line 70 of file class.ilExportFieldsInfo.php.

Referenced by ilMemberExportGUI\__construct(), ilMemberAgreementGUI\addExportFieldInfo(), ilRegistrationGUI\fillAgreement(), ilMemberExport\getOrderedExportableFields(), ilParticipantTableGUI\getSelectableColumns(), ilSubscriberTableGUI\getSelectableColumns(), ilWaitingListTableGUI\getSelectableColumns(), ilObjCourseGUI\infoScreen(), and ilObjGroupGUI\infoScreen().

71  {
72  if(is_object(self::$instance[$a_type]))
73  {
74  return self::$instance[$a_type];
75  }
76  return self::$instance[$a_type] = new ilExportFieldsInfo($a_type);
77  }
+ Here is the caller graph for this function:

◆ exportableFieldsToInfoString()

ilExportFieldsInfo::exportableFieldsToInfoString ( )

Get exportable fields as info string.

public

Returns
string info page string

Definition at line 212 of file class.ilExportFieldsInfo.php.

References getExportableFields().

213  {
214  $fields = array();
215  foreach($this->getExportableFields() as $field)
216  {
217  $fields[] = $this->lng->txt($field);
218  }
219  return implode('<br />',$fields);
220  }
ilExportFieldsInfo\getExportableFields
getExportableFields()
Get Exportable Fields.
Definition: class.ilExportFieldsInfo.php:117
+ Here is the call graph for this function:

◆ getExportableFields()

ilExportFieldsInfo::getExportableFields ( )

Get Exportable Fields.

public

Definition at line 117 of file class.ilExportFieldsInfo.php.

Referenced by exportableFieldsToInfoString(), and getSelectableFieldsInfo().

118  {
119  foreach($this->possible_fields as $field => $exportable)
120  {
121  if($exportable)
122  {
123  $fields[] = $field;
124  }
125  }
126  return $fields ? $fields : array();
127  }
+ Here is the caller graph for this function:

◆ getFieldsInfo()

ilExportFieldsInfo::getFieldsInfo ( )

Get informations (exportable) about user data profile fields.

public

Definition at line 107 of file class.ilExportFieldsInfo.php.

References $possible_fields.

108  {
109  return $this->possible_fields;
110  }

◆ getSelectableFieldsInfo()

ilExportFieldsInfo::getSelectableFieldsInfo (   $a_obj_id)

Get selectable fields.

Returns

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

References $GLOBALS, $lng, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), getExportableFields(), getType(), and ilBookingEntry\hasObjectBookingEntries().

134  {
135  global $lng;
136 
137  $fields = array();
138  foreach($this->getExportableFields() as $field)
139  {
140  switch($field)
141  {
142  case 'lastname':
143  case 'firstname':
144  break;
145 
146  case 'username':
147  $fields['login']['txt'] = $lng->txt('login');
148  $fields['login']['default'] = 1;
149  break;
150 
151  default:
152  // #18795
153  $caption = ($field == "title")
154  ? "person_title"
155  : $field;
156  $fields[$field]['txt'] = $lng->txt($caption);
157  $fields[$field]['default'] = 0;
158  break;
159  }
160  }
161 
162  include_once './Services/Booking/classes/class.ilBookingEntry.php';
163  if(ilBookingEntry::hasObjectBookingEntries($a_obj_id, $GLOBALS['ilUser']->getId()))
164  {
165  $GLOBALS['lng']->loadLanguageModule('dateplaner');
166  $fields['consultation_hour']['txt'] = $GLOBALS['lng']->txt('cal_ch_field_ch');
167  $fields['consultation_hour']['default'] = 0;
168  }
169 
170  include_once './Services/User/classes/class.ilUserDefinedFields.php';
171  if($this->getType() == 'crs')
172  {
173  $udf = ilUserDefinedFields::_getInstance()->getCourseExportableFields();
174  }
175  elseif($this->getType() == 'grp')
176  {
177  $udf = ilUserDefinedFields::_getInstance()->getGroupExportableFields();
178  }
179  if($udf)
180  {
181  foreach($udf as $field_id => $field)
182  {
183  $fields['udf_'.$field_id]['txt'] = $field['field_name'];
184  $fields['udf_'.$field_id]['default'] = 0;
185  }
186  }
187 
188  include_once './Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php';
189  $cdf = ilCourseDefinedFieldDefinition::_getFields($a_obj_id);
190  foreach($cdf as $def)
191  {
192  $fields['odf_'.$def->getId()]['txt'] = $def->getName();
193  $fields['odf_'.$def->getId()]['default'] = 0;
194  }
195 
196  if(count($cdf))
197  {
198  // add last edit
199  $fields['odf_last_update']['txt'] = $GLOBALS['lng']->txt($this->getType().'_cdf_tbl_last_edit');
200  $fields['odf_last_update']['default'] = 0;
201  }
202 
203  return $fields;
204  }
ilBookingEntry\hasObjectBookingEntries
static hasObjectBookingEntries($a_obj_id, $a_usr_id)
Check if object has assigned consultation hour appointments.
Definition: class.ilBookingEntry.php:473
ilUserDefinedFields\_getInstance
static _getInstance()
Get instance.
Definition: class.ilUserDefinedFields.php:46
ilExportFieldsInfo\getType
getType()
Get object type.
Definition: class.ilExportFieldsInfo.php:83
ilExportFieldsInfo\getExportableFields
getExportableFields()
Get Exportable Fields.
Definition: class.ilExportFieldsInfo.php:117
$GLOBALS
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
ilCourseDefinedFieldDefinition\_getFields
static _getFields($a_container_id, $a_sort=IL_CDF_SORT_NAME)
Get all fields of a container.
Definition: class.ilCourseDefinedFieldDefinition.php:138
+ Here is the call graph for this function:

◆ getType()

ilExportFieldsInfo::getType ( )

Get object type.

Returns

Definition at line 83 of file class.ilExportFieldsInfo.php.

References $obj_type.

Referenced by getSelectableFieldsInfo(), and read().

84  {
85  return $this->obj_type;
86  }
+ Here is the caller graph for this function:

◆ isExportable()

ilExportFieldsInfo::isExportable (   $a_field_name)

Check if field is exportable.

public

Parameters
stringfield name
Returns
bool

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

97  {
98  return array_key_exists($a_field_name,$this->possible_fields);
99  }

◆ read()

ilExportFieldsInfo::read ( )
private

Read info about exportable fields.

private

Definition at line 228 of file class.ilExportFieldsInfo.php.

References $data, and getType().

Referenced by __construct().

229  {
230  include_once './Services/User/classes/class.ilUserProfile.php';
231 
232  $profile = new ilUserProfile();
233  $profile->skipGroup('settings');
234 
235  foreach($profile->getStandardFields() as $key => $data)
236  {
237  if($this->getType() == 'crs')
238  {
239  if(!$data['course_export_hide'])
240  {
241  if(isset($data['course_export_fix_value']) and $data['course_export_fix_value'])
242  {
243  $this->possible_fields[$key] = $data['course_export_fix_value'];
244  }
245  else
246  {
247  $this->possible_fields[$key] = 0;
248  }
249  }
250  }
251  elseif($this->getType() == 'grp')
252  {
253  if(!$data['group_export_hide'])
254  {
255  if(isset($data['group_export_fix_value']) and $data['group_export_fix_value'])
256  {
257  $this->possible_fields[$key] = $data['group_export_fix_value'];
258  }
259  else
260  {
261  $this->possible_fields[$key] = 0;
262  }
263  }
264  }
265  }
266  $settings_all = $this->settings->getAll();
267 
268  $field_part_limit = 5;
269  switch($this->getType())
270  {
271  case 'crs':
272  $field_prefix = 'usr_settings_course_export_';
273  $field_part_limit = 5;
274  break;
275 
276  case 'grp':
277  $field_prefix = 'usr_settings_group_export_';
278  $field_part_limit = 5;
279  break;
280  }
281 
282  foreach($settings_all as $key => $value)
283  {
284  if(stristr($key,$field_prefix) and $value)
285  {
286  // added limit for mantis 11096
287  $field_parts = explode('_',$key,$field_part_limit);
288  $field = $field_parts[count($field_parts) - 1];
289  if(array_key_exists($field,$this->possible_fields))
290  {
291  $this->possible_fields[$field] = 1;
292  }
293  }
294  }
295  return true;
296  }
ilUserProfile
Class ilUserProfile.
Definition: class.ilUserProfile.php:15
ilExportFieldsInfo\getType
getType()
Get object type.
Definition: class.ilExportFieldsInfo.php:83
$data
$data
Definition: example_011.php:126
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sortExportFields()

ilExportFieldsInfo::sortExportFields ( )

sort Exports fields User for Name Presentation Guideline

Definition at line 301 of file class.ilExportFieldsInfo.php.

302  {
303 
304  $start_order = array("lastname" => array(), "firstname" => array(), "username" => array());
305 
306  foreach($start_order as $key => $value)
307  {
308  if(isset($this->possible_fields[$key]))
309  {
310  $start_order[$key] = $this->possible_fields[$key];
311  unset($this->possible_fields[$key]);
312  }else
313  {
314  unset($start_order[$key]);
315  }
316  }
317 
318  if(count($start_order) > 0)
319  {
320  $this->possible_fields = array_merge($start_order, $this->possible_fields);
321  }
322  }

Field Documentation

◆ $db

ilExportFieldsInfo::$db
private

Definition at line 38 of file class.ilExportFieldsInfo.php.

◆ $instance

ilExportFieldsInfo::$instance = null
staticprivate

Definition at line 35 of file class.ilExportFieldsInfo.php.

◆ $lng

ilExportFieldsInfo::$lng
private

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

Referenced by __construct(), and getSelectableFieldsInfo().

◆ $obj_type

ilExportFieldsInfo::$obj_type = ''
private

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

Referenced by getType().

◆ $possible_fields

ilExportFieldsInfo::$possible_fields = array()
private

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

Referenced by getFieldsInfo().

◆ $settings

ilExportFieldsInfo::$settings
private

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

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