ilObjStyleSheetGUI Class Reference

Class ilObjStyleSheetGUI. More...

Inheritance diagram for ilObjStyleSheetGUI:

Collaboration diagram for ilObjStyleSheetGUI:

Public Member Functions
	__construct ( $a_data, int $a_id, bool $a_call_by_reference)
	enableWrite (bool $a_write)
	Enable writing. More...
	executeCommand ()
	viewObject ()
	createObject ()
	includeCSS ()
	editObject ()
	Edit -> List characteristics. More...
	propertiesObject ()
	getPropertiesValues ()
	Get current values for properties from. More...
	initPropertiesForm (string $a_mode="edit")
	FORM: Init properties form. More...
	updateObject ()
	exportStyleObject ()
	deleteObject ($a_error=false)
	display deletion confirmation screen More...
	cancelDeleteObject ()
	confirmedDeleteObject ()
	delete selected style objects More...
	saveObject ()
	copyStyleObject ()
	importStyleObject ()
	Import style sheet. More...
	cancelObject ()
	getAdminTabs ()
	setTemplatesSubTabs ()
	listColorsObject ()
	List colors of style. More...
	addColorObject ()
	editColorObject ()
	initColorForm (string $a_mode="create")
	getColorFormValues ()
	Set values for color editing. More...
	cancelColorSavingObject ()
	Cancel color saving. More...
	saveColorObject ()
	Save color. More...
	updateColorObject ()
	Update color. More...
	deleteColorConfirmationObject ()
	Delete color confirmation. More...
	cancelColorDeletionObject ()
	Cancel color deletion. More...
	deleteColorObject ()
	listMediaQueriesObject ()
	addMediaQueryObject ()
	editMediaQueryObject ()
	initMediaQueryForm (string $a_mode="create")
	Init media query form. More...
	getMediaQueryFormValues ()
	Set values for media query editing. More...
	saveMediaQueryObject ()
	Save media query. More...
	updateMediaQueryObject ()
	deleteMediaQueryConfirmationObject ()
	deleteMediaQueriesObject ()
	saveMediaQueryOrderObject ()
	listTemplatesObject ()
	List templates. More...
	addTemplateObject ()
	editTemplateObject ()
	getTemplatePreview (string $a_type, int $a_t_id, bool $a_small_mode=false)
	initTemplateForm (string $a_mode="create")
	Init table template form. More...
	cancelTemplateSavingObject ()
	Cancel color saving. More...
	saveTemplateObject ()
	Save table template. More...
	updateTemplateObject (bool $a_refresh=false)
	displayTemplateEditForm ()
	refreshTemplateObject ()
	Refresh table template. More...
	getTemplateFormValues ()
	Set values for table template editing. More...
	deleteTemplateConfirmationObject ()
	Delete table template confirmation. More...
	cancelTemplateDeletionObject ()
	Cancel table template deletion. More...
	deleteTemplateKeepClassesObject ()
	deleteTemplateObject ()
	Delete template. More...
	generateTemplateObject ()
	initTemplateGenerationForm ()
	Init table template generation form. More...
	templateGenerationObject ()
	Table template generation. More...
	returnToUpperContextObject ()
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	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...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	getStyleExampleHTML (string $a_type, string $a_class)
	Get style example HTML. More...
static	_getTemplatePreview (ilObjStyleSheet $a_style, string $a_type, int $a_t_id, bool $a_small_mode=false)
	Get table template preview. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
string	$cmd_update
string	$cmd_new_par
string	$cmd_delete
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	getCreateForm ()
	getImportForm ()
	getCloneForm ()
	getTabs ()
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	addAdoptContentLinkToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

Protected Attributes
ilPropertyFormGUI	$form_gui
ilPropertyFormGUI	$form
Content StandardGUIRequest	$style_request
Content InternalService	$service
ilHelpGUI	$help
ilObjectDefinition	$obj_definition
bool	$enable_write = false
string	$super_type
Access StyleAccessManager	$access_manager
Content CharacteristicManager	$characteristic_manager
Content ColorManager	$color_manager
Content ImageManager	$image_manager
Content InternalGUIService	$gui_service
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Detailed Description

Class ilObjStyleSheetGUI.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilObjStyleSheetGUI: ilExportGUI, ilStyleCharacteristicGUI, ilContentStyleImageGUI

Definition at line 30 of file class.ilObjStyleSheetGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjStyleSheetGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference
	)

Definition at line 50 of file class.ilObjStyleSheetGUI.php.

References $DIC, ilObjectGUI\$ref_id, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilObjStyleSheet\_getStyleSuperTypeForType(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

      {
        global $DIC;

        parent::__construct($a_data, $a_id, $a_call_by_reference, false);

        $this->service = $DIC->contentStyle()
            ->internal();
        $this->gui_service = $this->service->gui();
        $this->help = $this->gui_service->help();
        $this->lng->loadLanguageModule("style");
        $this->ctrl->saveParameter($this, array("tag", "style_type", "temp_type"));
        $this->style_request = $DIC->contentStyle()
            ->internal()
            ->gui()
            ->standardRequest();

        $this->super_type = "";
        if ($this->style_request->getStyleType() != "") {
            $this->super_type = ilObjStyleSheet::_getStyleSuperTypeForType(
                $this->style_request->getStyleType()
            );
        }
        $this->type = "sty";

        $ref_id = (is_object($this->object))
            ? $this->object->getRefId()
            : 0;
        $style_id = (is_object($this->object))
            ? $this->object->getId()
            : 0;

        $this->access_manager = $this->service->domain()->access(
            $ref_id,
            $this->user->getId()
        );
        $this->characteristic_manager = $this->service->domain()->characteristic(
            $style_id,
            $this->access_manager
        );
        $this->color_manager = $this->service->domain()->color(
            $style_id,
            $this->access_manager
        );
        $this->image_manager = $this->service->domain()->image(
            $style_id,
            $this->access_manager
        );
    }

Here is the call graph for this function:

Member Function Documentation

_getTemplatePreview()

static ilObjStyleSheetGUI::_getTemplatePreview ( ilObjStyleSheet  $a_style, string  $a_type, int  $a_t_id, bool  $a_small_mode = false  )

static

Get table template preview.

Definition at line 1199 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, $DIC, ilObjectGUI\$lng, ilPCTableGUI\_renderTable(), ilAccordionGUI\addCss(), ilObjStyleSheet\getTemplate(), ilObjStyleSheet\getTemplateXML(), ilObjStyleSheet\lookupTemplateName(), and ilLanguage\txt().

Referenced by ilObjStyleSheet\addTemplate(), and getTemplatePreview().

     : string {
        global $DIC;

        $lng = $DIC->language();
        $p_content = "";

        $kr = $kc = 7;
        if ($a_small_mode) {
            $kr = 6;
            $kc = 5;
        }

        $ts = $a_style->getTemplate($a_t_id);
        $t = $ts["classes"];

        // preview
        if ($a_type == "table") {
            $p_content = '<PageContent><Table DataTable="y"';
            $t["row_head"] = $t["row_head"] ?? "";
            $t["row_foot"] = $t["row_foot"] ?? "";
            $t["col_head"] = $t["col_head"] ?? "";
            $t["col_foot"] = $t["col_foot"] ?? "";
            if ($t["row_head"] != "") {
                $p_content .= ' HeaderRows="1"';
            }
            if ($t["row_foot"] != "") {
                $p_content .= ' FooterRows="1"';
            }
            if ($t["col_head"] != "") {
                $p_content .= ' HeaderCols="1"';
            }
            if ($t["col_foot"] != "") {
                $p_content .= ' FooterCols="1"';
            }
            $p_content .= ' Template="' . $a_style->lookupTemplateName($a_t_id) . '">';
            if (!$a_small_mode) {
                $p_content .= '<Caption>' . $lng->txt("sty_caption") . '</Caption>';
            }
            for ($i = 1; $i <= $kr; $i++) {
                $p_content .= '<TableRow>';
                for ($j = 1; $j <= $kc; $j++) {
                    if ($a_small_mode) {
                        $cell = '&lt;div style="height:2px;"&gt;&lt;/div&gt;';
                    } else {
                        $cell = 'xxx';
                    }
                    $p_content .= '<TableData><PageContent><Paragraph Characteristic="TableContent">' . $cell . '</Paragraph></PageContent></TableData>';
                }
                $p_content .= '</TableRow>';
            }
            $p_content .= '</Table></PageContent>';
        }

        if ($a_type == "vaccordion" || $a_type == "haccordion" || $a_type == "carousel") {
            ilAccordionGUI::addCss();

            if ($a_small_mode) {
                $c = '&amp;nbsp;';
                $h = '&amp;nbsp;';
            } else {
                $c = 'xxx';
                $h = 'head';
            }
            if ($a_type == "vaccordion") {
                $p_content = '<PageContent><Tabs HorizontalAlign="Left" Type="VerticalAccordion" ';
                if ($a_small_mode) {
                    $p_content .= ' ContentWidth="70"';
                }
            } elseif ($a_type == "haccordion") {
                $p_content = '<PageContent><Tabs Type="HorizontalAccordion"';
                $p_content .= ' ContentHeight="40"';
                if ($a_small_mode) {
                    $p_content .= ' ContentWidth="70"';
                    $c = '&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;';
                }
            } elseif ($a_type == "carousel") {
                $p_content = '<PageContent><Tabs HorizontalAlign="Left" Type="Carousel" ';
                if ($a_small_mode) {
                    $p_content .= ' ContentWidth="70"';
                }
            }


            $p_content .= ' Template="' . $a_style->lookupTemplateName($a_t_id) . '">';
            $p_content .= '<Tab><PageContent><Paragraph>' . $c . '</Paragraph></PageContent>';
            $p_content .= '<TabCaption>' . $h . '</TabCaption>';
            $p_content .= '</Tab>';
            $p_content .= '</Tabs></PageContent>';
        }
        //echo htmlentities($p_content);
        $txml = $a_style->getTemplateXML();
        //echo htmlentities($txml); exit;
        $p_content .= $txml;
        $r_content = ilPCTableGUI::_renderTable($p_content, "");

        // fix carousel template visibility
        if ($a_type == "carousel") {
            $r_content .= "<style>.owl-carousel{ display:block !important; }</style>";
        }

        //echo htmlentities($r_content); exit;
        return $r_content;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAdminLocatorItems()

ilObjStyleSheetGUI::addAdminLocatorItems ( bool  $do_not_add_object = false )

protected

should be overwritten to add object specific items (repository items are preloaded)

Definition at line 654 of file class.ilObjStyleSheetGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

                                                                            : void
    {
        $ilLocator = $this->gui_service->locator();

        if ($this->style_request->getAdminMode() == "settings") {       // system settings
            parent::addAdminLocatorItems(true);

            $ilLocator->addItem(
                $this->lng->txt("obj_stys"),
                $this->ctrl->getLinkTargetByClass("ilobjstylesettingsgui", "")
            );

            $ilLocator->addItem(
                $this->lng->txt("content_styles"),
                $this->ctrl->getLinkTargetByClass("ilcontentstylesettingsgui", "")
            );

            if ($this->style_request->getObjId() > 0) {
                $ilLocator->addItem(
                    $this->object->getTitle(),
                    $this->ctrl->getLinkTarget($this, "edit")
                );
            }
        }
    }

Here is the call graph for this function:

addColorObject()

ilObjStyleSheetGUI::addColorObject

(

)

Definition at line 747 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, initColorForm(), and ilGlobalTemplateInterface\setContent().

                                    : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $this->initColorForm();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

addMediaQueryObject()

ilObjStyleSheetGUI::addMediaQueryObject

(

)

Definition at line 956 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, initMediaQueryForm(), and ilGlobalTemplateInterface\setContent().

                                         : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $this->initMediaQueryForm();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

addTemplateObject()

ilObjStyleSheetGUI::addTemplateObject

(

)

Definition at line 1160 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, initTemplateForm(), and ilGlobalTemplateInterface\setContent().

                                       : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $this->initTemplateForm();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

cancelColorDeletionObject()

ilObjStyleSheetGUI::cancelColorDeletionObject

(

)

Cancel color deletion.

Definition at line 912 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                               : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirect($this, "listColors");
    }

Here is the call graph for this function:

cancelColorSavingObject()

ilObjStyleSheetGUI::cancelColorSavingObject

(

)

Cancel color saving.

Definition at line 817 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                             : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirect($this, "listColors");
    }

