ILIAS  release_8 Revision v8.19
•All Data Structures Namespaces Files Functions Variables Modules Pages
Public Member Functions
ilCtrlStructureTest Class Reference

Class ilCtrlStructureTest. More...

+ Inheritance diagram for ilCtrlStructureTest:
+ Collaboration diagram for ilCtrlStructureTest:

Public Member Functions

 testStructureBaseClasses ()
 
 testStructureSecurityInfos ()
 
 testStructureCtrlInfos ()
 
 testStructureSavedParameters ()
 
 testStructureSavedParametersWithProtectedKey ($protected_parameter)
 getProtectedParameters More...
 
 testStructureTemporaryParameters ()
 
 testStructureReturnTargets ()
 
 getProtectedParameters ()
 

Detailed Description

Class ilCtrlStructureTest.

Author
Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 13 of file ilCtrlStructureTest.php.

Member Function Documentation

◆ getProtectedParameters()

ilCtrlStructureTest::getProtectedParameters ( )

Definition at line 230 of file ilCtrlStructureTest.php.

230  : array
231  {
232  return [
233  ['baseClass'],
234  ['cmdClass'],
235  ['cmdNode'],
236  ['rtoken'],
237  ];
238  }

◆ testStructureBaseClasses()

ilCtrlStructureTest::testStructureBaseClasses ( )

Definition at line 15 of file ilCtrlStructureTest.php.

References ilCtrlStructureInterface\KEY_CLASS_CID.

