|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright 2014 Facebook, Inc. |
| 4 | + * |
| 5 | + * You are hereby granted a non-exclusive, worldwide, royalty-free license to |
| 6 | + * use, copy, modify, and distribute this software in source code or binary |
| 7 | + * form for use in connection with the web services and APIs provided by |
| 8 | + * Facebook. |
| 9 | + * |
| 10 | + * As with any software that integrates with the Facebook platform, your use |
| 11 | + * of this software is subject to the Facebook Developer Principles and |
| 12 | + * Policies [http://developers.facebook.com/policy/]. This copyright notice |
| 13 | + * shall be included in all copies or substantial portions of the software. |
| 14 | + * |
| 15 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 18 | + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 19 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 20 | + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 21 | + * DEALINGS IN THE SOFTWARE. |
| 22 | + * |
| 23 | + */ |
| 24 | + |
| 25 | +namespace FacebookAds\Object; |
| 26 | + |
| 27 | +use FacebookAds\Api; |
| 28 | + |
| 29 | +abstract class AbstractArchivableCrudObject extends AbstractCrudObject { |
| 30 | + |
| 31 | + /** |
| 32 | + * @var string |
| 33 | + */ |
| 34 | + const STATUS_DELETED = 'DELETED'; |
| 35 | + |
| 36 | + /** |
| 37 | + * @var string |
| 38 | + */ |
| 39 | + const STATUS_ARCHIVED = 'ARCHIVED'; |
| 40 | + |
| 41 | + /** |
| 42 | + * @return string |
| 43 | + */ |
| 44 | + public abstract function getStatusFieldName(); |
| 45 | + |
| 46 | + /** |
| 47 | + * Archive this object |
| 48 | + * |
| 49 | + * @param array $params |
| 50 | + * @return void |
| 51 | + */ |
| 52 | + public function archive(array $params = array()) { |
| 53 | + $this->getApi()->call( |
| 54 | + $this->getNodePath(), |
| 55 | + Api::HTTP_METHOD_POST, |
| 56 | + array_merge($params, array( |
| 57 | + $this->getStatusFieldName() => static::STATUS_ARCHIVED))); |
| 58 | + } |
| 59 | + |
| 60 | + /** |
| 61 | + * Delete this object |
| 62 | + * |
| 63 | + * @param array $params |
| 64 | + * @return void |
| 65 | + */ |
| 66 | + public function delete(array $params = array()) { |
| 67 | + $this->getApi()->call( |
| 68 | + $this->getNodePath(), |
| 69 | + Api::HTTP_METHOD_POST, |
| 70 | + array_merge($params, array( |
| 71 | + $this->getStatusFieldName() => static::STATUS_DELETED))); |
| 72 | + } |
| 73 | +} |
0 commit comments