File core/Collections.php | Bandwidth PHP SDK

  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 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693

<?php
namespace Catapult;

/**
 * A collection object. All collection classes must
 * inherit this. It provides methods to lookup, serialize
 * and put contents in a collection. Collections
 * can represent any extended class where
 * any of those listed in models. does not have an implemention for @class Media
 *
 *
 * @class CollectionObject. Superset
 * of the collections. Provides auxilary functions
 * to manage, update and get elements within a collection
 */
class CollectionObject {

   /**
    * either pass in infomation as array
    * or datapacket collection identify each element key by its id
    *
    * @param data -> initial set of data
    */   
    public function __construct($data=array(), $quiet = TRUE)
    {
      $this->data = array();
      $this->order = array();
      if ($data instanceof DataPacketCollection) {
        $data = $data->get();
        $cnt = 0;

        foreach($data as $d) {
         /**
          * find out whether the primary key is id or content 
          * we need to use this in the order array
          */

           $primary = ResolverResource::key($d);

           /**
            * by default don't fetch the contents
            * of the model. This is useful when loading large lists
            */
           if (!($quiet)) {
              $this->data[$d[$primary]] = $this->get($d{$primary});
           } else {
              $this->data[$d[$primary]] = $this->setup($d);
          }

          $this->order[$cnt] = $d{$primary};

          $cnt ++;
         }

      } else {
        foreach ($data as $d) {
          $data->data[$d[$d->key()]] = $d;
        }
      }
    }

   /**
    * Serialize the collection object as a 
    * JSON object.
    */
    public function __toString()
    {
      return Encoder::Serialize($this->data);
    }

    /**
    * get the last item within
    * a set. This should always try to get the
    * last item when not found return a null
    *  
    */
    public function last()
    {
      return $this->data[$this->order[sizeof($this->order) - 1]];
    }

    /**
     * get the first item
     * within a set
     * 
     */
    public function first()
    {
      return $this->data[$this->order[0]];
    }
    

    /**
     * Get one item from the Collection
     * if item is not initiated, initiate it
     *
     * @param id: a valid id inside this collection
     */
    public function get($id=null)
    {
      if ($id == null)
        return $this->data;


      $cname = "Catapult\\" . $this->getName();

      $obj = new $cname;

      return $obj->get($id);
    }

    /**
     * Setup the object. This is forward
     * to GenericRecource's load/1. It should add each
     * attribute in the provided set 
     *
     * @param data: array
     */
    public function setup($d) 
    {

      $cname = "Catapult\\" . $this->getName();

      $obj = new $cname;
      $obj->load($d);
          
      return $obj;
    }

    /**
     * Before adding we must make sure the datapacket fits(schema)
     * support two fold init where
     * data can either be the initialized object
     * or raw array
     *
     * @param data -> data that is valid for this collection
     */
    public function add($data)
    {
      $schema = array_keys(get_object_vars(($this->data[0])));
      $schema1 = is_array($data) ? array_keys($data) : array_keys(get_object_vars($data));

      foreach ($schema as $s) 
        if (!(in_array($s, $schema1)))
          throw new \CatapultApiException(EXCEPTIONS::WRONG_DATA_PACKET . $this->name());


      if (is_object($data))
        $this->data[$data1->id] = $data1;
      else
        $this->data[$data1['id']] = $this->get($data1['id']);
     }


    /**
     * check if our data structure
     * is empty or not. should also
     * retun false when we have a string
     */
    public function isEmpty()
    {
      if (count($this->data) > 0 || is_string($this->data))
        return false;

      return true; 
    }

    /**
     * get a specific entity
     * in the collection
     *
     * @param id -> id for match
     * @return collectionsequence
     */
    public function find($terms /* associate array of terms */, $absolute=TRUE)
    {
      $terms = Ensure::Input($terms);

      $terms = $terms->get();
      $out = array();
      /** when absolute is on, all terms should match **/
      foreach ($this->data as $d) {
        $m = 0;

        foreach ($terms as $k => $term) {
           if ($absolute) {
            if (is_object($d)) 
              if ($d->$k === $term)
                $m++;

            if (is_array($d)) 
              if ($d[$k] === $term)
                $m++;

            if (sizeof($terms) == $m) 
              $out[] = $d;

          } else {
            /** add if any terms match **/
            if (is_object($d)) 
              if ($d->$k === $term)
                $out[] = $d;

            if (is_array($d)) 
              if ($d[$k] === $term)
                $out[] = $d;
          }

        }
      }

      /** update adds direct object updating **/
      $this->data = $out;

      return new CollectionSequence($out, $this->getName());
    }

    /**
     * slow on performance. ONLY
     * use if absolutely needed
     * this will reload each item
     * in a collection, individually.
     *
     * Where objects all must be initiated
     * and have get/1 ready with id
     */
    public function reload()
    {
      foreach ($this->data as $idx => $item)
        $this->data[$idx] = $item->reload();
    }

