MediaWiki  1.28.1
GenericArrayObjectTest.php
Go to the documentation of this file.
1 <?php
2 
29 abstract class GenericArrayObjectTest extends PHPUnit_Framework_TestCase {
30 
39  abstract public function elementInstancesProvider();
40 
48  abstract public function getInstanceClass();
49 
57  public function instanceProvider() {
58  $instances = [];
59 
60  foreach ( $this->elementInstancesProvider() as $elementInstances ) {
61  $instances[] = $this->getNew( $elementInstances[0] );
62  }
63 
64  return $this->arrayWrap( $instances );
65  }
66 
74  protected function getNew( array $elements = [] ) {
75  $class = $this->getInstanceClass();
76 
77  return new $class( $elements );
78  }
79 
89  public function testConstructor( array $elements ) {
90  $arrayObject = $this->getNew( $elements );
91 
92  $this->assertEquals( count( $elements ), $arrayObject->count() );
93  }
94 
104  public function testIsEmpty( array $elements ) {
105  $arrayObject = $this->getNew( $elements );
106 
107  $this->assertEquals( $elements === [], $arrayObject->isEmpty() );
108  }
109 
119  public function testUnset( GenericArrayObject $list ) {
120  if ( $list->isEmpty() ) {
121  $this->assertTrue( true ); // We cannot test unset if there are no elements
122  } else {
123  $offset = $list->getIterator()->key();
124  $count = $list->count();
125  $list->offsetUnset( $offset );
126  $this->assertEquals( $count - 1, $list->count() );
127  }
128 
129  if ( !$list->isEmpty() ) {
130  $offset = $list->getIterator()->key();
131  $count = $list->count();
132  unset( $list[$offset] );
133  $this->assertEquals( $count - 1, $list->count() );
134  }
135  }
136 
146  public function testAppend( array $elements ) {
147  $list = $this->getNew();
148 
149  $listSize = count( $elements );
150 
151  foreach ( $elements as $element ) {
152  $list->append( $element );
153  }
154 
155  $this->assertEquals( $listSize, $list->count() );
156 
157  $list = $this->getNew();
158 
159  foreach ( $elements as $element ) {
160  $list[] = $element;
161  }
162 
163  $this->assertEquals( $listSize, $list->count() );
164 
165  $this->checkTypeChecks( function ( GenericArrayObject $list, $element ) {
166  $list->append( $element );
167  } );
168  }
169 
177  protected function checkTypeChecks( $function ) {
178  $excption = null;
179  $list = $this->getNew();
180 
181  $elementClass = $list->getObjectType();
182 
183  foreach ( [ 42, 'foo', [], new stdClass(), 4.2 ] as $element ) {
184  $validValid = $element instanceof $elementClass;
185 
186  try {
187  call_user_func( $function, $list, $element );
188  $valid = true;
189  } catch ( InvalidArgumentException $exception ) {
190  $valid = false;
191  }
192 
193  $this->assertEquals(
194  $validValid,
195  $valid,
196  'Object of invalid type got successfully added to a GenericArrayObject'
197  );
198  }
199  }
200 
210  public function testOffsetSet( array $elements ) {
211  if ( $elements === [] ) {
212  $this->assertTrue( true );
213 
214  return;
215  }
216 
217  $list = $this->getNew();
218 
219  $element = reset( $elements );
220  $list->offsetSet( 42, $element );
221  $this->assertEquals( $element, $list->offsetGet( 42 ) );
222 
223  $list = $this->getNew();
224 
225  $element = reset( $elements );
226  $list['oHai'] = $element;
227  $this->assertEquals( $element, $list['oHai'] );
228 
229  $list = $this->getNew();
230 
231  $element = reset( $elements );
232  $list->offsetSet( 9001, $element );
233  $this->assertEquals( $element, $list[9001] );
234 
235  $list = $this->getNew();
236 
237  $element = reset( $elements );
238  $list->offsetSet( null, $element );
239  $this->assertEquals( $element, $list[0] );
240 
241  $list = $this->getNew();
242  $offset = 0;
243 
244  foreach ( $elements as $element ) {
245  $list->offsetSet( null, $element );
246  $this->assertEquals( $element, $list[$offset++] );
247  }
248 
249  $this->assertEquals( count( $elements ), $list->count() );
250 
251  $this->checkTypeChecks( function ( GenericArrayObject $list, $element ) {
252  $list->offsetSet( mt_rand(), $element );
253  } );
254  }
255 
267  public function testSerialization( GenericArrayObject $list ) {
268  $serialization = serialize( $list );
269  $copy = unserialize( $serialization );
270 
271  $this->assertEquals( $serialization, serialize( $copy ) );
272  $this->assertEquals( count( $list ), count( $copy ) );
273 
274  $list = $list->getArrayCopy();
275  $copy = $copy->getArrayCopy();
276 
277  $this->assertArrayEquals( $list, $copy, true, true );
278  }
279 }
the array() calling protocol came about after MediaWiki 1.4rc1.
testIsEmpty(array $elements)
elementInstancesProvider
isEmpty()
Returns if the ArrayObject has no elements.
testConstructor(array $elements)
elementInstancesProvider
testAppend(array $elements)
elementInstancesProvider
unserialize($serialized)
Definition: ApiMessage.php:102
getInstanceClass()
Returns the name of the concrete class being tested.
instanceProvider()
Provides instances of the concrete class being tested.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
offsetSet($index, $value)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
testUnset(GenericArrayObject $list)
instanceProvider
testSerialization(GenericArrayObject $list)
instanceProvider
$count
serialize()
Definition: ApiMessage.php:94
elementInstancesProvider()
Returns objects that can serve as elements in the concrete GenericArrayObject deriving class being te...
testOffsetSet(array $elements)
elementInstancesProvider