/usr/share/php/propel/collection/PropelCollection.php is in php-propel-runtime 1.6.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 | <?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
/**
* Class for iterating over a list of Propel elements
* The collection keys must be integers - no associative array accepted
*
* @method PropelCollection fromXML(string $data) Populate the collection from an XML string
* @method PropelCollection fromYAML(string $data) Populate the collection from a YAML string
* @method PropelCollection fromJSON(string $data) Populate the collection from a JSON string
* @method PropelCollection fromCSV(string $data) Populate the collection from a CSV string
*
* @method string toXML(boolean $usePrefix, boolean $includeLazyLoadColumns) Export the collection to an XML string
* @method string toYAML(boolean $usePrefix, boolean $includeLazyLoadColumns) Export the collection to a YAML string
* @method string toJSON(boolean $usePrefix, boolean $includeLazyLoadColumns) Export the collection to a JSON string
* @method string toCSV(boolean $usePrefix, boolean $includeLazyLoadColumns) Export the collection to a CSV string
*
* @author Francois Zaninotto
* @package propel.runtime.collection
*/
class PropelCollection extends ArrayObject implements Serializable
{
/**
* @var string
*/
protected $model = '';
/**
* @var ArrayIterator
*/
protected $iterator;
/**
* @var PropelFormatter
*/
protected $formatter;
// Generic Collection methods
/**
* Get the data in the collection
*
* @return array
*/
public function getData()
{
return $this->getArrayCopy();
}
/**
* Set the data in the collection
*
* @param array $data
*/
public function setData($data)
{
$this->exchangeArray($data);
}
/**
* Gets the position of the internal pointer
* This position can be later used in seek()
*
* @return integer
*/
public function getPosition()
{
return (int) $this->getInternalIterator()->key();
}
/**
* Move the internal pointer to the beginning of the list
* And get the first element in the collection
*
* @return mixed
*/
public function getFirst()
{
$this->getInternalIterator()->rewind();
return $this->getCurrent();
}
/**
* Check whether the internal pointer is at the beginning of the list
*
* @return boolean
*/
public function isFirst()
{
return $this->getPosition() == 0;
}
/**
* Move the internal pointer backward
* And get the previous element in the collection
*
* @return mixed
*/
public function getPrevious()
{
$pos = $this->getPosition();
if ($pos == 0) {
return null;
} else {
$this->getInternalIterator()->seek($pos - 1);
return $this->getCurrent();
}
}
/**
* Get the current element in the collection
*
* @return mixed
*/
public function getCurrent()
{
return $this->getInternalIterator()->current();
}
/**
* Move the internal pointer forward
* And get the next element in the collection
*
* @return mixed
*/
public function getNext()
{
$this->getInternalIterator()->next();
return $this->getCurrent();
}
/**
* Move the internal pointer to the end of the list
* And get the last element in the collection
*
* @return mixed
*/
public function getLast()
{
$count = $this->count();
if ($count == 0) {
return null;
} else {
$this->getInternalIterator()->seek($count - 1);
return $this->getCurrent();
}
}
/**
* Check whether the internal pointer is at the end of the list
*
* @return boolean
*/
public function isLast()
{
$count = $this->count();
if ($count == 0) {
// empty list... so yes, this is the last
return true;
} else {
return $this->getPosition() == $count - 1;
}
}
/**
* Check if the collection is empty
*
* @return boolean
*/
public function isEmpty()
{
return $this->count() == 0;
}
/**
* Check if the current index is an odd integer
*
* @return boolean
*/
public function isOdd()
{
return (boolean) ($this->getInternalIterator()->key() % 2);
}
/**
* Check if the current index is an even integer
*
* @return boolean
*/
public function isEven()
{
return !$this->isOdd();
}
/**
* Get an element from its key
* Alias for ArrayObject::offsetGet()
*
* @param mixed $key
* @return mixed The element
*
* @throws PropelException
*/
public function get($key)
{
if (!$this->offsetExists($key)) {
throw new PropelException('Unknown key ' . $key);
}
return $this->offsetGet($key);
}
/**
* Pops an element off the end of the collection
*
* @return mixed The popped element
*/
public function pop()
{
if ($this->count() == 0) {
return null;
}
$ret = $this->getLast();
$lastKey = $this->getInternalIterator()->key();
$this->offsetUnset((string) $lastKey);
return $ret;
}
/**
* Pops an element off the beginning of the collection
*
* @return mixed The popped element
*/
public function shift()
{
// the reindexing is complicated to deal with through the iterator
// so let's use the simple solution
$arr = $this->getArrayCopy();
$ret = array_shift($arr);
$this->exchangeArray($arr);
return $ret;
}
/**
* Prepend one or more elements to the beginning of the collection
*
* @param mixed $value the element to prepend
* @return integer The number of new elements in the array
*/
public function prepend($value)
{
// the reindexing is complicated to deal with through the iterator
// so let's use the simple solution
$arr = $this->getArrayCopy();
$ret = array_unshift($arr, $value);
$this->exchangeArray($arr);
return $ret;
}
/**
* Add an element to the collection with the given key
* Alias for ArrayObject::offsetSet()
*
* @param mixed $key
* @param mixed $value
*/
public function set($key, $value)
{
$this->offsetSet($key, $value);
}
/**
* Removes a specified collection element
* Alias for ArrayObject::offsetUnset()
*
* @param mixed $key
* @return mixed The removed element
*
* @throws PropelException
*/
public function remove($key)
{
if (!$this->offsetExists($key)) {
throw new PropelException('Unknown key ' . $key);
}
return $this->offsetUnset($key);
}
/**
* Clears the collection
*
* @return array The previous collection
*/
public function clear()
{
return $this->exchangeArray(array());
}
/**
* Whether or not this collection contains a specified element
*
* @param mixed $element
* @return boolean
*/
public function contains($element)
{
return in_array($element, $this->getArrayCopy(), true);
}
/**
* Search an element in the collection
*
* @param mixed $element
* @return mixed Returns the key for the element if it is found in the collection, FALSE otherwise
*/
public function search($element)
{
return array_search($element, $this->getArrayCopy(), true);
}
/**
* Returns an array of objects present in the collection that
* are not presents in the given collection.
*
* @param PropelCollection $collection A Propel collection.
* @return PropelCollection An array of Propel objects from the collection that are not presents in the given collection.
*/
public function diff(PropelCollection $collection)
{
$diff = clone $this;
$diff->clear();
foreach ($this as $object) {
if (!$collection->contains($object)) {
$diff[] = $object;
}
}
return $diff;
}
// Serializable interface
/**
* @return string
*/
public function serialize()
{
$repr = array(
'data' => $this->getArrayCopy(),
'model' => $this->model,
);
return serialize($repr);
}
/**
* @param string $data
*
* @return void
*/
public function unserialize($data)
{
$repr = unserialize($data);
$this->exchangeArray($repr['data']);
$this->model = $repr['model'];
}
// IteratorAggregate method
/**
* Overrides ArrayObject::getIterator() to save the iterator object
* for internal use e.g. getNext(), isOdd(), etc.
*
* @return ArrayIterator
*/
public function getIterator()
{
$this->iterator = new ArrayIterator($this);
return $this->iterator;
}
/**
* @return ArrayIterator
*/
public function getInternalIterator()
{
if (null === $this->iterator) {
return $this->getIterator();
}
return $this->iterator;
}
/**
* Clear the internal Iterator.
* PHP 5.3 doesn't know how to free a PropelCollection object if it has an attached
* Iterator, so this must be done manually to avoid memory leaks.
* @see http://www.propelorm.org/ticket/1232
*/
public function clearIterator()
{
$this->iterator = null;
}
// Propel collection methods
/**
* Set the model of the elements in the collection
*
* @param string $model Name of the Propel object classes stored in the collection
*/
public function setModel($model)
{
$this->model = $model;
}
/**
* Get the model of the elements in the collection
*
* @return string Name of the Propel object class stored in the collection
*/
public function getModel()
{
return $this->model;
}
/**
* Get the peer class of the elements in the collection
*
* @return string Name of the Propel peer class stored in the collection
*
* @throws PropelException
*/
public function getPeerClass()
{
if ($this->model == '') {
throw new PropelException('You must set the collection model before interacting with it');
}
return constant($this->getModel() . '::PEER');
}
/**
* @param PropelFormatter $formatter
*/
public function setFormatter(PropelFormatter $formatter)
{
$this->formatter = $formatter;
}
/**
* @return PropelFormatter
*/
public function getFormatter()
{
return $this->formatter;
}
/**
* Get a connection object for the database containing the elements of the collection
*
* @param string $type The connection type (Propel::CONNECTION_READ by default; can be Propel::connection_WRITE)
* @return PropelPDO A PropelPDO connection object
*/
public function getConnection($type = Propel::CONNECTION_READ)
{
$databaseName = constant($this->getPeerClass() . '::DATABASE_NAME');
return Propel::getConnection($databaseName, $type);
}
/**
* Populate the current collection from a string, using a given parser format
* <code>
* $coll = new PropelObjectCollection();
* $coll->setModel('Book');
* $coll->importFrom('JSON', '{{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}');
* </code>
*
* @param mixed $parser A PropelParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
* @param string $data The source data to import from
*
* @return BaseObject The current object, for fluid interface
*/
public function importFrom($parser, $data)
{
if (!$parser instanceof PropelParser) {
$parser = PropelParser::getParser($parser);
}
return $this->fromArray($parser->listToArray($data), BasePeer::TYPE_PHPNAME);
}
/**
* Export the current collection to a string, using a given parser format
* <code>
* $books = BookQuery::create()->find();
* echo $book->exportTo('JSON');
* => {{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}}');
* </code>
*
* A PropelOnDemandCollection cannot be exported. Any attempt will result in a PropelExecption being thrown.
*
* @param mixed $parser A PropelParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
* @param boolean $usePrefix (optional) If true, the returned element keys will be prefixed with the
* model class name ('Article_0', 'Article_1', etc). Defaults to TRUE.
* Not supported by PropelArrayCollection, as PropelArrayFormatter has
* already created the array used here with integers as keys.
* @param boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE.
* Not supported by PropelArrayCollection, as PropelArrayFormatter has
* already included lazy-load columns in the array used here.
* @return string The exported data
*/
public function exportTo($parser, $usePrefix = true, $includeLazyLoadColumns = true)
{
if (!$parser instanceof PropelParser) {
$parser = PropelParser::getParser($parser);
}
return $parser->listFromArray($this->toArray(null, $usePrefix, BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns));
}
/**
* Catches calls to undefined methods.
*
* Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.).
* Allows to define default __call() behavior if you use a custom BaseObject
*
* @param string $name
* @param mixed $params
*
* @return array|string
*
* @throws PropelException
*/
public function __call($name, $params)
{
if (preg_match('/^from(\w+)$/', $name, $matches)) {
return $this->importFrom($matches[1], reset($params));
}
if (preg_match('/^to(\w+)$/', $name, $matches)) {
$usePrefix = isset($params[0]) ? $params[0] : true;
$includeLazyLoadColumns = isset($params[1]) ? $params[1] : true;
return $this->exportTo($matches[1], $usePrefix, $includeLazyLoadColumns);
}
throw new PropelException('Call to undefined method: ' . $name);
}
/**
* Returns a string representation of the current collection.
* Based on the string representation of the underlying objects, defined in
* the Peer::DEFAULT_STRING_FORMAT constant
*
* @return string
*/
public function __toString()
{
return (string) $this->exportTo(constant($this->getPeerClass() . '::DEFAULT_STRING_FORMAT'));
}
/**
* Get an array representation of the collection
* Each object is turned into an array and the result is returned
*
* @param string $keyColumn If null, the returned array uses an incremental index.
* Otherwise, the array is indexed using the specified column
* @param boolean $usePrefix If true, the returned array prefixes keys
* with the model class name ('Article_0', 'Article_1', etc).
* @param string $keyType (optional) One of the class type constants BasePeer::TYPE_PHPNAME,
* BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME,
* BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME.
* @param boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE.
* @param array $alreadyDumpedObjects List of objects to skip to avoid recursion
*
* <code>
* $bookCollection->toArray();
* array(
* 0 => array('Id' => 123, 'Title' => 'War And Peace'),
* 1 => array('Id' => 456, 'Title' => 'Don Juan'),
* )
* $bookCollection->toArray('Id');
* array(
* 123 => array('Id' => 123, 'Title' => 'War And Peace'),
* 456 => array('Id' => 456, 'Title' => 'Don Juan'),
* )
* $bookCollection->toArray(null, true);
* array(
* 'Book_0' => array('Id' => 123, 'Title' => 'War And Peace'),
* 'Book_1' => array('Id' => 456, 'Title' => 'Don Juan'),
* )
* </code>
*
* @return array
*/
public function toArray($keyColumn = null, $usePrefix = false, $keyType = BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns = true, $alreadyDumpedObjects = array())
{
$ret = array();
$keyGetterMethod = 'get' . $keyColumn;
/** @var $obj BaseObject */
foreach ($this as $key => $obj) {
$key = null === $keyColumn ? $key : $obj->$keyGetterMethod();
$key = $usePrefix ? ($this->getModel() . '_' . $key) : $key;
$ret[$key] = $obj->toArray($keyType, $includeLazyLoadColumns, $alreadyDumpedObjects, true);
}
return $ret;
}
}
|