ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilObjCertificateSettingsGUI Class Reference

Certificate Settings. More...

+ Inheritance diagram for ilObjCertificateSettingsGUI:
+ Collaboration diagram for ilObjCertificateSettingsGUI:

Public Member Functions

 __construct ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Contructor. More...
 
 executeCommand ()
 Execute command. More...
 
 getAdminTabs ()
 Get tabs. More...
 
 settings ()
 Edit settings. More...
 
 save ()
 
- Public Member Functions inherited from ilObjectGUI
 executeCommand ()
 execute command More...
 
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not) More...
 
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
 
 getCreationMode ()
 get creation mode More...
 
 prepareOutput ($a_show_subobjects=true)
 prepare output More...
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
 getHTML ()
 
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
 
 cancelDeleteObject ()
 cancel deletion of object More...
 
 cancelObject ()
 cancel action and go back to previous page public More...
 
 createObject ()
 create new object form More...
 
 cancelCreation ()
 cancel create action and go back to repository parent More...
 
 saveObject ()
 save object More...
 
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. More...
 
 editObject ()
 edit object More...
 
 addExternalEditFormCustom (ilPropertyFormGUI $a_form)
 
 updateObject ()
 updates object entry in object_data More...
 
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g. More...
 
 isVisible ($a_ref_id, $a_type)
 
 viewObject ()
 list childs of current object More...
 
 deleteObject ($a_error=false)
 Display deletion confirmation screen. More...
 
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI. More...
 

Protected Attributes

 $hierarchical_access
 
 $access
 
 $error
 
- Protected Attributes inherited from ilObjectGUI
 $ilErr
 
 $locator
 
 $user
 
 $access
 
 $settings
 
 $rbacreview
 
 $toolbar
 
 $rbacsystem
 
 $tmp_import_dir
 
 $tabs_gui = null
 
 $ctrl
 

Static Private Attributes

static $ERROR_MESSAGE
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root. More...
 
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root. More...
 
- Data Fields inherited from ilObjectGUI
const COPY_WIZARD_NEEDS_PAGE = 1
 
 $objDefinition
 
 $tpl
 
 $tree
 
 $lng
 
 $data
 
 $object
 
 $ref_id
 
 $obj_id
 
 $maxcount
 
 $formaction
 
 $return_location
 
 $target_frame
 
 $tab_target_script
 
 $actions
 
 $sub_objects
 
 $omit_locator = false
 
const CFORM_NEW = 1
 
const CFORM_IMPORT = 2
 
const CFORM_CLONE = 3
 
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 
 setTitleAndDescription ()
 called by prepare output More...
 
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu. More...
 
 insertHeaderAction ($a_list_gui)
 Insert header action into main template. More...
 
 addHeaderAction ()
 Add header action menu. More...
 
 redrawHeaderActionObject ()
 Ajax call: redraw action header only. More...
 
 showMountWebfolderIcon ()
 
 setTabs ()
 set admin tabs public More...
 
 setAdminTabs ()
 set admin tabs public More...
 
 setLocator ()
 set Locator More...
 
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 omitLocator ($a_omit=true)
 
 addAdminLocatorItems ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion) More...
 
 initCreateForm ($a_new_type)
 Init object creation form. More...
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types. More...
 
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates. More...
 
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 Init object edit form. More...
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 Get values for edit form. More...
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 initImportForm ($a_new_type)
 Init object import form. More...
 
 importFileObject ($parent_id=null, $a_catch_errors=true)
 Import. More...
 
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook. More...
 
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command More...
 
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command More...
 
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command More...
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl. More...
 
 getTabs ()
 get tabs abstract method. More...
 
 __showButton ($a_cmd, $a_text, $a_target='')
 
 hitsperpageObject ()
 
