Collaboration diagram for ilCloudFileNode:

Public Member Functions
	__construct ($path, $id)

	setId ($id)

	getId ()

	setLoadingComplete ($complete)

	getLoadingComplete ()

	setPath ($path="/")

	getPath ()

	addChild ($path)

	removeChild ($path)

	getChildrenPathes ()

	hasChildren ()

	setParentId ($id)

	getParentId ()

	setIsDir ($is_dir)

	getIsDir ()

	setSize ($size)

	getSize ()

	setModified ($modified)

	getModified ()

	setIconPath ($path)

	getIconPath ()

	setMixed ($mixed)

	getMixed ()

	getJSONEncode ()

Protected Attributes
	$id = 0

	$path = ""

	$parent_id = -1

	$children = array()

	$loading_complete = false

	$is_dir = false

	$size = 0

	$modified = 0

	$created = 0

	$icon_path = ""

	$mixed

Detailed Description

ilCloudFileTree class

Representation of a node (a file or a folder) in the file tree

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$

Definition at line 13 of file class.ilCloudFileNode.php.

Constructor & Destructor Documentation

◆ __construct()

ilCloudFileNode::__construct	(	$path,
		$id
	)

Parameters

string $path

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

References $id, $path, setId(), and setPath().

     {
         $this->setPath($path);
         $this->setId($id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addChild()

ilCloudFileNode::addChild ( $path )

Parameters

$path

Definition at line 130 of file class.ilCloudFileNode.php.

References $path.

     {
         if (!isset($this->children[$path]))
         {
             $this->children[$path] = $path;
         }
 
     }

◆ getChildrenPathes()

ilCloudFileNode::getChildrenPathes ( )

Returns: array|null

Definition at line 154 of file class.ilCloudFileNode.php.

References $children, and hasChildren().

Referenced by getJSONEncode(), and ilCloudFileTree\getSortedListOfChildren().

     {
         if ($this->hasChildren())
         {
             return $this->children;
         }
         return null;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIconPath()

ilCloudFileNode::getIconPath ( )

Returns: string

Definition at line 248 of file class.ilCloudFileNode.php.

References $icon_path.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml().

     {
         return $this->icon_path;
     }

Here is the caller graph for this function:

◆ getId()

ilCloudFileNode::getId ( )

Returns: int

Definition at line 90 of file class.ilCloudFileNode.php.

References $id.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml(), getJSONEncode(), ilCloudPluginFileTreeGUI\getLinkToFolder(), and ilCloudPluginFileTreeGUI\getLocatorHtml().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getIsDir()

ilCloudFileNode::getIsDir ( )

Returns: bool

Definition at line 200 of file class.ilCloudFileNode.php.

References $is_dir.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml(), and getJSONEncode().

     {
         return $this->is_dir;
     }

Here is the caller graph for this function:

◆ getJSONEncode()

ilCloudFileNode::getJSONEncode ( )

Returns: array

Definition at line 273 of file class.ilCloudFileNode.php.

References array, getChildrenPathes(), getId(), getIsDir(), getLoadingComplete(), getParentId(), getPath(), and getSize().

     {
         $node                     = array();
         $node["id"]               = $this->getId();
         $node["is_dir"]           = $this->getIsDir();
         $node["path"]             = $this->getPath();
         $node["parent_id"]        = $this->getParentId();
         $node["loading_complete"] = $this->getLoadingComplete();
         $node["children"]         = $this->getChildrenPathes();
         $node["size"]             = $this->getSize();
 
         return $node;
     }

Here is the call graph for this function:

◆ getLoadingComplete()

ilCloudFileNode::getLoadingComplete ( )

Returns: bool

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

References $loading_complete.

Referenced by getJSONEncode().

     {
         return $this->loading_complete;
     }

Here is the caller graph for this function:

◆ getMixed()

ilCloudFileNode::getMixed ( )

Returns: mixed

Definition at line 264 of file class.ilCloudFileNode.php.

References $mixed.

     {
         return $this->mixed;
     }

◆ getModified()

ilCloudFileNode::getModified ( )

Returns: int

Definition at line 232 of file class.ilCloudFileNode.php.

References $modified.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml().

     {
         return $this->modified;
     }

Here is the caller graph for this function:

◆ getParentId()

ilCloudFileNode::getParentId ( )

Returns: int

Definition at line 184 of file class.ilCloudFileNode.php.

References $parent_id.

Referenced by getJSONEncode(), ilCloudPluginFileTreeGUI\getLinkToFolder(), and ilCloudPluginFileTreeGUI\getLocatorHtml().

     {
         return $this->parent_id;
     }

Here is the caller graph for this function:

◆ getPath()

ilCloudFileNode::getPath ( )

Returns: string

Definition at line 122 of file class.ilCloudFileNode.php.

References $path.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml(), getJSONEncode(), ilCloudPluginFileTreeGUI\getLinkToFolder(), and ilCloudPluginFileTreeGUI\getLocatorHtml().

     {
         return $this->path;
     }

Here is the caller graph for this function:

◆ getSize()

ilCloudFileNode::getSize ( )

Returns: int

Definition at line 216 of file class.ilCloudFileNode.php.

References $size.

Referenced by ilCloudPluginFileTreeGUI\getItemHtml(), and getJSONEncode().

     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ hasChildren()

ilCloudFileNode::hasChildren ( )

Returns: bool

Definition at line 167 of file class.ilCloudFileNode.php.

Referenced by getChildrenPathes().

     {
         return (count($this->children) > 0);
     }

Here is the caller graph for this function:

◆ removeChild()

ilCloudFileNode::removeChild ( $path )

Parameters

$path

Definition at line 142 of file class.ilCloudFileNode.php.

References $path.

     {
         if (isset($this->children[$path]))
         {
             unset($this->children[$path]);
         }
 
     }

◆ setIconPath()

ilCloudFileNode::setIconPath ( $path )

Parameters

$path

Definition at line 240 of file class.ilCloudFileNode.php.

References $path.

     {
         $this->icon_path = $path;
     }

◆ setId()

ilCloudFileNode::setId ( $id )

Parameters

$id

Definition at line 82 of file class.ilCloudFileNode.php.

References $id.

Referenced by __construct().

     {
         $this->id = $id;
     }

Here is the caller graph for this function:

◆ setIsDir()

ilCloudFileNode::setIsDir ( $is_dir )

Parameters

$is_dir

Definition at line 192 of file class.ilCloudFileNode.php.

References $is_dir.

     {
         $this->is_dir = $is_dir;
     }

◆ setLoadingComplete()

ilCloudFileNode::setLoadingComplete ( $complete )

Parameters

bool $complete

Definition at line 98 of file class.ilCloudFileNode.php.

     {
         $this->loading_complete = $complete;
     }

◆ setMixed()

ilCloudFileNode::setMixed ( $mixed )

Parameters

mixed $mixed

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

References $mixed.

     {
         $this->mixed = $mixed;
     }

◆ setModified()

ilCloudFileNode::setModified ( $modified )

Parameters

$modified

Definition at line 224 of file class.ilCloudFileNode.php.

References $modified.

     {
         $this->modified = $modified;
     }

◆ setParentId()

ilCloudFileNode::setParentId ( $id )

Parameters

$id

Definition at line 176 of file class.ilCloudFileNode.php.

References $id.

     {
         $this->parent_id = $id;
     }

◆ setPath()

ilCloudFileNode::setPath ( $path = "/" )

Parameters

string $path

Definition at line 114 of file class.ilCloudFileNode.php.

References $path, and ilCloudUtil\normalizePath().

Referenced by __construct().

     {
         $this->path = ilCloudUtil::normalizePath($path,$this->is_dir);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSize()

ilCloudFileNode::setSize ( $size )

Parameters

$size

Definition at line 208 of file class.ilCloudFileNode.php.

References $size, and size.

     {
         $this->size = $size;
     }

Field Documentation

◆ $children

ilCloudFileNode::$children = array()

protected

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

Referenced by getChildrenPathes().

◆ $created

ilCloudFileNode::$created = 0

protected

Definition at line 58 of file class.ilCloudFileNode.php.

◆ $icon_path

ilCloudFileNode::$icon_path = ""

protected

Definition at line 63 of file class.ilCloudFileNode.php.

Referenced by getIconPath().

◆ $id

ilCloudFileNode::$id = 0

protected

Definition at line 18 of file class.ilCloudFileNode.php.

Referenced by __construct(), getId(), setId(), and setParentId().

◆ $is_dir

ilCloudFileNode::$is_dir = false

protected

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

Referenced by getIsDir(), and setIsDir().

◆ $loading_complete

ilCloudFileNode::$loading_complete = false

protected

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

Referenced by getLoadingComplete().

◆ $mixed

ilCloudFileNode::$mixed

protected

Definition at line 68 of file class.ilCloudFileNode.php.

Referenced by getMixed(), and setMixed().

◆ $modified

ilCloudFileNode::$modified = 0

protected

Definition at line 53 of file class.ilCloudFileNode.php.

Referenced by getModified(), and setModified().

◆ $parent_id

ilCloudFileNode::$parent_id = -1

protected

Definition at line 28 of file class.ilCloudFileNode.php.

Referenced by getParentId().

◆ $path

ilCloudFileNode::$path = ""

protected

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

Referenced by __construct(), addChild(), getPath(), removeChild(), setIconPath(), and setPath().

◆ $size

ilCloudFileNode::$size = 0

protected

Definition at line 48 of file class.ilCloudFileNode.php.

Referenced by getSize(), and setSize().

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

Modules/Cloud/classes/class.ilCloudFileNode.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addChild()

◆ getChildrenPathes()

◆ getIconPath()

◆ getId()

◆ getIsDir()

◆ getJSONEncode()

◆ getLoadingComplete()

◆ getMixed()

◆ getModified()

◆ getParentId()

◆ getPath()

◆ getSize()

◆ hasChildren()

◆ removeChild()

◆ setIconPath()

◆ setId()

◆ setIsDir()

◆ setLoadingComplete()

◆ setMixed()

◆ setModified()

◆ setParentId()

◆ setPath()

◆ setSize()

Field Documentation

◆ $children

◆ $created

◆ $icon_path

◆ $id

◆ $is_dir

◆ $loading_complete

◆ $mixed

◆ $modified

◆ $parent_id

◆ $path

◆ $size