    /**
     * Collection based ToArray
     * should serialize each model into its
     * array
     */
    public function toArray() {
      $collectionArray = array();
      foreach ($this->data as $data) {
        $collectionArray[] = $data->toArray();
      }
      return $collectionArray;
    }

    /**
     * iterator over the listing
     * object
     * @return a CollectionIterator
     */
    public function listIterator()
    {
      $args = Ensure::input(func_get_args()); 
      /**
       * collection
       * iterator should point
       * to our collection
       */ 
      return new CollectionIterator($this, $args->get());
    }
    /**
     * scenarios where the objects
     * has not been loaded yet
     * added: 2/4/2015.
     * Before:
     * PhoneNumber = new PhoneNumber
     * PhoneNUmbers = PhoneNumber->listAll
     *
     * Now:
     * PhoneNumbers = new PhoneNumberCollection
     * PhoneNumbers->listAll
     *
     * This should always make sure we dont
     * have data already
     */
    public function listAll()
    {
      $class = $this->getName();
      $clname = "Catapult\\" . $class;
      $proto = new $clname;

      // forward our arguments
      $protolist = $proto->listAll(func_get_args());
      
      $this->data = $protolist->data; 

      return $protolist;
    }
  }

class CollectionIterator extends CollectionObject {
  /**
   * get a collection iterator
   * preserve the options from out
   * our initial collection
   *
   * @param collection: a collection object
   * @param standardOptions: options used for our first listIterator call
   * these will be used throughout our iteration
   * 
   */ 
  public function __construct(&$collection, $standardOptions=array()) {
    $this->currentPage = 0;
    if (isset($standardOptions['size'])) {
      $this->pageSize = $standardOptions['size'];
    } else {
      // default to 1000
      $this->pageSize = DEFAULTS::MAX_SIZE;
    }
    $this->collection = $collection;
    $this->standardOptions = $standardOptions;
  }

  /**
   * return either a null or
   * set of data
   *
   * @return: CollectionSequence
   */
  public function __invoke($isPrevious=FALSE) {
    $data = $this->collection->listAll(array_merge($this->standardOptions, array(
      "page" => $this->currentPage,
      "size" => $this->pageSize
        
    )))->get(); 
    $this->currentPage += !$isPrevious ? 1 : -1;

    return sizeof($data)>0 ? $data : null;
  }
  /**
   * fetch all the contents
   *
   */
  public function fetchAll() {
    $results = array();
    $result = $this->next();
    while($result !== null) {
      $results = array_merge($results,$result);
      $result = $this->next();
    }
    return $results;
  }

  /**
   * same as __invoke
   * will get our next set of collection
   */
  public function next() {
    return $this->__invoke();
  }
  /** 
   * get a previous sequence
   *
   */
  public function previous() {
    return $this->__invoke(true);
  }
}

/**
 * provide functions
 * for last/1 and first/1
 * in a collection subset
 * so example:
 * $calls->find(array("direction" => "in", "state" => "started"))->first()
 *
 * or 
 * $messages->find(array("from" => "+3030202"))
 *          ->find(array("text" => "Hello"))
 *          ->last()
 */
class CollectionSequence extends CollectionObject {
   /**
    * make the data structure according
    * to the type of object then retrieve
    * @param data -> set of refined data
    * @param class -> class object needs to inherit
    */
    public function __construct($data, $class_=__CLASS__)
    {
      $is_object = array_filter($data, "is_object");

      if ($is_object) {
        $this->data = $data;
        $this->class = $class_;
        return;
      }

      $this->data = array();
      $this->class = $class_;

      foreach ($data as $d) {

        $d['quiet'] = TRUE;

        $cname = "Catapult\\" . $this->getName();
        $obj = new $cname;
        $obj->load($d);

        array_push($this->data, $obj);
      }

    }

    /**
     * Usually defined in 
     * child class. When absent
     * resort to class name
     *
     */
    public function getName()
    {
      if ($this->class)
        return $this->class;

      return __CLASS__;
    }

    /**
     * Gets the first item in the
     * sequence.
     */
    public function first()
    {
      if (!(sizeof($this->data) > 0))
        return;

      return $this->data[0];
    }

   /**
    * get the last item in 
    * a sequence.
    */
    public function last()
    {
      if (!(sizeof($this->data) > 0))
        return;

      return $this->data[sizeof($this->data) - 1];
    }
}

/**
 * Represent a of GenericOptions
 * packed as an array each datapacket should have its
 * Schema which is followed and
 * used through the get/add/val methods
 *
 * 
 * DataPacket is no more than a input based convinience
 * that can be serialized into its needed form
 * 
 * @object DataPacket
 */
final class DataPacket extends BaseUtilities {
    private $serialized = false;
    private $is_empty = false;
    private $has_id = false;
    private $dispatched = false;
    private $schema = array();

