identifiertrait.php 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. <?php
  2. /**
  3. * @author Robin McCorkell <rmccorkell@owncloud.com>
  4. *
  5. * @copyright Copyright (c) 2015, ownCloud, Inc.
  6. * @license AGPL-3.0
  7. *
  8. * This code is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU Affero General Public License, version 3,
  10. * as published by the Free Software Foundation.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU Affero General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Affero General Public License, version 3,
  18. * along with this program. If not, see <http://www.gnu.org/licenses/>
  19. *
  20. */
  21. namespace OCA\Files_External\Lib;
  22. /**
  23. * Trait for objects requiring an identifier (and/or identifier aliases)
  24. */
  25. trait IdentifierTrait {
  26. /** @var string */
  27. protected $identifier;
  28. /** @var string[] */
  29. protected $identifierAliases = [];
  30. /**
  31. * @return string
  32. */
  33. public function getIdentifier() {
  34. return $this->identifier;
  35. }
  36. /**
  37. * @param string $identifier
  38. * @return self
  39. */
  40. public function setIdentifier($identifier) {
  41. $this->identifier = $identifier;
  42. $this->identifierAliases[] = $identifier;
  43. return $this;
  44. }
  45. /**
  46. * @return string[]
  47. */
  48. public function getIdentifierAliases() {
  49. return $this->identifierAliases;
  50. }
  51. /**
  52. * @param string $alias
  53. * @return self
  54. */
  55. public function addIdentifierAlias($alias) {
  56. $this->identifierAliases[] = $alias;
  57. return $this;
  58. }
  59. }