ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilObjStyleSettingsGUI Class Reference

Style settings GUI class. More...

+ Inheritance diagram for ilObjStyleSettingsGUI:
+ Collaboration diagram for ilObjStyleSettingsGUI:

Public Member Functions

 __construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
 Constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 getAdminTabs ()
 ??? Save object More...
 
 getTabs ()
 get tabs public More...
 
- 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...
 
 redirectAfterCreation ()
 Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
 

Data Fields

 $pg_id = null
 
 $lng
 
 $tpl
 
- 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 Attributes

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

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...
 
- Protected Member Functions inherited from ilObjectGUI
 getObjectService ()
 Get object service. More...
 
 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()

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

Constructor.

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

References $DIC.

57  {
58  global $DIC;
59  $this->rbacsystem = $DIC->rbac()->system();
60 
61  $this->type = "stys";
62 
63  $this->dic = $DIC;
64  $this->ctrl = $DIC->ctrl();
65  $this->lng = $DIC->language();
66  $this->tabs = $DIC->tabs();
67 
68  parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
69 
70  $this->lng->loadLanguageModule("style");
71  }

Member Function Documentation

◆ executeCommand()

ilObjStyleSettingsGUI::executeCommand ( )

Execute command.

Definition at line 76 of file class.ilObjStyleSettingsGUI.php.

References $ret, and ilObjectGUI\prepareOutput().

77  {
78  $next_class = $this->ctrl->getNextClass($this);
79  $cmd = $this->ctrl->getCmd();
80 
81  if ($next_class == "" && in_array($cmd, array("view", ""))) {
82  $this->ctrl->redirectByClass("ilSystemStyleMainGUI", "");
83  }
84 
85  switch ($next_class) {
86  case 'ilpermissiongui':
87  $this->prepareOutput();
88  $this->tabs->activateTab("perm_settings");
89  include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
90  $perm_gui = new ilPermissionGUI($this);
91  $ret = $this->ctrl->forwardCommand($perm_gui);
92  break;
93 
94  case 'ilsystemstylemaingui':
95  $this->prepareOutput();
96  $this->tabs->activateTab("system_styles");
97  include_once("./Services/Style/System/classes/class.ilSystemStyleMainGUI.php");
98  $gui = new ilSystemStyleMainGUI();
99  $this->ctrl->forwardCommand($gui);
100  break;
101 
102  case 'ilpagelayoutadministrationgui':
103  $this->prepareOutput();
104  $this->tabs->activateTab("page_layouts");
105  include_once("./Services/COPage/Layout/classes/class.ilPageLayoutAdministrationGUI.php");
106  $gui = new ilPageLayoutAdministrationGUI();
107  $this->ctrl->forwardCommand($gui);
108  break;
109 
110  case 'ilcontentstylesettingsgui':
111  include_once("./Services/Style/Content/classes/class.ilContentStyleSettingsGUI.php");
112  $gui = new ilContentStyleSettingsGUI($this);
113  $this->ctrl->forwardCommand($gui);
114  if ($this->ctrl->getCmdClass() == "ilcontentstylesettingsgui") {
115  $this->tabs->activateTab("content_styles");
116  }
117  break;
118 
119  default:
120  $this->prepareOutput();
121  $cmd .= "Object";
122  $this->$cmd();
123 
124  break;
125  }
126  return true;
127  }
prepareOutput($a_show_subobjects=true)
prepare output
Settings UI class for system styles.
$ret
Definition: parser.php:6
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
Settings UI class for system styles.
+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjStyleSettingsGUI::getAdminTabs ( )

??? Save object

Definition at line 149 of file class.ilObjStyleSettingsGUI.php.

References getTabs().

150  {
151  $this->getTabs();
152  }
+ Here is the call graph for this function:

◆ getTabs()

ilObjStyleSettingsGUI::getTabs ( )

get tabs public

Parameters
objecttabs gui object

Definition at line 159 of file class.ilObjStyleSettingsGUI.php.

References $lng, $rbacsystem, and $tabs.

Referenced by getAdminTabs().

160  {
162  $lng = $this->lng;
163  $ilTabs = $this->tabs;
164 
165  if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
166  $this->tabs_gui->addTab(
167  "system_styles",
168  $this->lng->txt("system_styles"),
169  $this->ctrl->getLinkTargetByClass("ilsystemstylemaingui")
170  );
171 
172  $this->tabs_gui->addTab(
173  "content_styles",
174  $this->lng->txt("content_styles"),
175  $this->ctrl->getLinkTargetByClass("ilcontentstylesettingsgui", "edit")
176  );
177 
178  $this->tabs_gui->addTab(
179  "page_layouts",
180  $this->lng->txt("page_layouts"),
181  $this->ctrl->getLinkTargetByClass("ilpagelayoutadministrationgui", "")
182  );
183  }
184 
185  if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
186  $this->tabs_gui->addTab(
187  "perm_settings",
188  $this->lng->txt("perm_settings"),
189  $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
190  );
191  }
192  }
+ Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilObjStyleSettingsGUI::$ctrl
protected

Definition at line 36 of file class.ilObjStyleSettingsGUI.php.

◆ $DIC

ilObjStyleSettingsGUI::$DIC
protected

Definition at line 31 of file class.ilObjStyleSettingsGUI.php.

Referenced by __construct().

◆ $lng

ilObjStyleSettingsGUI::$lng

Definition at line 46 of file class.ilObjStyleSettingsGUI.php.

Referenced by getTabs().

◆ $pg_id

ilObjStyleSettingsGUI::$pg_id = null

Definition at line 26 of file class.ilObjStyleSettingsGUI.php.

◆ $rbacsystem

ilObjStyleSettingsGUI::$rbacsystem
protected

Definition at line 23 of file class.ilObjStyleSettingsGUI.php.

Referenced by getTabs().

◆ $tabs

ilObjStyleSettingsGUI::$tabs
protected

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

Referenced by getTabs().

◆ $tpl

ilObjStyleSettingsGUI::$tpl

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


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