allejo /
PhpPulse
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 30 | class Pulse extends SubscribableObject |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * @ignore |
||
| 34 | */ |
||
| 35 | const API_PREFIX = "pulses"; |
||
| 36 | |||
| 37 | // ================================================================================================================ |
||
| 38 | // Instance Variables |
||
| 39 | // ================================================================================================================ |
||
| 40 | |||
| 41 | /** |
||
| 42 | * The resource's URL. |
||
| 43 | * |
||
| 44 | * @var string |
||
| 45 | */ |
||
| 46 | protected $url; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * The pulse's name. |
||
| 50 | * |
||
| 51 | * @var string |
||
| 52 | */ |
||
| 53 | protected $name; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * The amount of updates a pulse has. |
||
| 57 | * |
||
| 58 | * @var int |
||
| 59 | */ |
||
| 60 | protected $updates_count; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * The ID of the parent board. |
||
| 64 | * |
||
| 65 | * @var int |
||
| 66 | */ |
||
| 67 | protected $board_id; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Creation time. |
||
| 71 | * |
||
| 72 | * @var \DateTime |
||
| 73 | */ |
||
| 74 | protected $created_at; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Last update time. |
||
| 78 | * |
||
| 79 | * @var \DateTime |
||
| 80 | */ |
||
| 81 | protected $updated_at; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * The ID of the group this pulse belongs to |
||
| 85 | * |
||
| 86 | * @var string |
||
| 87 | */ |
||
| 88 | protected $group_id; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * @var PulseColumn[] |
||
| 92 | */ |
||
| 93 | protected $column_structure; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * An array containing all of the values a pulse has for each column |
||
| 97 | * |
||
| 98 | * @var mixed |
||
| 99 | */ |
||
| 100 | protected $raw_column_values; |
||
| 101 | |||
| 102 | /** |
||
| 103 | * An array containing objects extended from PulseColumnValue storing all of the values for each column |
||
| 104 | * |
||
| 105 | * @var array |
||
| 106 | */ |
||
| 107 | protected $column_values; |
||
| 108 | |||
| 109 | /** |
||
| 110 | * The common URL path for retrieving objects relating a pulse such as subscribers, notes, or updates |
||
| 111 | * |
||
| 112 | * @var string |
||
| 113 | */ |
||
| 114 | private $urlSyntax = "%s/%s/%s.json"; |
||
| 115 | |||
| 116 | // ================================================================================================================ |
||
| 117 | // Overloaded functions |
||
| 118 | // ================================================================================================================ |
||
| 119 | |||
| 120 | 33 | protected function initializeValues () |
|
| 121 | { |
||
| 122 | 33 | $this->column_values = []; |
|
| 123 | 33 | $this->column_structure = []; |
|
| 124 | 33 | $this->raw_column_values = []; |
|
| 125 | 33 | } |
|
| 126 | |||
| 127 | // ================================================================================================================ |
||
| 128 | // Getter functions |
||
| 129 | // ================================================================================================================ |
||
| 130 | |||
| 131 | /** |
||
| 132 | * The resource's URL. |
||
| 133 | * |
||
| 134 | * @api |
||
| 135 | * |
||
| 136 | * @since 0.1.0 |
||
| 137 | * |
||
| 138 | * @return string |
||
| 139 | */ |
||
| 140 | 1 | public function getUrl () |
|
| 146 | |||
| 147 | /** |
||
| 148 | * The pulse's name. |
||
| 149 | * |
||
| 150 | * @api |
||
| 151 | * |
||
| 152 | * @since 0.1.0 |
||
| 153 | * |
||
| 154 | * @return string |
||
| 155 | */ |
||
| 156 | 2 | public function getName () |
|
| 162 | |||
| 163 | /** |
||
| 164 | * The amount of updates a pulse has. |
||
| 165 | * |
||
| 166 | * @api |
||
| 167 | * |
||
| 168 | * @since 0.1.0 |
||
| 169 | * |
||
| 170 | * @return int |
||
| 171 | */ |
||
| 172 | 1 | public function getUpdatesCount () |
|
| 178 | |||
| 179 | /** |
||
| 180 | * The ID of the parent board. |
||
| 181 | * |
||
| 182 | * @api |
||
| 183 | * |
||
| 184 | * @since 0.1.0 |
||
| 185 | * |
||
| 186 | * @return int |
||
| 187 | */ |
||
| 188 | 1 | public function getBoardId () |
|
| 194 | |||
| 195 | /** |
||
| 196 | * Creation time. |
||
| 197 | * |
||
| 198 | * @api |
||
| 199 | * |
||
| 200 | * @since 0.1.0 |
||
| 201 | * |
||
| 202 | * @return \DateTime |
||
| 203 | */ |
||
| 204 | 1 | public function getCreatedAt () |
|
| 211 | |||
| 212 | /** |
||
| 213 | * Last update time. |
||
| 214 | * |
||
| 215 | * @api |
||
| 216 | * |
||
| 217 | * @since 0.1.0 |
||
| 218 | * |
||
| 219 | * @return \DateTime |
||
| 220 | */ |
||
| 221 | 3 | public function getUpdatedAt () |
|
| 228 | |||
| 229 | /** |
||
| 230 | * Get the ID of the group this Pulse is a part of. If this value is not available, an API call will be made to |
||
| 231 | * find the group ID via brute force. |
||
| 232 | * |
||
| 233 | * **Note** The group ID is cached if it is not available. To update the cached value, use $forceFetch to force an |
||
| 234 | * API call to get a new value. |
||
| 235 | * |
||
| 236 | * **Warning** An API call is always slower than using the cached value. |
||
| 237 | * |
||
| 238 | * @api |
||
| 239 | * |
||
| 240 | * @param bool $forceFetch Force an API call to get an updated group ID if it has been changed |
||
| 241 | * |
||
| 242 | * @since 0.1.0 |
||
| 243 | * |
||
| 244 | * @return string |
||
| 245 | */ |
||
| 246 | 1 | public function getGroupId ($forceFetch = false) |
|
| 267 | |||
| 268 | // ================================================================================================================ |
||
| 269 | // Pulse functions |
||
| 270 | // ================================================================================================================ |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Edit the name of the pulse |
||
| 274 | * |
||
| 275 | * @api |
||
| 276 | * |
||
| 277 | * @param string $title |
||
| 278 | * |
||
| 279 | * @since 0.1.0 |
||
| 280 | */ |
||
| 281 | 1 | public function editName ($title) |
|
| 291 | |||
| 292 | /** |
||
| 293 | * Archive the current pulse |
||
| 294 | * |
||
| 295 | * This is the equivalent of a soft delete and can be restored from the DaPulse website. |
||
| 296 | * |
||
| 297 | * @api |
||
| 298 | * |
||
| 299 | * @since 0.1.0 |
||
| 300 | */ |
||
| 301 | 1 | public function archivePulse () |
|
| 311 | |||
| 312 | /** |
||
| 313 | * Delete the current Pulse |
||
| 314 | * |
||
| 315 | * @api |
||
| 316 | * |
||
| 317 | * @since 0.1.0 |
||
| 318 | * |
||
| 319 | * @throws InvalidObjectException |
||
| 320 | */ |
||
| 321 | 1 | View Code Duplication | public function deletePulse () |
| 331 | |||
| 332 | public function duplicatePulse ($groupId = null, $ownerId = null) |
||
| 350 | |||
| 351 | View Code Duplication | private function pulseInjection (&$result) |
|
| 360 | |||
| 361 | // ================================================================================================================ |
||
| 362 | // Column data functions |
||
| 363 | // ================================================================================================================ |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Access a color type column value belonging to this pulse in order to read it or modify. |
||
| 367 | * |
||
| 368 | * This function should only be used to access color type values; an exception will be thrown otherwise. |
||
| 369 | * |
||
| 370 | * @api |
||
| 371 | * |
||
| 372 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 373 | * |
||
| 374 | * @since 0.4.0 ColumnNotFoundException will no longer thrown, instead it'll be thrown when getValue() is called |
||
| 375 | * @since 0.1.0 |
||
| 376 | * |
||
| 377 | * @throws InvalidColumnException The specified column is not a "color" type column |
||
| 378 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 379 | * by this library or the DaPulse API. |
||
| 380 | * |
||
| 381 | * @return PulseColumnStatusValue A column object with access to its contents |
||
| 382 | */ |
||
| 383 | public function getStatusColumn ($columnId) |
||
| 384 | { |
||
| 385 | return $this->getColumn($columnId, PulseColumn::Status); |
||
| 386 | } |
||
| 387 | |||
| 388 | /** |
||
| 389 | * Access a date type column value belonging to this pulse in order to read it or modify. |
||
| 390 | * |
||
| 391 | * This function should only be used to access date type values; an exception will be thrown otherwise. |
||
| 392 | * |
||
| 393 | * @api |
||
| 394 | * |
||
| 395 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 396 | * |
||
| 397 | * @since 0.4.0 ColumnNotFoundException will no longer thrown, instead it'll be thrown when getValue() is called |
||
| 398 | * @since 0.1.0 |
||
| 399 | * |
||
| 400 | * @throws InvalidColumnException The specified column is not a "date" type column |
||
| 401 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 402 | * by this library or the DaPulse API. |
||
| 403 | * |
||
| 404 | * @return PulseColumnDateValue A column object with access to its contents |
||
| 405 | */ |
||
| 406 | public function getDateColumn ($columnId) |
||
| 407 | { |
||
| 408 | return $this->getColumn($columnId, PulseColumn::Date); |
||
| 409 | } |
||
| 410 | |||
| 411 | /** |
||
| 412 | * Access a numeric type column value belonging to this pulse in order to read it or modify. |
||
| 413 | * |
||
| 414 | * This function should only be used to access number type values; an exception will be thrown otherwise. |
||
| 415 | * |
||
| 416 | * @api |
||
| 417 | * |
||
| 418 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 419 | * |
||
| 420 | * @since 0.4.0 ColumnNotFoundException will no longer thrown, instead it'll be thrown when getValue() is called |
||
| 421 | * @since 0.2.0 |
||
| 422 | * |
||
| 423 | * @throws InvalidColumnException The specified column is not a "numeric" type column |
||
| 424 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 425 | * by this library or the DaPulse API. |
||
| 426 | * |
||
| 427 | * @return PulseColumnNumericValue A column object with access to its contents |
||
| 428 | */ |
||
| 429 | public function getNumericColumn ($columnId) |
||
| 430 | { |
||
| 431 | return $this->getColumn($columnId, PulseColumn::Numeric); |
||
| 432 | } |
||
| 433 | |||
| 434 | /** |
||
| 435 | * Access a person type column value belonging to this pulse in order to read it or modify. |
||
| 436 | * |
||
| 437 | * This function should only be used to access person type values; an exception will be thrown otherwise. |
||
| 438 | * |
||
| 439 | * @api |
||
| 440 | * |
||
| 441 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 442 | * |
||
| 443 | * @since 0.4.0 ColumnNotFoundException will no longer thrown, instead it'll be thrown when getValue() is called |
||
| 444 | * @since 0.1.0 |
||
| 445 | * |
||
| 446 | * @throws InvalidColumnException The specified column is not a "person" type column |
||
| 447 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 448 | * by this library or the DaPulse API. |
||
| 449 | * |
||
| 450 | * @return PulseColumnPersonValue A column object with access to its contents |
||
| 451 | */ |
||
| 452 | public function getPersonColumn ($columnId) |
||
| 453 | { |
||
| 454 | return $this->getColumn($columnId, PulseColumn::Person); |
||
| 455 | } |
||
| 456 | |||
| 457 | /** |
||
| 458 | * Access a text type column value belonging to this pulse in order to read it or modify. |
||
| 459 | * |
||
| 460 | * This function should only be used to access text type values; an exception will be thrown otherwise. |
||
| 461 | * |
||
| 462 | * @api |
||
| 463 | * |
||
| 464 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 465 | * |
||
| 466 | * @since 0.4.0 ColumnNotFoundException will no longer thrown, instead it'll be thrown when getValue() is called |
||
| 467 | * @since 0.1.0 |
||
| 468 | * |
||
| 469 | * @throws InvalidColumnException The specified column is not a "text" type column |
||
| 470 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 471 | * by this library or the DaPulse API. |
||
| 472 | * |
||
| 473 | * @return PulseColumnTextValue A column object with access to its contents |
||
| 474 | */ |
||
| 475 | public function getTextColumn ($columnId) |
||
| 476 | { |
||
| 477 | return $this->getColumn($columnId, PulseColumn::Text); |
||
| 478 | } |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Access a timeline type column value belonging to this pulse in order to read it or modify. |
||
| 482 | * |
||
| 483 | * This function should only be used to access timeline type values; an exception will be thrown otherwise. |
||
| 484 | * |
||
| 485 | * @api |
||
| 486 | * |
||
| 487 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column name |
||
| 488 | * |
||
| 489 | * @since 0.2.1 |
||
| 490 | * |
||
| 491 | * @throws ColumnNotFoundException The specified column ID does not exist for this Pulse |
||
| 492 | * @throws InvalidColumnException The specified column is not a "numeric" type column |
||
| 493 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 494 | * by this library or the DaPulse API. |
||
| 495 | * |
||
| 496 | * @return PulseColumnTimelineValue A column object with access to its contents |
||
| 497 | */ |
||
| 498 | public function getTimelineColumn ($columnId) |
||
| 499 | { |
||
| 500 | return $this->getColumn($columnId, PulseColumn::Timeline); |
||
| 501 | } |
||
| 502 | |||
| 503 | /** |
||
| 504 | * Access a column belonging to this pulse in order to read it or modify it. |
||
| 505 | * |
||
| 506 | * @api |
||
| 507 | * |
||
| 508 | * @param string $columnId The ID of the column to access. This is typically a slugified version of the column |
||
| 509 | * title |
||
| 510 | * @param string $columnType The type of column being accessed. **Only** use available constants or PulseColumn::getType() |
||
| 511 | * |
||
| 512 | * @see PulseColumn::Date |
||
| 513 | * @see PulseColumn::Numeric |
||
| 514 | * @see PulseColumn::Person |
||
| 515 | * @see PulseColumn::Status |
||
| 516 | * @see PulseColumn::Text |
||
| 517 | * @see PulseColumn::Timeline |
||
| 518 | * @see PulseColumnDateValue |
||
| 519 | * @see PulseColumnNumericValue |
||
| 520 | * @see PulseColumnPersonValue |
||
| 521 | * @see PulseColumnStatusValue |
||
| 522 | * @see PulseColumnTextValue |
||
| 523 | * @see PulseColumnTimelineValue |
||
| 524 | * |
||
| 525 | * @since 0.3.1 |
||
| 526 | * |
||
| 527 | * @throws InvalidColumnException The specified column is not the same type as specified in `$columnType` |
||
| 528 | * @throws InvalidObjectException The specified column exists but modification of its value is unsupported either |
||
| 529 | * by this library or the DaPulse API. |
||
| 530 | * |
||
| 531 | * @return mixed Returns an instance of an object extending the PulseColumnValue class |
||
| 532 | */ |
||
| 533 | public function getColumn ($columnId, $columnType) |
||
| 534 | { |
||
| 535 | if (!isset($this->column_values) || !array_key_exists($columnId, $this->column_values)) |
||
| 536 | { |
||
| 537 | $key = ArrayUtilities::array_search_column($this->raw_column_values, 'cid', $columnId); |
||
| 538 | $data = []; |
||
| 539 | |||
| 540 | // We can't find the key, this means that we got our information from accessing a Pulse directly instead of |
||
| 541 | // getting it through a PulseBoard. This isn't as robust as accessing a PulseBoard but it's more efficient. |
||
| 542 | // We make a separate API call to get the value of a column. |
||
| 543 | if ($key !== false) |
||
| 544 | { |
||
| 545 | $data = $this->raw_column_values[$key]; |
||
| 546 | $type = $this->column_structure[$key]->getType(); |
||
| 547 | |||
| 548 | if ($type !== $columnType) |
||
| 549 | { |
||
| 550 | throw new InvalidColumnException("The '$columnId' column was expected to be '$columnType' but was '$type' instead."); |
||
| 551 | } |
||
| 552 | } |
||
| 553 | |||
| 554 | $data['column_id'] = $columnId; |
||
| 555 | $data['board_id'] = $this->getBoardId(); |
||
| 556 | $data['pulse_id'] = $this->getId(); |
||
| 557 | |||
| 558 | $this->column_values[$columnId] = PulseColumnValue::_createColumnType($columnType, $data); |
||
| 559 | } |
||
| 560 | |||
| 561 | return $this->column_values[$columnId]; |
||
| 562 | } |
||
| 563 | |||
| 564 | // ================================================================================================================ |
||
| 565 | // Notes functions |
||
| 566 | // ================================================================================================================ |
||
| 567 | |||
| 568 | /** |
||
| 569 | * Create a new note in this project |
||
| 570 | * |
||
| 571 | * @api |
||
| 572 | * |
||
| 573 | * @param string $title The title of the note |
||
| 574 | * @param string $content The body of the note |
||
| 575 | * @param bool $ownersOnly Set to true if only pulse owners can edit this note. |
||
| 576 | * @param int|null $user The id of the user to be marked as the note's last updater |
||
| 577 | * @param bool $createUpdate Indicates whether to create an update on the pulse notifying subscribers on the |
||
| 578 | * changes (required user_id to be set). |
||
| 579 | * |
||
| 580 | * @throws \InvalidArgumentException if $createUpdate is true and $user is null or $user is not a valid user ID or |
||
| 581 | * PulseUser object |
||
| 582 | * |
||
| 583 | * @since 0.1.0 |
||
| 584 | * |
||
| 585 | * @return PulseNote |
||
| 586 | */ |
||
| 587 | public function addNote ($title, $content, $ownersOnly = false, $user = null, $createUpdate = false) |
||
| 588 | { |
||
| 589 | $url = sprintf($this->urlSyntax, self::apiEndpoint(), $this->id, "notes"); |
||
| 590 | $postParams = [ |
||
| 591 | "id" => $this->id, |
||
| 592 | "title" => $title, |
||
| 593 | "content" => $content, |
||
| 594 | "owners_only" => $ownersOnly, |
||
| 595 | "create_update" => $createUpdate |
||
| 596 | ]; |
||
| 597 | |||
| 598 | if (!is_null($user)) |
||
| 599 | { |
||
| 600 | $user = PulseUser::_castToInt($user); |
||
| 601 | } |
||
| 602 | |||
| 603 | self::setIfNotNullOrEmpty($postParams, 'user_id', $user); |
||
| 604 | |||
| 605 | if ($createUpdate && is_null($user)) |
||
| 606 | { |
||
| 607 | throw new \InvalidArgumentException("The user_id value must be set if an update is to be created"); |
||
| 608 | } |
||
| 609 | |||
| 610 | $noteResult = self::sendPost($url, $postParams); |
||
| 611 | |||
| 612 | return (new PulseNote($noteResult)); |
||
| 613 | } |
||
| 614 | |||
| 615 | /** |
||
| 616 | * Return all of the notes belonging to this project |
||
| 617 | * |
||
| 618 | * @api |
||
| 619 | * |
||
| 620 | * @since 0.1.0 |
||
| 621 | * |
||
| 622 | * @return PulseNote[] |
||
| 623 | */ |
||
| 624 | public function getNotes () |
||
| 630 | |||
| 631 | // ================================================================================================================ |
||
| 632 | // Updates functions |
||
| 633 | // ================================================================================================================ |
||
| 634 | |||
| 635 | /** |
||
| 636 | * Get all of the updates that belong to this Pulse in reverse chronological order |
||
| 637 | * |
||
| 638 | * @api |
||
| 639 | * |
||
| 640 | * @since 0.1.0 |
||
| 641 | * |
||
| 642 | * @return PulseUpdate[] |
||
| 643 | */ |
||
| 644 | 22 | public function getUpdates () |
|
| 650 | |||
| 651 | /** |
||
| 652 | * Create an update for the current Pulse |
||
| 653 | * |
||
| 654 | * @api |
||
| 655 | * |
||
| 656 | * @param int|PulseUser $user |
||
| 657 | * @param string $text |
||
| 658 | * @param null|bool $announceToAll |
||
| 659 | * |
||
| 660 | * @since 0.3.0 A PulseUpdate object is returned containing the information of the newly created Update |
||
| 661 | * @since 0.1.0 |
||
| 662 | * |
||
| 663 | * @return PulseUpdate |
||
| 664 | */ |
||
| 665 | 2 | public function createUpdate ($user, $text, $announceToAll = null) |
|
| 669 | |||
| 670 | // ================================================================================================================ |
||
| 671 | // Static functions |
||
| 672 | // ================================================================================================================ |
||
| 673 | |||
| 674 | /** |
||
| 675 | * Get all of the pulses that belong to the organization across all boards. |
||
| 676 | * |
||
| 677 | * To modify the amount of data returned with pagination, use the following values in the array to configure your |
||
| 678 | * pagination or offsets. |
||
| 679 | * |
||
| 680 | * ```php |
||
| 681 | * $params = array( |
||
| 682 | * "page" => 1, // (int) Page offset to fetch |
||
| 683 | * "per_page" => 10, // (int) Number of results per page |
||
| 684 | * "offset" => 5, // (int) Instead of starting at result 0, start counting from result 5 |
||
| 685 | * "order_by_latest" => true // (bool) Order the pulses with the most recent first |
||
| 686 | * ); |
||
| 687 | * ``` |
||
| 688 | * |
||
| 689 | * @api |
||
| 690 | * |
||
| 691 | * @param array $params GET parameters passed to with the query to modify the data returned. |
||
| 692 | * |
||
| 693 | * @since 0.1.0 |
||
| 694 | * |
||
| 695 | * @return Pulse[] |
||
| 696 | */ |
||
| 697 | public static function getPulses ($params = []) |
||
| 703 | } |
||
| 704 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..