MediaWiki  master
GenericArrayObject.php
Go to the documentation of this file.
1 <?php
2 
35 abstract class GenericArrayObject extends ArrayObject {
43  abstract public function getObjectType();
44 
50  protected $indexOffset = 0;
51 
61  protected function getNewOffset() {
62  while ( $this->offsetExists( $this->indexOffset ) ) {
63  $this->indexOffset++;
64  }
65 
66  return $this->indexOffset;
67  }
68 
78  public function __construct( $input = null, $flags = 0, $iterator_class = 'ArrayIterator' ) {
79  parent::__construct( [], $flags, $iterator_class );
80 
81  if ( !is_null( $input ) ) {
82  foreach ( $input as $offset => $value ) {
83  $this->offsetSet( $offset, $value );
84  }
85  }
86  }
87 
95  public function append( $value ) {
96  $this->setElement( null, $value );
97  }
98 
107  public function offsetSet( $index, $value ) {
108  $this->setElement( $index, $value );
109  }
110 
121  protected function hasValidType( $value ) {
122  $class = $this->getObjectType();
123  return $value instanceof $class;
124  }
125 
142  protected function setElement( $index, $value ) {
143  if ( !$this->hasValidType( $value ) ) {
144  throw new InvalidArgumentException(
145  'Can only add ' . $this->getObjectType() . ' implementing objects to '
146  . static::class . '.'
147  );
148  }
149 
150  if ( is_null( $index ) ) {
151  $index = $this->getNewOffset();
152  }
153 
154  if ( $this->preSetElement( $index, $value ) ) {
155  parent::offsetSet( $index, $value );
156  }
157  }
158 
175  protected function preSetElement( $index, $value ) {
176  return true;
177  }
178 
186  public function serialize() {
187  return serialize( $this->getSerializationData() );
188  }
189 
199  protected function getSerializationData() {
200  return [
201  'data' => $this->getArrayCopy(),
202  'index' => $this->indexOffset,
203  ];
204  }
205 
215  public function unserialize( $serialization ) {
216  $serializationData = unserialize( $serialization );
217 
218  foreach ( $serializationData['data'] as $offset => $value ) {
219  // Just set the element, bypassing checks and offset resolving,
220  // as these elements have already gone through this.
221  parent::offsetSet( $offset, $value );
222  }
223 
224  $this->indexOffset = $serializationData['index'];
225 
226  return $serializationData;
227  }
228 
236  public function isEmpty() {
237  return $this->count() === 0;
238  }
239 }
getObjectType()
Returns the name of an interface/class that the element should implement/extend.
if(is_array($mode)) switch($mode) $input
$value
isEmpty()
Returns if the ArrayObject has no elements.
preSetElement($index, $value)
Gets called before a new element is added to the ArrayObject.
getSerializationData()
Returns an array holding all the data that should go into serialization calls.
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
getNewOffset()
Finds a new offset for when appending an element.
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
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
unserialize($serialization)
hasValidType($value)
Returns if the provided value has the same type as the elements that can be added to this ArrayObject...
__construct($input=null, $flags=0, $iterator_class= 'ArrayIterator')
setElement($index, $value)
Method that actually sets the element and holds all common code needed for set operations, including type checking and offset resolving.