Collaboration diagram for ilECSCmsTreeSynchronizer:

Public Member Functions
	__construct (ilECSSetting $server, int $mid, int $tree_id)

	getServer ()
	Get server. More...

	getECSTree ()

	getDefaultSettings ()
	Get default settings. More...

	getGlobalSettings ()
	get global settings More...

	sync ()
	Synchronize tree. More...

Protected Member Functions
	checkTreeUpdates (int $a_root_obj_id)
	Start tree update check. More...

	handleTreeUpdate (int $a_parent_ref_id, int $a_tnode_id)
	Handle tree update (recursively) More...

	syncNode ($tree_obj_id, $parent_id, $a_mapped=false)
	Sync node. More...

	syncCategory (ilECSNodeMappingAssignment $ass, $parent_id)
	Sync category. More...

Private Attributes
ilLogger	$logger

ilLanguage	$lng

ilTree	$tree

ilECSSetting	$server = null

int	$mid

int	$tree_id

ilECSCmsTree	$ecs_tree = null

array	$default_settings = array()

ilECSNodeMappingSettings	$global_settings = null

Detailed Description

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilECSCmsTreeSynchronizer::__construct	(	ilECSSetting	$server,
		int	$mid,
		int	$tree_id
	)

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

References $DIC, $mid, $server, $tree_id, ilECSNodeMappingSettings\getInstanceByServerMid(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\UI\examples\Progress\Bar\server().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
         $this->lng = $DIC->language();
         $this->tree = $DIC->repositoryTree();
 
 
         $this->server = $server;
         $this->mid = $mid;
         $this->ecs_tree = new ilECSCmsTree($tree_id);
         $this->tree_id = $tree_id;
 
         $this->global_settings = ilECSNodeMappingSettings::getInstanceByServerMid($this->server->getServerId(), $this->mid);
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkTreeUpdates()

ilECSCmsTreeSynchronizer::checkTreeUpdates ( int $a_root_obj_id )

protected

Start tree update check.

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

References $mid, $tree_id, ilECSNodeMappingAssignment\getRefId(), handleTreeUpdate(), ILIAS\Repository\logger(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by sync().

                                                            : void
     {
         if ($this->default_settings['tree_update'] === false) {
             $this->logger->info('Tree update disabled for tree with id ' . $this->ecs_tree->getTreeId());
             return;
         }
 
         // Start recursion
         $mapping = new ilECSNodeMappingAssignment(
             $this->server->getServerId(),
             $this->mid,
             $this->tree_id,
             $a_root_obj_id
         );
         $a_root_ref_id = $mapping->getRefId();
         if ($a_root_ref_id) {
             $this->handleTreeUpdate($a_root_ref_id, $a_root_obj_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultSettings()

ilECSCmsTreeSynchronizer::getDefaultSettings ( )

Get default settings.

Definition at line 73 of file class.ilECSCmsTreeSynchronizer.php.

References $default_settings.

Referenced by sync().

                                         : array
     {
         return $this->default_settings;
     }

Here is the caller graph for this function:

◆ getECSTree()

ilECSCmsTreeSynchronizer::getECSTree ( )

Definition at line 65 of file class.ilECSCmsTreeSynchronizer.php.

References $ecs_tree.

                                 : ?\ilECSCmsTree
     {
         return $this->ecs_tree;
     }

◆ getGlobalSettings()

ilECSCmsTreeSynchronizer::getGlobalSettings ( )

get global settings

Definition at line 81 of file class.ilECSCmsTreeSynchronizer.php.

References $global_settings.

                                        : ?\ilECSNodeMappingSettings
     {
         return $this->global_settings;
     }

◆ getServer()

ilECSCmsTreeSynchronizer::getServer ( )

Get server.

Definition at line 60 of file class.ilECSCmsTreeSynchronizer.php.

References $server.

                                : ?\ilECSSetting
     {
         return $this->server;
     }

◆ handleTreeUpdate()

ilECSCmsTreeSynchronizer::handleTreeUpdate	(	int	$a_parent_ref_id,
		int	$a_tnode_id
	)

protected

Handle tree update (recursively)

Definition at line 140 of file class.ilECSCmsTreeSynchronizer.php.

References $mid, ilObject\_getAllReferences(), ilECSImportManager\getInstance(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by checkTreeUpdates().

                                                                               : bool
     {
         // Check if node is already imported at location "parent_ref_id"
         // If not => move it
         $cms_data = new ilECSCmsData($a_tnode_id);
 
         $import_obj_id = ilECSImportManager::getInstance()->lookupObjIdByContentId(
             $this->server->getServerId(),
             $this->mid,
             //TODO fix this cast
             (int) $cms_data->getCmsId()
         );
         if (!$import_obj_id) {
             $this->logger->error('cms tree node not imported. tnode_id: ' . $a_tnode_id);
             return false;
         }
 
         $this->logger->info(' parent ref:' . $a_parent_ref_id . ' tnode:' . $a_tnode_id);
         $ref_ids = ilObject::_getAllReferences($import_obj_id);
         $import_ref_id = end($ref_ids);
         $import_ref_id_parent = $this->tree->getParentId($import_ref_id);
 
         if ($a_parent_ref_id !== $import_ref_id_parent) {
             // move node
             $this->logger->info('Moving node ' . $a_parent_ref_id . ' to ' . $import_ref_id);
             $this->tree->moveTree($import_ref_id, $a_parent_ref_id);
         }
 
         // iterate through childs
         $childs = $this->ecs_tree->getChilds($a_tnode_id);
         foreach ($childs as $node) {
             $this->handleTreeUpdate($import_ref_id, $node['child']);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sync()

ilECSCmsTreeSynchronizer::sync ( )

Synchronize tree.

Definition at line 89 of file class.ilECSCmsTreeSynchronizer.php.

References $mid, $tree_id, checkTreeUpdates(), getDefaultSettings(), ILIAS\Repository\logger(), ilECSCmsTree\lookupRootId(), ilECSNodeMappingAssignments\lookupSettings(), ILIAS\UI\examples\Progress\Bar\server(), and syncNode().

                           : bool
     {
         $this->default_settings = ilECSNodeMappingAssignments::lookupSettings(
             $this->server->getServerId(),
             $this->mid,
             $this->tree_id,
             0
         );
 
         // return if setting is false => no configuration done
         if (!$this->getDefaultSettings()) {
             $this->logger->info('No directory allocation settings. Aborting');
             return true;
         }
 
         // lookup obj id of root node
 
         $root_obj_id = ilECSCmsTree::lookupRootId($this->tree_id);
         $this->syncNode($root_obj_id, 0);
 
         // Tree structure is up to date, now check node movements
         $this->checkTreeUpdates($root_obj_id);
         return true;
     }

Here is the call graph for this function:

◆ syncCategory()

ilECSCmsTreeSynchronizer::syncCategory	(	ilECSNodeMappingAssignment	$ass,
			$parent_id
	)

protected

Sync category.

Definition at line 217 of file class.ilECSCmsTreeSynchronizer.php.

References $data, $mid, $ref_id, ilObject\_getAllReferences(), ilECSNodeMappingAssignment\getCSId(), ilECSImportManager\getInstance(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\UI\examples\Progress\Bar\server(), ilECSImport\setMID(), and SYSTEM_USER_ID.

Referenced by syncNode().

     {
         $data = new ilECSCmsData($ass->getCSId());
 
         // Check if node is imported => create
         // perform title update
         // perform position update
         $obj_id = ilECSImportManager::getInstance()->lookupObjIdByContentId(
             $this->server->getServerId(),
             $this->mid,
             //TODO fix this cast
             (int) $data->getCmsId()
         );
         if ($obj_id) {
             $refs = ilObject::_getAllReferences($obj_id);
             $ref_id = end($refs);
 
 
             $cat = ilObjectFactory::getInstanceByRefId($ref_id, false);
             if (($cat instanceof ilObject) && $this->default_settings['title_update']) {
                 $this->logger->info('Updating cms category ');
                 $this->logger->info('Title is ' . $data->getTitle());
                 $cat->deleteTranslation($this->lng->getDefaultLanguage());
                 $cat->addTranslation(
                     $data->getTitle(),
                     $cat->getLongDescription(),
                     $this->lng->getDefaultLanguage(),
                     $this->lng->getDefaultLanguage()
                 );
                 $cat->setTitle($data->getTitle());
                 $cat->update();
             } else {
                 $this->logger->info('Updating cms category -> nothing to do');
             }
             return $ref_id;
         }
 
         if ($this->global_settings->isEmptyContainerCreationEnabled()) {
             $this->logger->info('Creating new cms category');
 
             // Create category
             $cat = new ilObjCategory();
             $cat->setOwner(SYSTEM_USER_ID);
             $cat->setTitle($data->getTitle());
             $cat->create(); // true for upload
             $cat->createReference();
             $cat->putInTree($parent_id);
             $cat->setPermissions($parent_id);
             $cat->deleteTranslation($this->lng->getDEfaultLanguage());
             $cat->addTranslation(
                 $data->getTitle(),
                 $cat->getLongDescription(),
                 $this->lng->getDefaultLanguage(),
                 $this->lng->getDefaultLanguage()
             );
 
             // set imported
             $import = new ilECSImport(
                 $this->server->getServerId(),
                 $cat->getId()
             );
             $import->setMID($this->mid);
             $import->setContentId($data->getCmsId());
             $import->setImported(true);
             $import->save();
 
             return $cat->getRefId();
         }
 
         $this->logger->info('Creation of empty containers is disabled.');
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ syncNode()

ilECSCmsTreeSynchronizer::syncNode	(	$tree_obj_id,
		$parent_id,
		$a_mapped = `false`
	)

protected

Sync node.

Definition at line 179 of file class.ilECSCmsTreeSynchronizer.php.

References $mid, $tree_id, ilECSNodeMappingAssignment\getRefId(), ILIAS\UI\examples\Progress\Bar\server(), and syncCategory().

Referenced by sync().

                                                                             : bool
     {
         $childs = $this->ecs_tree->getChilds($tree_obj_id);
 
         $assignment = new ilECSNodeMappingAssignment(
             $this->server->getServerId(),
             $this->mid,
             $this->tree_id,
             $tree_obj_id
         );
 
         if ($assignment->getRefId()) {
             $parent_id = $assignment->getRefId();
         }
 
         // information for deeper levels
         if ($assignment->isMapped()) {
             $a_mapped = true;
         }
 
         if ($a_mapped) {
             $parent_id = $this->syncCategory($assignment, $parent_id);
         }
 
         // this is not necessary
         #if($parent_id)
         {
             // iterate through childs
             foreach ($childs as $node) {
                 $this->syncNode($node['child'], $parent_id, $a_mapped);
             }
         }
         return true;
     }