15  : void
16  {
17  $structure = new ilCtrlStructure([
18  'baseclass1' => [ilCtrlStructureInterface::KEY_CLASS_CID => 'cid1'],
19  'baseclass2' => [ilCtrlStructureInterface::KEY_CLASS_CID => 'cid2'],
20  'baseclass3' => [ilCtrlStructureInterface::KEY_CLASS_CID => 'cid3'],
21  ], [
22  'baseclass1',
23  'baseclass2',
24  'baseclass3',
25  ], []);
26 
27  $this->assertTrue($structure->isBaseClass('baseclass1'));
28  $this->assertTrue($structure->isBaseClass('baseclass2'));
29  $this->assertTrue($structure->isBaseClass('baseclass3'));
30  $this->assertFalse($structure->isBaseClass('baseclass4'));
31  $this->assertFalse($structure->isBaseClass(''));
32  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12
ilCtrlStructureInterface\KEY_CLASS_CID
const KEY_CLASS_CID
array key constants that are used for certain information.
Definition: interface.ilCtrlStructureInterface.php:15

◆ testStructureCtrlInfos()

ilCtrlStructureTest::testStructureCtrlInfos ( )

Definition at line 79 of file ilCtrlStructureTest.php.

References ilCtrlStructureInterface\KEY_CLASS_CHILDREN, ilCtrlStructureInterface\KEY_CLASS_CID, ilCtrlStructureInterface\KEY_CLASS_NAME, ilCtrlStructureInterface\KEY_CLASS_PARENTS, and ilCtrlStructureInterface\KEY_CLASS_PATH.

79  : void
80  {
81  $structure = new ilCtrlStructure([
82  'class1' => [
83  ilCtrlStructureInterface::KEY_CLASS_CID => 'cid1',
84  ilCtrlStructureInterface::KEY_CLASS_NAME => 'Class1',
85  ilCtrlStructureInterface::KEY_CLASS_PATH => './path/1',
86  ilCtrlStructureInterface::KEY_CLASS_PARENTS => [],
87  ilCtrlStructureInterface::KEY_CLASS_CHILDREN => [
88  'class2',
89  ],
90  ],
91  'class2' => [
92  ilCtrlStructureInterface::KEY_CLASS_CID => 'cid2',
93  ilCtrlStructureInterface::KEY_CLASS_NAME => 'Class2',
94  ilCtrlStructureInterface::KEY_CLASS_PATH => './path/2',
95  ilCtrlStructureInterface::KEY_CLASS_PARENTS => [
96  'class1',
97  ],
98  ilCtrlStructureInterface::KEY_CLASS_CHILDREN => [],
99  ],
100  ], [], []);
101 
102  $this->assertEquals('Class1', $structure->getObjNameByCid('cid1'));
103  $this->assertEquals('Class1', $structure->getObjNameByName('Class1'));
104  $this->assertEquals('Class2', $structure->getObjNameByCid('cid2'));
105  $this->assertEquals('Class2', $structure->getObjNameByName('Class2'));
106  $this->assertNull($structure->getObjNameByCid('cid3'));
107  $this->assertNull($structure->getObjNameByName('Class3'));
108 
109  $this->assertEquals('class1', $structure->getClassNameByCid('cid1'));
110  $this->assertEquals('cid1', $structure->getClassCidByName('Class1'));
111  $this->assertEquals('class2', $structure->getClassNameByCid('cid2'));
112  $this->assertEquals('cid2', $structure->getClassCidByName('Class2'));
113  $this->assertNull($structure->getClassNameByCid('cid3'));
114  $this->assertNull($structure->getClassCidByName('Class3'));
115 
116  $this->assertEquals('./path/1', $structure->getRelativePathByCid('cid1'));
117  $this->assertEquals('./path/1', $structure->getRelativePathByName('Class1'));
118  $this->assertEquals('./path/2', $structure->getRelativePathByCid('cid2'));
119  $this->assertEquals('./path/2', $structure->getRelativePathByName('Class2'));
120  $this->assertNull($structure->getRelativePathByCid('cid3'));
121  $this->assertNull($structure->getRelativePathByName('Class3'));
122 
123  $this->assertEquals(['class2'], $structure->getChildrenByCid('cid1'));
124  $this->assertEquals(['class2'], $structure->getChildrenByName('Class1'));
125  $this->assertNull($structure->getChildrenByCid('cid2'));
126  $this->assertNull($structure->getChildrenByName('Class2'));
127  $this->assertNull($structure->getChildrenByCid('cid3'));
128  $this->assertNull($structure->getChildrenByName('Class3'));
129 
130  $this->assertNull($structure->getParentsByCid('cid1'));
131  $this->assertNull($structure->getParentsByName('Class1'));
132  $this->assertEquals(['class1'], $structure->getParentsByCid('cid2'));
133  $this->assertEquals(['class1'], $structure->getParentsByName('Class2'));
134  $this->assertNull($structure->getParentsByCid('cid3'));
135  $this->assertNull($structure->getParentsByName('Class3'));
136  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12
ilCtrlStructureInterface\KEY_CLASS_CID
const KEY_CLASS_CID
array key constants that are used for certain information.
Definition: interface.ilCtrlStructureInterface.php:15

◆ testStructureReturnTargets()

ilCtrlStructureTest::testStructureReturnTargets ( )

Definition at line 220 of file ilCtrlStructureTest.php.

220  : void
221  {
222  $structure = new ilCtrlStructure([], [], []);
223 
224  $test_url = 'https://domain.com/test/url';
225  $structure->setReturnTargetByClass('Class1', $test_url);
226  $this->assertEquals($test_url, $structure->getReturnTargetByClass('Class1'));
227  $this->assertNull($structure->getReturnTargetByClass('Class2'));
228  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12

◆ testStructureSavedParameters()

ilCtrlStructureTest::testStructureSavedParameters ( )

Definition at line 138 of file ilCtrlStructureTest.php.

138  : void
139  {
140  $structure = new ilCtrlStructure([], [], []);
141 
142  $structure->setPermanentParameterByClass('Class1', 'param1');
143  $structure->setPermanentParameterByClass('Class1', 'param2');
144  $structure->setPermanentParameterByClass('Class2', 'param1');
145 
146  // parameters must be as set above
147  $this->assertEquals(['param1', 'param2'], $structure->getPermanentParametersByClass('Class1'));
148  $this->assertEquals(['param1'], $structure->getPermanentParametersByClass('Class2'));
149 
150  $structure->removeSingleParameterByClass('Class1', 'param1');
151 
152  // parameter 'param1' must no longer be contained and not
153  // affect parameters of 'Class2'.
154  $this->assertEquals(['param2'], $structure->getPermanentParametersByClass('Class1'));
155  $this->assertEquals(['param1'], $structure->getPermanentParametersByClass('Class2'));
156 
157  $structure->removePermanentParametersByClass('Class1');
158 
159  // no parameters must be contained anymore for 'Class1',
160  // but not affect parameters of 'Class2'
161  $this->assertNull($structure->getPermanentParametersByClass('Class1'));
162  $this->assertEquals(['param1'], $structure->getPermanentParametersByClass('Class2'));
163 
164  // parameter must not be set, it contains invalid characters.
165  $parameter_name = '$param';
166  $this->expectException(ilCtrlException::class);
167  $this->expectExceptionMessage("Cannot save parameter '$parameter_name', as it contains invalid characters.");
168  $structure->setPermanentParameterByClass('Class2', $parameter_name);
169  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12

◆ testStructureSavedParametersWithProtectedKey()

ilCtrlStructureTest::testStructureSavedParametersWithProtectedKey (   $protected_parameter)

getProtectedParameters

Definition at line 174 of file ilCtrlStructureTest.php.

174  : void
175  {
176  $structure = new ilCtrlStructure([], [], []);
177  $this->expectException(ilCtrlException::class);
178  $structure->setPermanentParameterByClass('a_class', $protected_parameter);
179  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12

◆ testStructureSecurityInfos()

ilCtrlStructureTest::testStructureSecurityInfos ( )

Definition at line 34 of file ilCtrlStructureTest.php.

References ilCtrlStructureInterface\KEY_CLASS_CID, ilCtrlStructureInterface\KEY_CLASS_NAME, ilCtrlStructureInterface\KEY_SAFE_COMMANDS, and ilCtrlStructureInterface\KEY_UNSAFE_COMMANDS.

34  : void
35  {
36  $structure = new ilCtrlStructure([
37  'cmdclass1' => [
38  ilCtrlStructureInterface::KEY_CLASS_CID => 'cid1',
39  ilCtrlStructureInterface::KEY_CLASS_NAME => 'cmdClass1',
40  ],
41  'cmdclass2' => [
42  ilCtrlStructureInterface::KEY_CLASS_CID => 'cid2',
43  ilCtrlStructureInterface::KEY_CLASS_NAME => 'cmdClass2',
44  ],
45  ], [], [
46  'cmdclass1' => [
47  ilCtrlStructureInterface::KEY_UNSAFE_COMMANDS => [],
48  ilCtrlStructureInterface::KEY_SAFE_COMMANDS => [
49  'postCmd1',
50  ],
51  ],
52  'cmdclass2' => [
53  ilCtrlStructureInterface::KEY_UNSAFE_COMMANDS => [
54  'getCmd1',
55  ],
56  ilCtrlStructureInterface::KEY_SAFE_COMMANDS => [],
57  ],
58  ]);
59 
60  $this->assertEmpty($structure->getUnsafeCommandsByCid('cid1'));
61  $this->assertEmpty($structure->getUnsafeCommandsByName('cmdClass1'));
62 
63  $this->assertEquals(['postCmd1'], $structure->getSafeCommandsByCid('cid1'));
64  $this->assertEquals(['postCmd1'], $structure->getSafeCommandsByName('cmdClass1'));
65 
66  $this->assertEquals(['getCmd1'], $structure->getUnsafeCommandsByCid('cid2'));
67  $this->assertEquals(['getCmd1'], $structure->getUnsafeCommandsByName('cmdClass2'));
68 
69  $this->assertEmpty($structure->getSafeCommandsByCid('cid2'));
70  $this->assertEmpty($structure->getSafeCommandsByName('cmdClass2'));
71 
72  $this->assertEmpty($structure->getUnsafeCommandsByName(''));
73  $this->assertEmpty($structure->getUnsafeCommandsByCid(''));
74 
75  $this->assertEmpty($structure->getSafeCommandsByCid(''));
76  $this->assertEmpty($structure->getSafeCommandsByName(''));
77  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12
ilCtrlStructureInterface\KEY_CLASS_CID
const KEY_CLASS_CID
array key constants that are used for certain information.
Definition: interface.ilCtrlStructureInterface.php:15

◆ testStructureTemporaryParameters()

ilCtrlStructureTest::testStructureTemporaryParameters ( )

Definition at line 181 of file ilCtrlStructureTest.php.

181  : void
182  {
183  $structure = new ilCtrlStructure([], [], []);
184 
185  $structure->setTemporaryParameterByClass('Class1', 'param1', 1);
186  $structure->setTemporaryParameterByClass('Class1', 'param2', '2');
187  $structure->setTemporaryParameterByClass('Class2', 'param1', true);
188 
189  // parameters must be as set above
190  $this->assertEquals(['param1' => true], $structure->getTemporaryParametersByClass('Class2'));
191  $this->assertEquals(
192  ['param1' => 1, 'param2' => '2'],
193  $structure->getTemporaryParametersByClass('Class1')
194  );
195 
196  $structure->removeSingleParameterByClass('Class1', 'param1');
197 
198  // parameter 'param1' must no longer be contained and not
199  // affect parameters of 'Class2'.
200  $this->assertEquals(['param1' => true], $structure->getTemporaryParametersByClass('Class2'));
201  $this->assertEquals(
202  ['param2' => '2'],
203  $structure->getTemporaryParametersByClass('Class1')
204  );
205 
206  $structure->removeTemporaryParametersByClass('Class1');
207 
208  // no parameters must be contained anymore for 'Class1',
209  // but not affect parameters of 'Class2'
210  $this->assertEquals(['param1' => true], $structure->getTemporaryParametersByClass('Class2'));
211  $this->assertNull($structure->getTemporaryParametersByClass('Class1'));
212 
213  // parameter must not be set, it contains invalid characters.
214  $parameter_name = '$param';
215  $this->expectException(ilCtrlException::class);
216  $this->expectExceptionMessage("Cannot save parameter '$parameter_name', as it contains invalid characters.");
217  $structure->setTemporaryParameterByClass('Class3', $parameter_name, 0);
218  }
ilCtrlStructure
Class ilCtrlStructure holds the currently read control structure.
Definition: class.ilCtrlStructure.php:12
The documentation for this class was generated from the following file: