ilObjCategoryReferenceGUI Class Reference

Inheritance diagram for ilObjCategoryReferenceGUI:

Collaboration diagram for ilObjCategoryReferenceGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor.
	executeCommand ()
	Execute command.
	getTabs ($tabs_gui)
	get tabs
Public Member Functions inherited from ilContainerReferenceGUI
	redirectObject ()
	redirect to target
	createObject ()
	Create object.
	saveObject ()
	save object
	editObject ()
	edit object
	updateObject ()
	update object
	getTargetType ()
	get target type
	getReferenceType ()
	get reference type
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not)
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui
	getCreationMode ()
	get creation mode
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	setActions ($a_actions="")
	set possible actions for objects in list.
	setSubObjects ($a_sub_objects="")
	set possible subobjects for this object.
	setLocator ()
	set Locator
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	omitLocator ($a_omit=true)
	addAdminLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	undeleteObject ()
	get object back from trash
	insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
	recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
	confirmedDeleteObject ()
	confirmed deletion if object -> objects are moved to trash
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
	remove already deleted objects within the objects in trash recursive function
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	importObject ()
	import new object form
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	afterUpdate ()
	permObject ()
	show permissions of current node
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g.
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g.
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command
	permSaveObject ()
	save permissions
	isVisible ($a_ref_id, $a_type)
	displayList ()
	display object list
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	display deletion confirmation screen only for referenced objects.
	trashObject ()
	show trash content of object
	addRoleObject ()
	adds a local role This method is only called when choose the option 'you may add local roles'.
	showActions ($with_subobjects=false)
	show possible action (form buttons)
	getActions ()
	Get Actions.
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste
	getTabs (&$tabs_gui)
	get tabs abstract method.
	__showButton ($a_cmd, $a_text, $a_target= '')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table
	__showClipboardTable ($a_result_set, $a_from="")
	infoObject ()
	__buildRoleFilterSelect ()
	__filterRoles ($a_roles, $a_filter)
	ownerObject ()
	changeOwnerObject ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	Add an object search in case the number of existing objects is too big to offer a selection list.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="")

Static Public Member Functions
static	_goto ($a_target)
	Support for goto php.
Static Public Member Functions inherited from ilContainerReferenceGUI
static	_prepareSelection ($a_ref_ids, $a_target_type)
	Prepare selection of target objects.

Protected Attributes
	$target_type = 'cat'
	$reference_type = 'catr'
Protected Attributes inherited from ilContainerReferenceGUI
	$existing_objects = array()

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$ilias
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
Protected Member Functions inherited from ilContainerReferenceGUI
	showSelection ()
	show selection of containers
	initFormSelection ()
	init form selection
	initFormEditSelection ()
	init form selection

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

ilObjCategoryReferenceGUI: ilPermissionGUI, ilInfoScreenGUI

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

Constructor & Destructor Documentation

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

Constructor.

Parameters

@return

Reimplemented from ilContainerReferenceGUI.

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

        {
                 parent::__construct($a_data, $a_id,true,false);
        }

Member Function Documentation

static ilObjCategoryReferenceGUI::_goto (   $a_target )

static

Support for goto php.

Returns

void

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

References $ilErr, ilObjectGUI\$lng, $target_ref_id, ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

         {
                global $ilAccess, $ilErr, $lng;
                
                include_once('./Services/ContainerReference/classes/class.ilContainerReference.php');
                $target_ref_id = ilContainerReference::_lookupTargetRefId(ilObject::_lookupObjId($a_target));
                
                include_once('./Modules/Category/classes/class.ilObjCategoryGUI.php');
                ilObjCategoryGUI::_goto($target_ref_id);
         }

Here is the call graph for this function:

ilObjCategoryReferenceGUI::executeCommand

(

)

Execute command.

public

Reimplemented from ilObjectGUI.

Definition at line 55 of file class.ilObjCategoryReferenceGUI.php.

References $cmd, $ilErr, and ilObjectGUI\prepareOutput().

        {
                global $rbacsystem,$ilErr,$ilAccess;

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

                $this->prepareOutput();

                switch($next_class)
                {
                        case 'ilpermissiongui':
                                $this->tabs_gui->setTabActive('perm_settings');
                                include_once("./classes/class.ilPermissionGUI.php");
                                $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                                break;

                        default:
                                if(!$cmd || $cmd == 'view')
                                {
                                        $cmd = "edit";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilObjCategoryReferenceGUI::getTabs

(

$tabs_gui

)

get tabs

@access public

Parameters

object

tabs gui object

Definition at line 91 of file class.ilObjCategoryReferenceGUI.php.

        {
                global $ilAccess;


                if($ilAccess->checkAccess('write','',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("edit",
                                $this->ctrl->getLinkTarget($this, "edit"),
                                array(),
                                "");
                }
                if ($ilAccess->checkAccess('edit_permission','',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), 
                                array("perm","info","owner"), 'ilpermissiongui');
                }
        }

Field Documentation

ilObjCategoryReferenceGUI::$reference_type = 'catr'

protected

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

ilObjCategoryReferenceGUI::$target_type = 'cat'

protected

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

---

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

• Modules/CategoryReference/classes/class.ilObjCategoryReferenceGUI.php