__initTableGUI ()
 
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table More...
 
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
 
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings (ilColumnGUI $column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error. More...
 
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission. More...
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilObjCertificateSettingsGUI::__construct (   $a_data,
  $a_id = 0,
  $a_call_by_reference = true,
  $a_prepare_output = true 
)

Contructor.

public

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

References $DIC.

62  {
63  global $DIC;
64 
65  parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
66  $this->type = 'cert';
67  $this->lng->loadLanguageModule("certificate");
68 
69  $this->access = $DIC['rbacsystem'];
70  $this->error = $DIC['ilErr'];
71  $this->hierarchical_access = $DIC['ilAccess'];
72  }
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ executeCommand()

ilObjCertificateSettingsGUI::executeCommand ( )

Execute command.

public

Definition at line 80 of file class.ilObjCertificateSettingsGUI.php.

References ilObjectGUI\prepareOutput().

81  {
82  $next_class = $this->ctrl->getNextClass($this);
83  $cmd = $this->ctrl->getCmd();
84 
85  $this->prepareOutput();
86 
87  if (!$this->hierarchical_access->checkAccess('read', '', $this->object->getRefId())) {
88  $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
89  }
90 
91  switch ($next_class) {
92  case 'ilpermissiongui':
93  $this->tabs_gui->setTabActive('perm_settings');
94  include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
95  $perm_gui = new ilPermissionGUI($this);
96  $this->ctrl->forwardCommand($perm_gui);
97  break;
98 
99  default:
100  if (!$cmd || $cmd == 'view') {
101  $cmd = "settings";
102  }
103 
104  $this->$cmd();
105  break;
106  }
107  return true;
108  }
prepareOutput($a_show_subobjects=true)
prepare output
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjCertificateSettingsGUI::getAdminTabs ( )

Get tabs.

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

References array.

114  {
115  if ($this->access->checkAccess("visible,read", $this->object->getRefId())) {
116  $this->tabs_gui->addTarget(
117  "settings",
118  $this->ctrl->getLinkTarget($this, "settings"),
119  array("settings", "view")
120  );
121  }
122 
123  if ($this->access->checkAccess('edit_permission', $this->object->getRefId())) {
124  $this->tabs_gui->addTarget(
125  "perm_settings",
126  $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
127  array(),
128  'ilpermissiongui'
129  );
130  }
131  }
Create styles array
The data for the language used.

◆ save()

ilObjCertificateSettingsGUI::save ( )

Definition at line 202 of file class.ilObjCertificateSettingsGUI.php.

References $_POST, ilUtil\sendSuccess(), and settings().

203  {
204  $form_settings = new ilSetting("certificate");
205  $form_settings->set("pageformat", $_POST["pageformat"]);
206  $form_settings->set("active", $_POST["active"]);
207 
208  ilUtil::sendSuccess($this->lng->txt("settings_saved"));
209  $this->settings();
210  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
$_POST["username"]
+ Here is the call graph for this function:

◆ settings()

ilObjCertificateSettingsGUI::settings ( )

Edit settings.

Definition at line 136 of file class.ilObjCertificateSettingsGUI.php.

References $_POST, $form, $format, $info, $result, array, object, ilCheckboxInputGUI\setChecked(), ilFormPropertyGUI\setRequired(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

Referenced by save().

137  {
138  $this->tabs_gui->setTabActive('settings');
139  $form_settings = new ilSetting("certificate");
140 
141  include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
142  $form = new ilPropertyFormGUI();
143  $form->setFormAction($this->ctrl->getFormAction($this));
144  $form->setTitle($this->lng->txt('certificate_settings'));
145 
146  $active = new ilCheckboxInputGUI($this->lng->txt("active"), "active");
147  $active->setChecked($form_settings->get("active"));
148  $form->addItem($active);
149 
150  $info = new ilNonEditableValueGUI($this->lng->txt("info"), "info");
151  $info->setValue($this->lng->txt("certificate_usage"));
152  $form->addItem($info);
153 
154  $bgimage = new ilImageFileInputGUI($this->lng->txt("certificate_background_image"), "background");
155  $bgimage->setRequired(false);
156  if (count($_POST)) {
157  // handle the background upload
158  if (strlen($_FILES["background"]["tmp_name"])) {
159  if ($bgimage->checkInput()) {
160  $result = $this->object->uploadBackgroundImage($_FILES["background"]["tmp_name"]);
161  if ($result == false) {
162  $bgimage->setAlert($this->lng->txt("certificate_error_upload_bgimage"));
163  }
164  }
165  }
166  }
167  if (strlen($this->object->hasBackgroundImage())) {
168  require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
170  $bgimage->setImage(ilWACSignedPath::signFile($this->object->getBackgroundImageThumbPathWeb()));
171  }
172  $bgimage->setInfo($this->lng->txt("default_background_info"));
173  $form->addItem($bgimage);
174  $format = new ilSelectInputGUI($this->lng->txt("certificate_page_format"), "pageformat");
175  $defaultformats = array(
176  "a4" => $this->lng->txt("certificate_a4"), // (297 mm x 210 mm)
177  "a4landscape" => $this->lng->txt("certificate_a4_landscape"), // (210 mm x 297 mm)",
178  "a5" => $this->lng->txt("certificate_a5"), // (210 mm x 148.5 mm)
179  "a5landscape" => $this->lng->txt("certificate_a5_landscape"), // (148.5 mm x 210 mm)
180  "letter" => $this->lng->txt("certificate_letter"), // (11 inch x 8.5 inch)
181  "letterlandscape" => $this->lng->txt("certificate_letter_landscape") // (11 inch x 8.5 inch)
182  );
183  $format->setOptions($defaultformats);
184  $format->setValue($form_settings->get("pageformat"));
185  $format->setInfo($this->lng->txt("certificate_page_format_info"));
186  $form->addItem($format);
187 
188 
189  if ($this->hierarchical_access->checkAccess('write', '', $this->object->getRefId())) {
190  $form->addCommandButton('save', $this->lng->txt('save'));
191  }
192 
193  $this->tpl->setContent($form->getHTML());
194 
195  if (strcmp($this->ctrl->getCmd(), "save") == 0) {
196  if ($_POST["background_delete"]) {
197  $this->object->deleteBackgroundImage();
198  }
199  }
200  }
$format
Definition: metadata.php:141
This class represents a selection list property in a property form.
$result
This class represents a property form user interface.
This class represents a checkbox property in a property form.
setChecked($a_checked)
Set Checked.
if(isset($_POST['submit'])) $form
static signFile($path_to_file)
Create styles array
The data for the language used.
This class represents an image file property in a property form.
This class represents a non editable value in a property form.
Create new PHPExcel object
obj_idprivate
static setTokenMaxLifetimeInSeconds($token_max_lifetime_in_seconds)
$info
Definition: index.php:5
$_POST["username"]
setRequired($a_required)
Set Required.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $access

ilObjCertificateSettingsGUI::$access
protected

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

◆ $error

ilObjCertificateSettingsGUI::$error
protected

Definition at line 52 of file class.ilObjCertificateSettingsGUI.php.

◆ $ERROR_MESSAGE

ilObjCertificateSettingsGUI::$ERROR_MESSAGE
staticprivate

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

◆ $hierarchical_access

ilObjCertificateSettingsGUI::$hierarchical_access
protected

Definition at line 42 of file class.ilObjCertificateSettingsGUI.php.


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