ILIAS  trunk Revision v13.0_alpha-62-g3b72d83f2e5
Public Member Functions | Protected Attributes
ILIAS\Container\Content\ItemBlock\ItemBlock Class Reference
+ Collaboration diagram for ILIAS\Container\Content\ItemBlock\ItemBlock:

Public Member Functions

 __construct (string $block_id, Block $block, array $item_ref_ids, bool $limit_exhausted, array $objective_ids=[])
 
 getId ()
 
 setRenderId (string $render_id)
 
 getRenderId ()
 
 getBlock ()
 
 getLimitExhausted ()
 
 getItemRefIds ()
 
 getObjectiveIds ()
 
 setPosition (int $pos)
 
 getPosition ()
 
 setPageEmbedded (bool $embedded)
 
 getPageEmbedded ()
 

Protected Attributes

array $objective_ids = []
 
bool $page_embedded = false
 
int $pos = 0
 
array $item_ref_ids = []
 
Block $block
 
string $block_id = ""
 
string $render_id = ""
 
bool $limit_exhausted = false
 

Detailed Description

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Container\Content\ItemBlock\ItemBlock::__construct ( string  $block_id,
Block  $block,
array  $item_ref_ids,
bool  $limit_exhausted,
array  $objective_ids = [] 
)

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

48 {
49 $this->block_id = $block_id;
50 $this->render_id = $block_id;
51 $this->block = $block;
52 $this->item_ref_ids = $item_ref_ids;
53 $this->limit_exhausted = $limit_exhausted;
54 $this->objective_ids = $objective_ids;
55 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$block, ILIAS\Container\Content\ItemBlock\ItemBlock\$block_id, ILIAS\Container\Content\ItemBlock\ItemBlock\$item_ref_ids, ILIAS\Container\Content\ItemBlock\ItemBlock\$limit_exhausted, and ILIAS\Container\Content\ItemBlock\ItemBlock\$objective_ids.

Member Function Documentation

◆ getBlock()

ILIAS\Container\Content\ItemBlock\ItemBlock::getBlock ( )

Definition at line 71 of file class.ItemBlock.php.

71 : Block
72 {
73 return $this->block;
74 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$block.

◆ getId()

ILIAS\Container\Content\ItemBlock\ItemBlock::getId ( )

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

56 : string
57 {
58 return $this->block_id;
59 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$block_id.

◆ getItemRefIds()

ILIAS\Container\Content\ItemBlock\ItemBlock::getItemRefIds ( )
Returns
int[]

Definition at line 84 of file class.ItemBlock.php.

84 : array
85 {
86 return $this->item_ref_ids;
87 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$item_ref_ids.

◆ getLimitExhausted()

ILIAS\Container\Content\ItemBlock\ItemBlock::getLimitExhausted ( )

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

76 : bool
77 {
78 return $this->limit_exhausted;
79 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$limit_exhausted.

◆ getObjectiveIds()

ILIAS\Container\Content\ItemBlock\ItemBlock::getObjectiveIds ( )
Returns
int[]

Definition at line 92 of file class.ItemBlock.php.

92 : array
93 {
94 return $this->objective_ids;
95 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$objective_ids.

◆ getPageEmbedded()

ILIAS\Container\Content\ItemBlock\ItemBlock::getPageEmbedded ( )

Definition at line 112 of file class.ItemBlock.php.

112 : bool
113 {
114 return $this->page_embedded;
115 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$page_embedded.

◆ getPosition()

ILIAS\Container\Content\ItemBlock\ItemBlock::getPosition ( )

Definition at line 102 of file class.ItemBlock.php.

102 : int
103 {
104 return $this->pos;
105 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$pos.

◆ getRenderId()

ILIAS\Container\Content\ItemBlock\ItemBlock::getRenderId ( )

Definition at line 66 of file class.ItemBlock.php.

66 : string
67 {
68 return $this->render_id;
69 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$render_id.

◆ setPageEmbedded()

ILIAS\Container\Content\ItemBlock\ItemBlock::setPageEmbedded ( bool  $embedded)

Definition at line 107 of file class.ItemBlock.php.

107 : void
108 {
109 $this->page_embedded = $embedded;
110 }

◆ setPosition()

ILIAS\Container\Content\ItemBlock\ItemBlock::setPosition ( int  $pos)

Definition at line 97 of file class.ItemBlock.php.

97 : void
98 {
99 $this->pos = $pos;
100 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$pos.

◆ setRenderId()

ILIAS\Container\Content\ItemBlock\ItemBlock::setRenderId ( string  $render_id)

Definition at line 61 of file class.ItemBlock.php.

61 : void
62 {
63 $this->render_id = $render_id;
64 }

References ILIAS\Container\Content\ItemBlock\ItemBlock\$render_id.

Field Documentation

◆ $block

Block ILIAS\Container\Content\ItemBlock\ItemBlock::$block
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\__construct(), ILIAS\Container\Content\ItemBlock\ItemBlock\getBlock(), ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\getBlocksForPart(), and ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\getSequence().

◆ $block_id

string ILIAS\Container\Content\ItemBlock\ItemBlock::$block_id = ""
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\__construct(), and ILIAS\Container\Content\ItemBlock\ItemBlock\getId().

◆ $item_ref_ids

array ILIAS\Container\Content\ItemBlock\ItemBlock::$item_ref_ids = []
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\__construct(), ILIAS\Container\Content\ItemBlock\ItemBlock\getItemRefIds(), and ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\preloadSessionandObjectGroupItemData().

◆ $limit_exhausted

bool ILIAS\Container\Content\ItemBlock\ItemBlock::$limit_exhausted = false
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\__construct(), and ILIAS\Container\Content\ItemBlock\ItemBlock\getLimitExhausted().

◆ $objective_ids

array ILIAS\Container\Content\ItemBlock\ItemBlock::$objective_ids = []
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\__construct(), ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\getBlocksForPart(), and ILIAS\Container\Content\ItemBlock\ItemBlock\getObjectiveIds().

◆ $page_embedded

bool ILIAS\Container\Content\ItemBlock\ItemBlock::$page_embedded = false
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\getPageEmbedded().

◆ $pos

int ILIAS\Container\Content\ItemBlock\ItemBlock::$pos = 0
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\getPosition(), ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\getSequence(), and ILIAS\Container\Content\ItemBlock\ItemBlock\setPosition().

◆ $render_id

string ILIAS\Container\Content\ItemBlock\ItemBlock::$render_id = ""
protected

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

Referenced by ILIAS\Container\Content\ItemBlock\ItemBlock\getRenderId(), ILIAS\Container\Content\ItemBlock\ItemBlockSequenceGenerator\getSequence(), and ILIAS\Container\Content\ItemBlock\ItemBlock\setRenderId().

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