    /** 
     * A datapacket  needs to 'cast'
     * to string as some paramets
     * maybe of Catapult
     * api type
     *
     * @param $args -> collection of schema data
     */
    public function __construct($args)
    {
      if ($args instanceof Parameters)
        $args = $args->data;

      $this->data = array();

      if (is_string($args)) {
          $this->data = array($args);
          return;
      }

      foreach ($args as $k => $arg)
        if (is_array($arg) || !method_exists($arg, "__toString")) {
          $this->data[$k] = $arg;

        } elseif (isset($arg->merge) && $arg->merge) {
          /**
           * treats a merge
           * all mergers need to
           * provide toArray/1
           */
          $this->data = array_merge($this->data,$arg->toArray());
        } else {
          /**
           * some may serialize later
           * as we don't need to double
           * encode
           */
          if (isset($arg->serialize) 
              && !$arg->serialize) {

            $this->data[$k] = $arg;
          } else {
            $this->data[$k] = (string) $arg;
          }
        }
    }

    /**
     * Get the stored datapacket when
     * this is done the data is considered to be dispatched
     *
     * @param strict -> strict or not if it is
     * data packet cant be retrieved twice.
     */
    public function get($strict=FALSE) 
    {
      if ($strict && $this->dispatched)
        throw new \CatapultApiException("Already got data from packet");    

      $this->dispatched = true;

      if ($this->is_string())
          return $this->data[0];

      return $this->data;
    }

    /** 
     * check for membership in the data
     * additionally chekc both data and data[0]
     * as arguments can be polymorphic
     *
     * @param key -> a key in the data
     */
    public function has($key)
    {
      if (isset($this->data[$key])
         || isset($this->data[0][$key])) {
        return true;
      }

      return  FALSE;
    }

    /**
     * Return a singular
     * value from the data
     * array
     * @param key -> single key [schema]
     */
    public function val($key, $obj=null)
    {
      if (!(isset($this->data[$key])))
        Throw new \CatapultApiException("Key not found in data packet");

      return $this->data[$key];
    }

    /**
     * Set a single key
     * for the schema
     *
     * @param key -> key [within schema]
     * @param val -> val 
     */
    public function add($key, $val)
    {
      if (is_array($key))
        foreach($key as $k)
          $this->data[$k] = $val;
      else
        if (is_array($val))
          $this->data[$key] = $val;
      else
        $this->data[$key] = (string) $val;
    }


    /**
     * Is the data packet empty. If it is throw warning
     * otherwise return false
     */
    public function is_empty()
    {
      if (!(sizeof($this->data) > 0))
        Throw new \CatapultApiException("Packet is empty");

      return FALSE;
    }

    /** is the data one in depth and string **/
    public function is_string()
    {
        return isset($this->data[0]) 
                     && sizeof($this->data) == 1 
                     && is_string($this->data[0]);
    }

    /** 
     * are both arguments strings
     * this is when we get ('str', 'str') 
     * example
     * Gather('call-id', 'gather-id')
     *
     * 
     * todo: simplify move logic into utilities
     * keep it less verbose
     */ 
    public function is_double_string()
    {
        return isset($this->data[0]) 
      && isset($this->data[1]) 
      && sizeof($this->data) == 2 
            && is_string($this->data[0])
            && is_string($this->data[1]);
    }

    /* Check if the given packet has a id. */
    public function has_id()
    {
      if (!isset($data['id']))
        return FALSE;

      return TRUE;
    }


    /**
    * Ready the packet
    * for encoding
    * where encoding
    * should be set to the
    * interop format
    */
    public function __toString()
    {
      return json_encode($this->data);
    }
}

/* Plural form of DataPacket */
final class DataPacketCollection {
    /**
     * parameter MUST be a multi dimensional
     * array. If it isnt return a singular
     * DataPacket and warn if necessary
     *
     * @args: multidimensional array with either datapackets or array
     */
    public function __construct($args) {
      $this->data = array();

      foreach ($args as $arg)
        $this->data[] = new DataPacket($arg);
    }

   /**
    * same as datapacket
    * traverse through all
    * packets and make sure
    * none have been fetched
    * already
    * 
    * @param strict: check for initial dispatch or not
    * @return multidimensional array
    */
    public function get($strict=FALSE)
    {
      $data = array();

      if ($strict && !$this->dispatched)
        foreach ($this->data as $d)
          if ($d->dispatched)
            throw new \CatapultApiException("One of the packets was already dispatched");

      elseif ($strict && $this->dispatched)
        throw new \CatapultApiException("This packet collection was already dispatched");

      foreach ($this->data as $d)
        $data[] = $d->get();

      /* lowercase a state */           
      if (array_key_exists("state", $data)) 
        $data['state'] = strtolower($data['state']);

      $this->dispatched = true;

      return $data;
    }
}

Namespaces

Classes

Interfaces

Exceptions

Functions