Here is the call graph for this function:

cancelDeleteObject()

ilObjStyleSheetGUI::cancelDeleteObject

(

)

Definition at line 394 of file class.ilObjStyleSheetGUI.php.

                                        : void
    {
        $this->gui_service->ctrl()->returnToParent($this);
    }

cancelObject()

ilObjStyleSheetGUI::cancelObject

(

)

Definition at line 547 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$lng, ILIAS\Repository\ctrl(), and ilLanguage\txt().

                                  : void
    {
        $lng = $this->lng;

        $this->tpl->setOnScreenMessage('info', $lng->txt("msg_cancel"), true);
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

cancelTemplateDeletionObject()

ilObjStyleSheetGUI::cancelTemplateDeletionObject

(

)

Cancel table template deletion.

Definition at line 1541 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                                  : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirect($this, "listTemplates");
    }

Here is the call graph for this function:

cancelTemplateSavingObject()

ilObjStyleSheetGUI::cancelTemplateSavingObject

(

)

Cancel color saving.

Definition at line 1362 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                                : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirect($this, "listTemplates");
    }

Here is the call graph for this function:

confirmedDeleteObject()

ilObjStyleSheetGUI::confirmedDeleteObject

(

)

delete selected style objects

Definition at line 402 of file class.ilObjStyleSheetGUI.php.

                                           : void
    {
        $this->object->delete();
        $this->gui_service->ctrl()->returnToParent($this);
    }

copyStyleObject()

ilObjStyleSheetGUI::copyStyleObject

(

)

Definition at line 464 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjStyleSheet\_writeStandard(), ilPropertyFormGUI\checkInput(), getCloneForm(), ilPropertyFormGUI\getInput(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), and ilCtrl\returnToParent().

                                     : int
    {
        $ctrl = $this->gui_service->ctrl();

        $form = $this->getCloneForm();
        $form->checkInput();
        $new_id = 0;

        if ($form->getInput("source_style") > 0) {
            $style_obj = ilObjectFactory::getInstanceByObjId((int) $form->getInput("source_style"));
            $new_id = $style_obj->ilClone();
        }

        // assign style to style sheet folder,
        // if parent is style sheet folder
        if ($this->requested_ref_id > 0) {
            $fold = ilObjectFactory::getInstanceByRefId($this->requested_ref_id);
            if ($fold->getType() == "stys") {
                $cont_style_settings = new ilContentStyleSettings();
                $cont_style_settings->addStyle($new_id);
                $cont_style_settings->update();
                ilObjStyleSheet::_writeStandard($new_id, true);
                $ctrl->returnToParent($this);
            }
        }
        $this->object = new ilObjStyleSheet($new_id);

        return $new_id;
    }

Here is the call graph for this function:

createObject()

ilObjStyleSheetGUI::createObject

(

)

Definition at line 177 of file class.ilObjStyleSheetGUI.php.

References $help, ilObjectGUI\$tpl, getCloneForm(), getCreateForm(), ilObjectGUI\getCreationFormsHTML(), getImportForm(), ilHelpGUI\ID_PART_SCREEN, and ilGlobalTemplateInterface\setContent().

                                  : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $ilHelp = $this->help;

        $forms = array();


        $ilHelp->setScreenIdComponent("sty");
        $ilHelp->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, "create");

        $forms[] = $this->getCreateForm();
        $forms[] = $this->getImportForm();
        $forms[] = $this->getCloneForm();

        $tpl->setContent($this->getCreationFormsHTML($forms));
    }

Here is the call graph for this function:

deleteColorConfirmationObject()

ilObjStyleSheetGUI::deleteColorConfirmationObject

(

)

Delete color confirmation.

Definition at line 884 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilLegacyFormElementsUtil\prepareFormOutput(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                                   : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->gui_service->ui()->mainTemplate();
        $lng = $this->lng;

        $colors = $this->style_request->getColors();
        if (count($colors) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listColors");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("sty_confirm_color_deletion"));
            $cgui->setCancel($lng->txt("cancel"), "cancelColorDeletion");
            $cgui->setConfirm($lng->txt("delete"), "deleteColor");

            foreach ($colors as $c) {
                $cgui->addItem("color[]", ilLegacyFormElementsUtil::prepareFormOutput($c), $c);
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

deleteColorObject()

ilObjStyleSheetGUI::deleteColorObject

(

)

Definition at line 918 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                       : void
    {
        $ilCtrl = $this->ctrl;

        $colors = $this->style_request->getColors();
        foreach ($colors as $c) {
            $this->object->removeColor($c);
        }

        $ilCtrl->redirect($this, "listColors");
    }

Here is the call graph for this function:

deleteMediaQueriesObject()

ilObjStyleSheetGUI::deleteMediaQueriesObject

(

)

Definition at line 1085 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$id, and ilCtrl\redirect().

                                              : void
    {
        $ilCtrl = $this->ctrl;

        $mq_ids = $this->style_request->getMediaQueryIds();
        if ($this->access_manager->checkWrite()) {
            foreach ($mq_ids as $id) {
                $this->object->deleteMediaQuery($id);
            }
        }
        $ilCtrl->redirect($this, "listMediaQueries");
    }

Here is the call graph for this function:

deleteMediaQueryConfirmationObject()

ilObjStyleSheetGUI::deleteMediaQueryConfirmationObject

(

)

Definition at line 1059 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                                        : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->gui_service->ui()->mainTemplate();
        $lng = $this->lng;

        $mq_ids = $this->style_request->getMediaQueryIds();
        if (count($mq_ids) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listMediaQueries");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("sty_sure_del_mqueries"));
            $cgui->setCancel($lng->txt("cancel"), "listMediaQueries");
            $cgui->setConfirm($lng->txt("delete"), "deleteMediaQueries");

            foreach ($mq_ids as $i) {
                $mq = $this->object->getMediaQueryForId($i);
                $cgui->addItem("mq_id[]", (string) $i, $mq["mquery"]);
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

deleteObject()

ilObjStyleSheetGUI::deleteObject

(

$a_error = false

)

display deletion confirmation screen

Definition at line 375 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, ilObject\_lookupTitle(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilGlobalTemplateInterface\setContent().

                                                  : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ctrl = $this->gui_service->ctrl();

        // display confirmation message
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ctrl->getFormAction($this));
        $cgui->setHeaderText($this->lng->txt("info_delete_sure"));
        $cgui->setCancel($this->lng->txt("cancel"), "cancelDelete");
        $cgui->setConfirm($this->lng->txt("confirm"), "confirmedDelete");

        $caption = ilObject::_lookupTitle($this->object->getId());

        $cgui->addItem("id[]", "", $caption);

        $tpl->setContent($cgui->getHTML());
    }

Here is the call graph for this function:

deleteTemplateConfirmationObject()

ilObjStyleSheetGUI::deleteTemplateConfirmationObject

(

)

Delete table template confirmation.

Definition at line 1497 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ILIAS\Repository\object(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                                      : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->gui_service->ui()->mainTemplate();
        $lng = $this->lng;

        $tids = $this->style_request->getTemplateIds();
        if (count($tids) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listTemplates");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("sty_confirm_template_deletion"));
            $cgui->setCancel($lng->txt("cancel"), "cancelTemplateDeletion");
            $cgui->setConfirm($lng->txt("sty_del_template"), "deleteTemplate");

            foreach ($tids as $tid) {
                $classes = $this->object->getTemplateClasses($tid);
                $cl_str = "";
                $listed = array();
                foreach ($classes as $cl) {
                    if ($cl != "" && !($listed[$cl] ?? false)) {
                        $cl_str .= '<div>- ' .
                            $cl . "</div>";
                        $listed[$cl] = true;
                    }
                }
                if ($cl_str != "") {
                    $cl_str = '<div style="padding-left:30px;" class="small">' .
                        "<div><i>" . $lng->txt("sty_style_class") . "</i></div>" . $cl_str . "</div>";
                }
                $cgui->addItem("tid[]", (string) $tid, $this->object->lookupTemplateName($tid) . $cl_str);
            }

            $cgui->addButton($lng->txt("sty_del_template_keep_classes"), "deleteTemplateKeepClasses");

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

deleteTemplateKeepClassesObject()

ilObjStyleSheetGUI::deleteTemplateKeepClassesObject

(

)

Definition at line 1548 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                                     : void
    {
        $ilCtrl = $this->ctrl;

        $tids = $this->style_request->getTemplateIds();
        foreach ($tids as $tid) {
            $this->object->removeTemplate($tid);
        }

        $ilCtrl->redirect($this, "listTemplates");
    }

Here is the call graph for this function:

deleteTemplateObject()

ilObjStyleSheetGUI::deleteTemplateObject

(

)

Delete template.

Exceptions

Content

Definition at line 1566 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                          : void
    {
        $ilCtrl = $this->ctrl;

        $tids = $this->style_request->getTemplateIds();
        foreach ($tids as $tid) {
            $cls = $this->object->getTemplateClasses($tid);
            foreach ($cls as $k => $cls2) {
                $ty = $this->object->determineTemplateStyleClassType(
                    $this->style_request->getTempType(),
                    $k
                );
                $this->characteristic_manager->deleteCharacteristic($ty, $cls2);
            }
            $this->object->removeTemplate($tid);
        }

        $ilCtrl->redirect($this, "listTemplates");
    }

Here is the call graph for this function:

displayTemplateEditForm()

ilObjStyleSheetGUI::displayTemplateEditForm

(

)

Definition at line 1447 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, getTemplatePreview(), includeCSS(), and ilGlobalTemplateInterface\setContent().

Referenced by editTemplateObject(), and updateTemplateObject().

                                             : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $a_tpl = new ilTemplate(
            "tpl.template_edit.html",
            true,
            true,
            "Services/Style/Content"
        );
        $this->includeCSS();
        $a_tpl->setVariable("FORM", $this->form_gui->getHTML());
        $a_tpl->setVariable("PREVIEW", $this->getTemplatePreview(
            $this->style_request->getTempType(),
            $this->style_request->getTemplateId()
        ));
        $tpl->setContent($a_tpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editColorObject()

ilObjStyleSheetGUI::editColorObject

(

)

Definition at line 755 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, getColorFormValues(), initColorForm(), ilGlobalTemplateInterface\setContent(), and ilCtrl\setParameter().

                                     : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, "c_name", $this->style_request->getColorName());
        $this->initColorForm("edit");
        $this->getColorFormValues();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

editMediaQueryObject()

ilObjStyleSheetGUI::editMediaQueryObject

(

)

Definition at line 964 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, getMediaQueryFormValues(), initMediaQueryForm(), ilGlobalTemplateInterface\setContent(), and ilCtrl\setParameter().

                                          : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, "mq_id", $this->style_request->getMediaQueryId());
        $this->initMediaQueryForm("edit");
        $this->getMediaQueryFormValues();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

editObject()

ilObjStyleSheetGUI::editObject

(

)

Edit -> List characteristics.

Definition at line 266 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirectByClass().

Referenced by viewObject().

                                : void
    {
        $ctrl = $this->gui_service->ctrl();
        $ctrl->redirectByClass("ilStyleCharacteristicGUI", "listCharacteristics");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editTemplateObject()

ilObjStyleSheetGUI::editTemplateObject

(

)

Definition at line 1168 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, displayTemplateEditForm(), getTemplateFormValues(), initTemplateForm(), and ilCtrl\setParameter().

                                        : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter(
            $this,
            "t_id",
            $this->style_request->getTemplateId()
        );
        $this->initTemplateForm("edit");
        $this->getTemplateFormValues();

        $this->displayTemplateEditForm();
    }

Here is the call graph for this function:

enableWrite()

ilObjStyleSheetGUI::enableWrite

(

bool

$a_write

)

Enable writing.

Definition at line 106 of file class.ilObjStyleSheetGUI.php.

                                              : void
    {
        $this->access_manager->enableWrite($a_write);
    }

executeCommand()

ilObjStyleSheetGUI::executeCommand

(

)

Definition at line 111 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$object, ilCtrl\forwardCommand(), ilCtrl\getCmd(), ilCtrl\getNextClass(), includeCSS(), ilObjectGUI\prepareOutput(), and ilObjectGUI\setCreationMode().

                                    : void
    {
        $tabs = $this->gui_service->tabs();
        $ctrl = $this->gui_service->ctrl();

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("edit");

        // #9440/#9489: prepareOutput will fail if not set properly
        if (!$this->object || $cmd == "create") {
            $this->setCreationMode();
        }

        switch ($next_class) {
            case "ilexportgui":
                $this->prepareOutput();
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $ctrl->forwardCommand($exp_gui);
                break;

            case "ilstylecharacteristicgui":
                $this->prepareOutput();
                $this->includeCSS();
                $tabs->activateTab("sty_style_chars");
                $gui = $this->gui_service->characteristic()->ilStyleCharacteristicGUI(
                    $this->getStyleSheet(),
                    $this->super_type,
                    $this->access_manager,
                    $this->characteristic_manager,
                    $this->image_manager
                );
                $ctrl->forwardCommand($gui);
                break;

            case "ilcontentstyleimagegui":
                $this->prepareOutput();
                $this->includeCSS();
                $tabs->activateTab("sty_images");
                $gui = $this->gui_service->image()->ilContentStyleImageGUI(
                    $this->access_manager,
                    $this->image_manager
                );
                $ctrl->forwardCommand($gui);
                break;

            default:
                $this->prepareOutput();
                $cmd .= "Object";
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

exportStyleObject()

ilObjStyleSheetGUI::exportStyleObject

(

)

Definition at line 364 of file class.ilObjStyleSheetGUI.php.

References $r, ilFileDelivery\deliverFileLegacy(), and ILIAS\Repository\object().

                                       : void
    {
        $exp = new ilExport();
        $r = $exp->exportObject($this->object->getType(), $this->object->getId());

        ilFileDelivery::deliverFileLegacy($r["directory"] . "/" . $r["file"], $r["file"], '', false, true);
    }

Here is the call graph for this function:

generateTemplateObject()

ilObjStyleSheetGUI::generateTemplateObject

(

)

Definition at line 1586 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, initTemplateGenerationForm(), and ilGlobalTemplateInterface\setContent().

                                            : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();

        $this->initTemplateGenerationForm();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

getAdminTabs()

ilObjStyleSheetGUI::getAdminTabs

(

)

Definition at line 555 of file class.ilObjStyleSheetGUI.php.

References getTabs().

                                  : void
    {
        $this->getTabs();
    }

Here is the call graph for this function:

getCloneForm()

ilObjStyleSheetGUI::getCloneForm ( )

protected

Definition at line 238 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, $form, ilObjStyleSheet\_getClonableContentStyles(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setRequired(), and ilPropertyFormGUI\setTitle().

Referenced by copyStyleObject(), and createObject().

                                     : ilPropertyFormGUI
    {
        $ctrl = $this->ctrl;
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_copy_other_stylesheet"));

        // source
        $ti = new ilSelectInputGUI($this->lng->txt("sty_source"), "source_style");
        $ti->setRequired(true);
        $ti->setOptions(ilObjStyleSheet::_getClonableContentStyles());
        $form->addItem($ti);

        $form->addCommandButton("copyStyle", $this->lng->txt("copy"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColorFormValues()

ilObjStyleSheetGUI::getColorFormValues

(

)

Set values for color editing.

Definition at line 804 of file class.ilObjStyleSheetGUI.php.

Referenced by editColorObject().

                                        : void
    {
        $c_name = $this->style_request->getColorName();
        if ($c_name != "") {
            $values["color_name"] = $c_name;
            $values["color_code"] = $this->object->getColorCodeForName($c_name);
            $this->form_gui->setValuesByArray($values);
        }
    }

Here is the caller graph for this function:

getCreateForm()

ilObjStyleSheetGUI::getCreateForm ( )

protected

Definition at line 196 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, $form, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), ilTextAreaInputGUI\setCols(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by createObject(), and saveObject().

                                      : ilPropertyFormGUI
    {
        $ctrl = $this->ctrl;
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_create_new_stylesheet"));

        // title
        $ti = new ilTextInputGUI($this->lng->txt("title"), "style_title");
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        // description
        $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "style_description");
        $ta->setCols(40);
        $ta->setRows(2);
        $form->addItem($ta);

        $form->addCommandButton("save", $this->lng->txt("save"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImportForm()

ilObjStyleSheetGUI::getImportForm ( )

protected

Definition at line 221 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, $form, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setRequired(), and ilPropertyFormGUI\setTitle().

Referenced by createObject().

                                      : ilPropertyFormGUI
    {
        $ctrl = $this->ctrl;
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_import_stylesheet"));

        // title
        $ti = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
        $ti->setRequired(true);
        $form->addItem($ti);

        $form->addCommandButton("importStyle", $this->lng->txt("import"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMediaQueryFormValues()

ilObjStyleSheetGUI::getMediaQueryFormValues

(

)

Set values for media query editing.

Definition at line 1008 of file class.ilObjStyleSheetGUI.php.

References ILIAS\Repository\object().

Referenced by editMediaQueryObject().

                                             : void
    {
        $values = [];
        if ($this->style_request->getMediaQueryId() > 0) {
            foreach ($this->object->getMediaQueries() as $mq) {
                if ($mq["id"] == $this->style_request->getMediaQueryId()) {
                    $values["mquery"] = $mq["mquery"];
                }
            }
            $this->form_gui->setValuesByArray($values);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPropertiesValues()

ilObjStyleSheetGUI::getPropertiesValues

(

)

Get current values for properties from.

Definition at line 285 of file class.ilObjStyleSheetGUI.php.

References ILIAS\Repository\form(), ILIAS\Repository\int(), and ILIAS\Repository\object().

Referenced by propertiesObject().

                                         : void
    {
        $values = array();

        $values["style_title"] = $this->object->getTitle();
        $values["style_description"] = $this->object->getDescription();
        $values["disable_auto_margins"] = (int) $this->object->lookupStyleSetting("disable_auto_margins");

        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStyleExampleHTML()

static ilObjStyleSheetGUI::getStyleExampleHTML ( string  $a_type, string  $a_class  )

static

Get style example HTML.

Definition at line 683 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, $DIC, ilObjectGUI\$lng, and ilLanguage\txt().

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\fillRow(), and ilStyleCharacteristicGUI\outputTagStyleEditScreen().

     : string {
        global $DIC;

        $lng = $DIC->language();

        $c = explode(":", $a_class);
        $a_class = $c[0];

        $ex_tpl = new ilTemplate("tpl.style_example.html", true, true, "Services/Style/Content");

        if ($ex_tpl->blockExists("Example_" . $a_type)) {
            $ex_tpl->setCurrentBlock("Example_" . $a_type);
        } else {
            $ex_tpl->setCurrentBlock("Example_default");
        }
        $ex_tpl->setVariable("EX_CLASS", "ilc_" . $a_type . "_" . $a_class);
        $ex_tpl->setVariable("EX_TEXT", "ABC abc 123");
        if (in_array($a_type, array("media_cont", "qimg"))) {
            //
        }
        if (in_array($a_type, array("table", "table_caption"))) {
            $ex_tpl->setVariable("TXT_CAPTION", $lng->txt("sty_caption"));
        }
        if (in_array($a_class, array("OrderListItemHorizontal", "OrderListHorizontal"))) {
            $ex_tpl->setVariable("HOR", "Horizontal");
        }
        $ex_tpl->parseCurrentBlock();

        return $ex_tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjStyleSheetGUI::getTabs ( )

protected

Definition at line 560 of file class.ilObjStyleSheetGUI.php.

References $help, ilObjectGUI\$lng, ILIAS\Repository\ctrl(), ilHelpGUI\setScreenIdComponent(), and ilLanguage\txt().

Referenced by getAdminTabs().

                                : void
    {
        $lng = $this->lng;
        $ilHelp = $this->help;
        $tabs = $this->gui_service->tabs();
        $ilHelp->setScreenIdComponent("sty");
        // back to upper context
        $tabs->setBackTarget(
            $lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "returnToUpperContext")
        );

        // style classes
        $tabs->addTarget(
            "sty_style_chars",
            $this->ctrl->getLinkTarget($this, "edit"),
            array("edit", ""),
            get_class($this)
        );

        // colors
        $tabs->addTarget(
            "sty_colors",
            $this->ctrl->getLinkTarget($this, "listColors"),
            "listColors",
            get_class($this)
        );

        // images
        $tabs->addTarget(
            "sty_images",
            $this->ctrl->getLinkTargetByClass("ilContentStyleImageGUI", ""),
            "",
            "ilContentStyleImageGUI"
        );

        // media queries
        $tabs->addTarget(
            "sty_media_queries",
            $this->ctrl->getLinkTarget($this, "listMediaQueries"),
            "listMediaQueries",
            get_class($this)
        );


        // table templates
        $tabs->addTarget(
            "sty_templates",
            $this->ctrl->getLinkTarget($this, "listTemplates"),
            "listTemplates",
            get_class($this)
        );

        // settings
        $tabs->addTarget(
            "settings",
            $this->ctrl->getLinkTarget($this, "properties"),
            "properties",
            get_class($this)
        );

        // export
        $tabs->addTarget(
            "export",
            $this->ctrl->getLinkTargetByClass("ilexportgui", ""),
            "",
            "ilexportgui"
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateFormValues()

ilObjStyleSheetGUI::getTemplateFormValues

(

)

Set values for table template editing.

Definition at line 1477 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$type, and ilObjStyleSheet\_getTemplateClassTypes().

Referenced by editTemplateObject().

                                           : void
    {
        $t_id = $this->style_request->getTemplateId();
        if ($t_id > 0) {
            $t = $this->object->getTemplate($t_id);

            $values["name"] = $t["name"];
            $scs = ilObjStyleSheet::_getTemplateClassTypes(
                $this->style_request->getTempType()
            );
            foreach ($scs as $k => $type) {
                $values[$k . "_class"] = $t["classes"][$k] ?? "";
            }
            $this->form_gui->setValuesByArray($values);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplatePreview()

ilObjStyleSheetGUI::getTemplatePreview	(	string	$a_type,
		int	$a_t_id,
		bool	$a_small_mode = false
	)

Definition at line 1183 of file class.ilObjStyleSheetGUI.php.

References _getTemplatePreview().

Referenced by displayTemplateEditForm(), saveTemplateObject(), templateGenerationObject(), and updateTemplateObject().

     : string {
        return $this->_getTemplatePreview(
            $this->getStyleSheet(),
            $a_type,
            $a_t_id,
            $a_small_mode
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importStyleObject()

ilObjStyleSheetGUI::importStyleObject

(

)

Import style sheet.

Definition at line 497 of file class.ilObjStyleSheetGUI.php.

References ilObjStyleSheet\_writeStandard(), ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByObjId(), and ilObjectFactory\getInstanceByRefId().

                                       : int
    {
        $newObj = null;
        // check file
        $source = $_FILES["importfile"]["tmp_name"];
        if (($source == 'none') || (!$source)) {
            $this->ilias->raiseError("No file selected!", $this->ilias->error_obj->MESSAGE);
        }

        // check correct file type
        $info = pathinfo($_FILES["importfile"]["name"]);
        if (strtolower($info["extension"]) != "zip" && strtolower($info["extension"]) != "xml") {
            $this->ilias->raiseError("File must be a zip or xml file!", $this->ilias->error_obj->MESSAGE);
        }

        // new import
        $fname = explode("_", $_FILES["importfile"]["name"]);
        if (strtolower($info["extension"]) == "zip" && $fname[4] == "sty") {
            $imp = new ilImport();
            $new_id = $imp->importObject(
                null,
                $_FILES["importfile"]["tmp_name"],
                $_FILES["importfile"]["name"],
                "sty"
            );
            if ($new_id > 0) {
                $newObj = ilObjectFactory::getInstanceByObjId($new_id);
            }
        } else {        // old import
            $newObj = new ilObjStyleSheet();
            $newObj->import($_FILES["importfile"]);
        }

        // assign style to style sheet folder,
        // if parent is style sheet folder
        if ($this->requested_ref_id > 0) {
            $fold = ilObjectFactory::getInstanceByRefId($this->requested_ref_id);
            if ($fold->getType() == "stys") {
                $cont_style_settings = new ilContentStyleSettings();
                $cont_style_settings->addStyle($newObj->getId());
                $cont_style_settings->update();
                ilObjStyleSheet::_writeStandard($newObj->getId(), true);
                $this->ctrl->returnToParent($this);
            }
        }
        $this->object = $newObj;
        return $newObj->getId();
    }

Here is the call graph for this function:

includeCSS()

ilObjStyleSheetGUI::includeCSS

(

)

Definition at line 256 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, ilGlobalTemplateInterface\addCss(), ilObjStyleSheet\getContentStylePath(), and ILIAS\Repository\object().

Referenced by displayTemplateEditForm(), executeCommand(), and listTemplatesObject().

                                : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $tpl->addCss(ilObjStyleSheet::getContentStylePath($this->object->getId()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initColorForm()

ilObjStyleSheetGUI::initColorForm

(

string

$a_mode = "create"

)

Definition at line 767 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilRegExpInputGUI\setPattern(), ilFormPropertyGUI\setRequired(), and ilLanguage\txt().

Referenced by addColorObject(), editColorObject(), saveColorObject(), and updateColorObject().

     : void {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->form_gui = new ilPropertyFormGUI();

        $this->form_gui->setTitle($lng->txt("sty_add_color"));

        // name
        $name_input = new ilRegExpInputGUI($lng->txt("sty_color_name"), "color_name");
        $name_input->setPattern("/^[a-zA-Z]+[a-zA-Z0-9]*$/");
        $name_input->setNoMatchMessage($lng->txt("sty_msg_color_must_only_include") . " A-Z, a-z, 1-9");
        $name_input->setRequired(true);
        $name_input->setSize(15);
        $name_input->setMaxLength(15);
        $this->form_gui->addItem($name_input);

        // code
        $color_input = new ilColorPickerInputGUI($lng->txt("sty_color_code"), "color_code");
        $color_input->setRequired(true);
        $color_input->setDefaultColor("");
        $this->form_gui->addItem($color_input);

        if ($a_mode == "create") {
            $this->form_gui->addCommandButton("saveColor", $lng->txt("save"));
        } else {
            $this->form_gui->addCommandButton("updateColor", $lng->txt("save"));
        }
        $this->form_gui->addCommandButton("cancelColorSaving", $lng->txt("cancel"));
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initMediaQueryForm()

ilObjStyleSheetGUI::initMediaQueryForm

(

string

$a_mode = "create"

)

Init media query form.

Definition at line 979 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, and ilLanguage\txt().

Referenced by addMediaQueryObject(), editMediaQueryObject(), saveMediaQueryObject(), and updateMediaQueryObject().

     : void {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->form_gui = new ilPropertyFormGUI();

        $this->form_gui->setTitle($lng->txt("sty_add_media_query"));

        // media query
        $ti = new ilTextInputGUI("@media", "mquery");
        $ti->setMaxLength(2000);
        $ti->setInfo($lng->txt("sty_add_media_query_info"));
        $this->form_gui->addItem($ti);


        if ($a_mode == "create") {
            $this->form_gui->addCommandButton("saveMediaQuery", $lng->txt("save"));
        } else {
            $this->form_gui->addCommandButton("updateMediaQuery", $lng->txt("save"));
        }
        $this->form_gui->addCommandButton("listMediaQueries", $lng->txt("cancel"));
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPropertiesForm()

ilObjStyleSheetGUI::initPropertiesForm

(

string

$a_mode = "edit"

)

FORM: Init properties form.

Definition at line 299 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ILIAS\Repository\form(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by propertiesObject(), and updateObject().

     : void {
        $ctrl = $this->gui_service->ctrl();
        $lng = $this->lng;

        $this->form = new ilPropertyFormGUI();

        // title
        $ti = new ilTextInputGUI($this->lng->txt("title"), "style_title");
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $this->form->addItem($ti);

        // description
        $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "style_description");
        //$ta->setCols();
        //$ta->setRows();
        $this->form->addItem($ta);

        // disable automatic margins for left/right alignment
        $cb = new ilCheckboxInputGUI($this->lng->txt("sty_disable_auto_margins"), "disable_auto_margins");
        $cb->setInfo($this->lng->txt("sty_disable_auto_margins_info"));
        $this->form->addItem($cb);

        // save and cancel commands

        if ($a_mode == "create") {
            $this->form->addCommandButton("save", $lng->txt("save"));
            $this->form->addCommandButton("cancelSave", $lng->txt("cancel"));
        } else {
            if ($this->access_manager->checkWrite()) {
                $this->form->addCommandButton("update", $lng->txt("save"));
            }
        }

        $this->form->setTitle($lng->txt("edit_stylesheet"));
        $this->form->setFormAction($ctrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTemplateForm()

ilObjStyleSheetGUI::initTemplateForm

(

string

$a_mode = "create"

)

Init table template form.

Definition at line 1311 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjStyleSheet\_getTemplateClassTypes(), ilRegExpInputGUI\setPattern(), and ilLanguage\txt().

Referenced by addTemplateObject(), editTemplateObject(), saveTemplateObject(), and updateTemplateObject().

                                                               : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->form_gui = new ilPropertyFormGUI();

        if ($a_mode == "create") {
            $this->form_gui->setTitle($lng->txt("sty_add_template"));
        } else {
            $this->form_gui->setTitle($lng->txt("sty_edit_template"));
        }

        // name
        $name_input = new ilRegExpInputGUI($lng->txt("sty_template_name"), "name");
        $name_input->setPattern("/^[a-zA-Z]+[a-zA-Z0-9]*$/");
        $name_input->setNoMatchMessage($lng->txt("sty_msg_color_must_only_include") . " A-Z, a-z, 1-9");
        $name_input->setRequired(true);
        $name_input->setSize(30);
        $name_input->setMaxLength(30);
        $this->form_gui->addItem($name_input);

        // template style classes
        $scs = ilObjStyleSheet::_getTemplateClassTypes(
            $this->style_request->getTempType()
        );

        foreach ($scs as $sc => $st) {
            $sc_input = new ilSelectInputGUI($lng->txt("sty_" . $sc . "_class"), $sc . "_class");
            $chars = $this->object->getCharacteristics($st);
            $options = array("" => "");
            foreach ($chars as $char) {
                $options[$char] = $char;
            }
            $sc_input->setOptions($options);
            $this->form_gui->addItem($sc_input);
        }

        if ($a_mode == "create") {
            $this->form_gui->addCommandButton("saveTemplate", $lng->txt("save"));
        } else {
            $this->form_gui->addCommandButton("refreshTemplate", $lng->txt("save_refresh"));
            $this->form_gui->addCommandButton("updateTemplate", $lng->txt("save_return"));
        }
        $this->form_gui->addCommandButton("cancelTemplateSaving", $lng->txt("cancel"));
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTemplateGenerationForm()

ilObjStyleSheetGUI::initTemplateGenerationForm

(

)

Init table template generation form.

Definition at line 1597 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilNumericStyleValueInputGUI\setAllowPercentage(), ilSelectInputGUI\setOptions(), ilRegExpInputGUI\setPattern(), and ilLanguage\txt().

Referenced by generateTemplateObject(), and templateGenerationObject().

                                                : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->form_gui = new ilPropertyFormGUI();

        $this->form_gui->setTitle($lng->txt("sty_generate_template"));

        // name
        $name_input = new ilRegExpInputGUI($lng->txt("sty_template_name"), "name");
        $name_input->setPattern("/^[a-zA-Z]+[a-zA-Z0-9]*$/");
        $name_input->setNoMatchMessage($lng->txt("sty_msg_color_must_only_include") . " A-Z, a-z, 1-9");
        $name_input->setRequired(true);
        $name_input->setSize(30);
        $name_input->setMaxLength(30);
        $this->form_gui->addItem($name_input);

        // basic layout
        $bl_input = new ilSelectInputGUI($lng->txt("sty_template_layout"), "layout");
        $options = array(
            "coloredZebra" => $lng->txt("sty_table_template_colored_zebra"),
            "bwZebra" => $lng->txt("sty_table_template_bw_zebra"),
            "noZebra" => $lng->txt("sty_table_template_no_zebra")
            );
        $bl_input->setOptions($options);
        $this->form_gui->addItem($bl_input);

        // top bottom padding
        $num_input = new ilNumericStyleValueInputGUI($lng->txt("sty_top_bottom_padding"), "tb_padding");
        $num_input->setAllowPercentage(false);
        $num_input->setValue("3px");
        $this->form_gui->addItem($num_input);

        // left right padding
        $num_input = new ilNumericStyleValueInputGUI($lng->txt("sty_left_right_padding"), "lr_padding");
        $num_input->setAllowPercentage(false);
        $num_input->setValue("10px");
        $this->form_gui->addItem($num_input);

        // base color
        $bc_input = new ilSelectInputGUI($lng->txt("sty_base_color"), "base_color");
        $cs = $this->object->getColors();
        $options = array();
        foreach ($cs as $c) {
            $options[$c["name"]] = $c["name"];
        }
        $bc_input->setOptions($options);
        $this->form_gui->addItem($bc_input);

        // Lightness Settings
        $lss = array("border" => 90, "header_text" => 70, "header_bg" => 0,
            "cell1_text" => -60, "cell1_bg" => 90, "cell2_text" => -60, "cell2_bg" => 75);
        foreach ($lss as $ls => $v) {
            $l_input = new ilNumberInputGUI($lng->txt("sty_lightness_" . $ls), "lightness_" . $ls);
            $l_input->setMaxValue(100);
            $l_input->setMinValue(-100);
            $l_input->setValue((string) $v);
            $l_input->setSize(4);
            $l_input->setMaxLength(4);
            $this->form_gui->addItem($l_input);
        }

        $this->form_gui->addCommandButton("templateGeneration", $lng->txt("generate"));
        $this->form_gui->addCommandButton("cancelTemplateSaving", $lng->txt("cancel"));
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listColorsObject()

ilObjStyleSheetGUI::listColorsObject

(

)

List colors of style.

Definition at line 725 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                      : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilToolbar = $this->gui_service->toolbar();
        $ilCtrl = $this->ctrl;

        if ($this->access_manager->checkWrite()) {
            $ilToolbar->addButton(
                $this->lng->txt("sty_add_color"),
                $ilCtrl->getLinkTarget($this, "addColor")
            );
        }

        $table_gui = new ilStyleColorTableGUI(
            $this,
            "listColors",
            $this->getStyleSheet(),
            $this->access_manager
        );
        $tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

listMediaQueriesObject()

ilObjStyleSheetGUI::listMediaQueriesObject

(

)

Definition at line 934 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                            : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilToolbar = $this->gui_service->toolbar();
        $ilCtrl = $this->ctrl;

        if ($this->access_manager->checkWrite()) {
            $ilToolbar->addButton(
                $this->lng->txt("sty_add_media_query"),
                $ilCtrl->getLinkTarget($this, "addMediaQuery")
            );
        }

        $table_gui = new ilStyleMediaQueryTableGUI(
            $this,
            "listMediaQueries",
            $this->getStyleSheet(),
            $this->access_manager
        );
        $tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

listTemplatesObject()

ilObjStyleSheetGUI::listTemplatesObject

(

)

List templates.

Definition at line 1117 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, includeCSS(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), and setTemplatesSubTabs().

                                         : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilTabs = $this->gui_service->tabs();
        $ilCtrl = $this->ctrl;
        $ilToolbar = $this->gui_service->toolbar();

        $ctype = $this->style_request->getTempType();
        if ($ctype == "") {
            $ctype = "table";
        }

        $this->setTemplatesSubTabs();
        $ilCtrl->setParameter($this, "temp_type", $ctype);
        $ilTabs->setSubTabActive("sty_" . $ctype . "_templates");

        // action commands
        if ($this->access_manager->checkWrite()) {
            if ($ctype == "table") {
                $ilToolbar->addButton(
                    $this->lng->txt("sty_generate_template"),
                    $ilCtrl->getLinkTarget($this, "generateTemplate")
                );
            }
            $ilToolbar->addButton(
                $this->lng->txt("sty_add_template"),
                $ilCtrl->getLinkTarget($this, "addTemplate")
            );
        }



        $this->includeCSS();
        $table_gui = new ilTableTemplatesTableGUI(
            $ctype,
            $this,
            "listTemplates",
            $this->getStyleSheet(),
            $this->access_manager
        );
        $tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

propertiesObject()

ilObjStyleSheetGUI::propertiesObject

(

)

Definition at line 272 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$tpl, ilGlobalTemplateInterface\addCss(), ILIAS\Repository\form(), ilObjStyleSheet\getContentStylePath(), getPropertiesValues(), initPropertiesForm(), ILIAS\Repository\object(), and ilGlobalTemplateInterface\setContent().

                                      : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $tpl->addCss(ilObjStyleSheet::getContentStylePath($this->object->getId()));

        $this->initPropertiesForm();
        $this->getPropertiesValues();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

refreshTemplateObject()

ilObjStyleSheetGUI::refreshTemplateObject

(

)

Refresh table template.

Definition at line 1469 of file class.ilObjStyleSheetGUI.php.

References updateTemplateObject().

                                           : void
    {
        $this->updateTemplateObject(true);
    }

Here is the call graph for this function:

returnToUpperContextObject()

ilObjStyleSheetGUI::returnToUpperContextObject

(

)

Definition at line 1898 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\returnToParent().

                                                : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

saveColorObject()

ilObjStyleSheetGUI::saveColorObject

(

)

Save color.

Definition at line 827 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, initColorForm(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                     : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->initColorForm();
        if ($this->form_gui->checkInput()) {
            if ($this->color_manager->colorExists($this->form_gui->getInput("color_name"))) {
                $col_input = $this->form_gui->getItemByPostVar("color_name");
                $col_input->setAlert($lng->txt("sty_color_already_exists"));
            } else {
                $this->color_manager->addColor(
                    $this->form_gui->getInput("color_name"),
                    $this->form_gui->getInput("color_code")
                );
                $ilCtrl->redirect($this, "listColors");
            }
        }
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

saveMediaQueryObject()

ilObjStyleSheetGUI::saveMediaQueryObject

(

)

Save media query.

Definition at line 1024 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, initMediaQueryForm(), and ilGlobalTemplateInterface\setContent().

                                          : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->initMediaQueryForm();

        if ($this->form_gui->checkInput()) {
            $this->object->addMediaQuery($this->form_gui->getInput("mquery"));
            $ilCtrl->redirect($this, "listMediaQueries");
        }
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

saveMediaQueryOrderObject()

ilObjStyleSheetGUI::saveMediaQueryOrderObject

(

)

Definition at line 1098 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, and ilCtrl\redirect().

                                               : void
    {
        $ilCtrl = $this->ctrl;

        $order = $this->style_request->getOrder();
        if (count($order) > 0) {
            $this->getStyleSheet()->saveMediaQueryOrder($order);
        }
        $ilCtrl->redirect($this, "listMediaQueries");
    }

Here is the call graph for this function:

saveObject()

ilObjStyleSheetGUI::saveObject

(

)

Definition at line 408 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjStyleSheet\_addMissingStyleClassesToStyle(), ilObject\_lookupType(), ilObjStyleSheet\_writeStandard(), ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilObjStyleSheet\getBasicZipPath(), getCreateForm(), ilPropertyFormGUI\getInput(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\lng(), ilCtrl\redirect(), and ILIAS\Repository\settings().

                                : void
    {
        $ctrl = $this->gui_service->ctrl();

        $form = $this->getCreateForm();
        $form->checkInput();

        if (!trim($form->getInput("style_title"))) {
            $ctrl->redirect($this, "create");
        }

        // copy from default style or ... see #11330
        $default_style = $this->settings->get("default_content_style_id");
        if (ilObject::_lookupType((int) $default_style) == "sty") {
            $style_obj = ilObjectFactory::getInstanceByObjId((int) $default_style);
            $new_id = $style_obj->ilClone();
            $newObj = new ilObjStyleSheet($new_id);
        } else {
            // ... import from basic zip file
            $imp = new ilImport();
            $style_id = $imp->importObject(
                null,
                ilObjStyleSheet::getBasicZipPath(),
                "style.zip",
                "sty",
                "Services/Style",
                true
            );

            $newObj = new ilObjStyleSheet($style_id);
        }

        $newObj->setTitle($form->getInput("style_title"));
        $newObj->setDescription($form->getInput("style_description"));
        $newObj->update();
        $this->object = $newObj;

        ilObjStyleSheet::_addMissingStyleClassesToStyle($newObj->getId());

        // assign style to style sheet folder,
        // if parent is style sheet folder
        if ($this->requested_ref_id > 0) {
            $fold = ilObjectFactory::getInstanceByRefId($this->requested_ref_id);
            if ($fold->getType() == "stys") {
                $cont_style_settings = new ilContentStyleSettings();
                $cont_style_settings->addStyle($newObj->getId());
                $cont_style_settings->update();

                ilObjStyleSheet::_writeStandard($newObj->getId(), true);
                $this->tpl->setOnScreenMessage("success", $this->lng->txt("object_added"), true);
                $this->ctrl->setParameterByClass(self::class, "obj_id", (string) $newObj->getId());
                $this->ctrl->redirectByClass(self::class, "");
            }
        }
    }

Here is the call graph for this function:

saveTemplateObject()

ilObjStyleSheetGUI::saveTemplateObject

(

)

Save table template.

Definition at line 1372 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjStyleSheet\_getTemplateClassTypes(), getTemplatePreview(), initTemplateForm(), ILIAS\Repository\object(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                        : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->initTemplateForm();
        $temp_type = $this->style_request->getTempType();

        if ($this->form_gui->checkInput()) {
            if ($this->object->templateExists($this->form_gui->getInput("name"))) {
                $name_input = $this->form_gui->getItemByPostVar("name");
                $name_input->setAlert($lng->txt("sty_table_template_already_exists"));
            } else {
                $classes = array();
                foreach (ilObjStyleSheet::_getTemplateClassTypes($temp_type) as $tct => $ct) {
                    $classes[$tct] = $this->form_gui->getInput($tct . "_class");
                }
                $t_id = $this->object->addTemplate(
                    $temp_type,
                    $this->form_gui->getInput("name"),
                    $classes
                );
                $this->object->writeTemplatePreview(
                    $t_id,
                    $this->getTemplatePreview($temp_type, $t_id, true)
                );
                $ilCtrl->redirect($this, "listTemplates");
            }
        }
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

setTemplatesSubTabs()

ilObjStyleSheetGUI::setTemplatesSubTabs

(

)

Definition at line 630 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$c, ilObjectGUI\$ctrl, ilObjStyleSheet\_getTemplateClassTypes(), and ILIAS\Repository\ctrl().

Referenced by listTemplatesObject().

                                         : void
    {
        $ilTabs = $this->gui_service->tabs();
        $ilCtrl = $this->ctrl;

        $types = ilObjStyleSheet::_getTemplateClassTypes();

        foreach ($types as $t => $c) {
            $ilCtrl->setParameter($this, "temp_type", $t);
            $ilTabs->addSubTabTarget(
                "sty_" . $t . "_templates",
                $this->ctrl->getLinkTarget($this, "listTemplates"),
                array("listTemplates", ""),
                get_class($this)
            );
        }

        $ilCtrl->setParameter($this, "temp_type", $this->style_request->getTempType());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

templateGenerationObject()

ilObjStyleSheetGUI::templateGenerationObject

(

)

Table template generation.

Definition at line 1668 of file class.ilObjStyleSheetGUI.php.

References Vendor\Package\$b, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, getTemplatePreview(), initTemplateGenerationForm(), ILIAS\Repository\object(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                              : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->initTemplateGenerationForm();

        if ($this->form_gui->checkInput()) {
            if ($this->object->templateExists($this->form_gui->getInput("name"))) {
                $name_input = $this->form_gui->getItemByPostVar("name");
                $name_input->setAlert($lng->txt("sty_table_template_already_exists"));
            } else {
                // -> move to application class!

                // cell classes
                $cells = array("H" => "header", "C1" => "cell1", "C2" => "cell2");
                $tb_p = $this->form_gui->getItemByPostVar("tb_padding");
                $tb_padding = $tb_p->getValue();
                $lr_p = $this->form_gui->getItemByPostVar("lr_padding");
                $lr_padding = $lr_p->getValue();
                $cell_color = $this->form_gui->getInput("base_color");

                // use mid gray as cell color for bw zebra
                if ($this->form_gui->getInput("layout") == "bwZebra") {
                    $cell_color = "MidGray";
                    if (!$this->color_manager->colorExists($cell_color)) {
                        $this->color_manager->addColor($cell_color, "7F7F7F");
                    }
                    $this->color_manager->updateColor($cell_color, $cell_color, "7F7F7F");
                }

                foreach ($cells as $k => $cell) {
                    $cell_class[$k] = $this->form_gui->getInput("name") . $k;
                    if (!$this->object->characteristicExists($cell_class[$k], "table_cell")) {
                        $this->characteristic_manager->addCharacteristic("table_cell", $cell_class[$k], true);
                    }
                    if ($this->form_gui->getInput("layout") == "bwZebra" && $k == "H") {
                        $this->characteristic_manager->replaceParameter(
                            "td",
                            $cell_class[$k],
                            "color",
                            "!" . $this->form_gui->getInput("base_color") . "(" . $this->form_gui->getInput("lightness_" . $cell . "_text") . ")",
                            "table_cell"
                        );
                        $this->characteristic_manager->replaceParameter(
                            "td",
                            $cell_class[$k],
                            "background-color",
                            "!" . $this->form_gui->getInput("base_color") . "(" . $this->form_gui->getInput("lightness_" . $cell . "_bg") . ")",
                            "table_cell"
                        );
                    } else {
                        $this->characteristic_manager->replaceParameter(
                            "td",
                            $cell_class[$k],
                            "color",
                            "!" . $cell_color . "(" . $this->form_gui->getInput("lightness_" . $cell . "_text") . ")",
                            "table_cell"
                        );
                        $this->characteristic_manager->replaceParameter(
                            "td",
                            $cell_class[$k],
                            "background-color",
                            "!" . $cell_color . "(" . $this->form_gui->getInput("lightness_" . $cell . "_bg") . ")",
                            "table_cell"
                        );
                    }
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "padding-top",
                        $tb_padding,
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "padding-bottom",
                        $tb_padding,
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "padding-left",
                        $lr_padding,
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "padding-right",
                        $lr_padding,
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "border-width",
                        "1px",
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "border-style",
                        "solid",
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "border-color",
                        "!" . $cell_color . "(" . $this->form_gui->getInput("lightness_border") . ")",
                        "table_cell"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "td",
                        $cell_class[$k],
                        "font-weight",
                        "normal",
                        "table_cell"
                    );
                }

                // table class
                $classes["table"] = $this->form_gui->getInput("name") . "T";
                if (!$this->object->characteristicExists($classes["table"], "table")) {
                    $this->characteristic_manager->addCharacteristic("table", $classes["table"], true);
                }
                $this->characteristic_manager->replaceParameter(
                    "table",
                    $classes["table"],
                    "caption-side",
                    "bottom",
                    "table"
                );
                $this->characteristic_manager->replaceParameter(
                    "table",
                    $classes["table"],
                    "border-collapse",
                    "collapse",
                    "table"
                );
                $this->characteristic_manager->replaceParameter(
                    "table",
                    $classes["table"],
                    "margin-top",
                    "5px",
                    "table"
                );
                $this->characteristic_manager->replaceParameter(
                    "table",
                    $classes["table"],
                    "margin-bottom",
                    "5px",
                    "table"
                );
                if ($this->form_gui->getInput("layout") == "bwZebra") {
                    $this->characteristic_manager->replaceParameter(
                        "table",
                        $classes["table"],
                        "border-bottom-color",
                        "!" . $this->form_gui->getInput("base_color"),
                        "table"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "table",
                        $classes["table"],
                        "border-bottom-style",
                        "solid",
                        "table"
                    );
                    $this->characteristic_manager->replaceParameter(
                        "table",
                        $classes["table"],
                        "border-bottom-width",
                        "3px",
                        "table"
                    );
                    $sb = array("left", "right", "top");
                    foreach ($sb as $b) {
                        $this->characteristic_manager->replaceParameter(
                            "table",
                            $classes["table"],
                            "border-" . $b . "-width",
                            "0px",
                            "table"
                        );
                    }
                }

                switch ($this->form_gui->getInput("layout")) {
                    case "bwZebra":
                    case "coloredZebra":
                        $classes["row_head"] = $cell_class["H"];
                        $classes["odd_row"] = $cell_class["C1"];
                        $classes["even_row"] = $cell_class["C2"];
                        break;

                    case "noZebra":
                        $classes["row_head"] = $cell_class["H"];
                        $classes["odd_row"] = $cell_class["C1"];
                        $classes["even_row"] = $cell_class["C1"];
                        $classes["col_head"] = $cell_class["C2"];
                        break;
                }


                $t_id = $this->object->addTemplate(
                    $this->style_request->getTempType(),
                    $this->form_gui->getInput("name"),
                    $classes
                );
                $this->object->writeTemplatePreview(
                    $t_id,
                    $this->getTemplatePreview(
                        $this->style_request->getTempType(),
                        $t_id,
                        true
                    )
                );
                $ilCtrl->redirect($this, "listTemplates");
            }
        }
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

updateColorObject()

ilObjStyleSheetGUI::updateColorObject

(

)

Update color.

Definition at line 853 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, initColorForm(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                       : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $c_name = $this->style_request->getColorName();
        $ilCtrl->setParameter($this, "c_name", $c_name);
        $this->initColorForm("edit");

        if ($this->form_gui->checkInput()) {
            if ($this->color_manager->colorExists($this->form_gui->getInput("color_name")) &&
                $this->form_gui->getInput("color_name") != $c_name) {
                $col_input = $this->form_gui->getItemByPostVar("color_name");
                $col_input->setAlert($lng->txt("sty_color_already_exists"));
            } else {
                $this->color_manager->updateColor(
                    $c_name,
                    $this->form_gui->getInput("color_name"),
                    $this->form_gui->getInput("color_code")
                );
                $ilCtrl->redirect($this, "listColors");
            }
        }
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

updateMediaQueryObject()

ilObjStyleSheetGUI::updateMediaQueryObject

(

)

Definition at line 1040 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, initMediaQueryForm(), and ilGlobalTemplateInterface\setContent().

                                            : void
    {
        $tpl = $this->gui_service->ui()->mainTemplate();
        $ilCtrl = $this->ctrl;

        $this->initMediaQueryForm("edit");

        if ($this->form_gui->checkInput()) {
            $this->object->updateMediaQuery(
                $this->style_request->getMediaQueryId(),
                $this->form_gui->getInput("mquery")
            );
            $ilCtrl->redirect($this, "listMediaQueries");
        }
        $ilCtrl->setParameter($this, "mq_id", $this->style_request->getMediaQueryId());
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

updateObject()

ilObjStyleSheetGUI::updateObject

(

)

Definition at line 340 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ILIAS\Repository\form(), initPropertiesForm(), ilCtrl\redirect(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                  : void
    {
        $lng = $this->lng;
        $ctrl = $this->gui_service->ctrl();
        $tpl = $this->gui_service->ui()->mainTemplate();

        $this->initPropertiesForm("edit");
        if ($this->form->checkInput()) {
            $this->object->setTitle($this->form->getInput("style_title"));
            $this->object->setDescription($this->form->getInput("style_description"));
            $this->object->writeStyleSetting(
                "disable_auto_margins",
                $this->form->getInput("disable_auto_margins")
            );
            $this->object->update();
            $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
            $ctrl->redirect($this, "properties");
        } else {
            $this->form->setValuesByPost();
            $tpl->setContent($this->form->getHTML());
        }
    }

Here is the call graph for this function:

updateTemplateObject()

ilObjStyleSheetGUI::updateTemplateObject

(

bool

$a_refresh = false

)

Definition at line 1406 of file class.ilObjStyleSheetGUI.php.

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjStyleSheet\_getTemplateClassTypes(), ilObjStyleSheet\_lookupTemplateName(), displayTemplateEditForm(), getTemplatePreview(), initTemplateForm(), ILIAS\Repository\object(), and ilLanguage\txt().

Referenced by refreshTemplateObject().

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $ilCtrl->setParameter($this, "t_id", $this->style_request->getTemplateId());
        $this->initTemplateForm("edit");
        $temp_type = $this->style_request->getTempType();

        $t_id = $this->style_request->getTemplateId();
        if ($this->form_gui->checkInput()) {
            if ($this->object->templateExists($this->form_gui->getInput("name")) &&
                $this->form_gui->getInput("name") != ilObjStyleSheet::_lookupTemplateName($t_id)) {
                $name_input = $this->form_gui->getItemByPostVar("name");
                $name_input->setAlert($lng->txt("sty_template_already_exists"));
            } else {
                $classes = array();
                foreach (ilObjStyleSheet::_getTemplateClassTypes($temp_type) as $tct => $ct) {
                    $classes[$tct] = $this->form_gui->getInput($tct . "_class");
                }

                $this->object->updateTemplate(
                    $t_id,
                    $this->form_gui->getInput("name"),
                    $classes
                );
                $this->object->writeTemplatePreview(
                    $t_id,
                    $this->getTemplatePreview($temp_type, $t_id, true)
                );
                if (!$a_refresh) {
                    $ilCtrl->redirect($this, "listTemplates");
                }
            }
        }

        $this->form_gui->setValuesByPost();
        $this->displayTemplateEditForm();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

viewObject()

ilObjStyleSheetGUI::viewObject

(

)

Definition at line 172 of file class.ilObjStyleSheetGUI.php.

References editObject().

                                : void
    {
        $this->editObject();
    }

Here is the call graph for this function:

Field Documentation

$access_manager

Access StyleAccessManager ilObjStyleSheetGUI::$access_manager

protected

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

$characteristic_manager

Content CharacteristicManager ilObjStyleSheetGUI::$characteristic_manager

protected

Definition at line 44 of file class.ilObjStyleSheetGUI.php.

$cmd_delete

string ilObjStyleSheetGUI::$cmd_delete

Definition at line 40 of file class.ilObjStyleSheetGUI.php.

$cmd_new_par

string ilObjStyleSheetGUI::$cmd_new_par

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

$cmd_update

string ilObjStyleSheetGUI::$cmd_update

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

$color_manager

Content ColorManager ilObjStyleSheetGUI::$color_manager

protected

Definition at line 45 of file class.ilObjStyleSheetGUI.php.

$enable_write

bool ilObjStyleSheetGUI::$enable_write = false

protected

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

$form

ilPropertyFormGUI ilObjStyleSheetGUI::$form

protected

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

Referenced by getCloneForm(), getCreateForm(), and getImportForm().

$form_gui

ilPropertyFormGUI ilObjStyleSheetGUI::$form_gui

protected

Definition at line 32 of file class.ilObjStyleSheetGUI.php.

$gui_service

Content InternalGUIService ilObjStyleSheetGUI::$gui_service

protected

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

$help

ilHelpGUI ilObjStyleSheetGUI::$help

protected

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

Referenced by createObject(), and getTabs().

$image_manager

Content ImageManager ilObjStyleSheetGUI::$image_manager

protected

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

$obj_definition

ilObjectDefinition ilObjStyleSheetGUI::$obj_definition

protected

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

$service

Content InternalService ilObjStyleSheetGUI::$service

protected

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

$style_request

Content StandardGUIRequest ilObjStyleSheetGUI::$style_request

protected

Definition at line 34 of file class.ilObjStyleSheetGUI.php.

$super_type

string ilObjStyleSheetGUI::$super_type

protected

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

---

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

• Services/Style/Content/classes/class.ilObjStyleSheetGUI.php