apigroupismember.php 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. <?php
  2. /**
  3. * StatusNet, the distributed open-source microblogging tool
  4. *
  5. * Check to see whether a user a member of a group
  6. *
  7. * PHP version 5
  8. *
  9. * LICENCE: This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as published by
  11. * the Free Software Foundation, either version 3 of the License, or
  12. * (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. * @category API
  23. * @package StatusNet
  24. * @author Craig Andrews <candrews@integralblue.com>
  25. * @author Evan Prodromou <evan@status.net>
  26. * @author Jeffery To <jeffery.to@gmail.com>
  27. * @author Zach Copley <zach@status.net>
  28. * @copyright 2009 StatusNet, Inc.
  29. * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31. * @link http://status.net/
  32. */
  33. if (!defined('STATUSNET')) {
  34. exit(1);
  35. }
  36. /**
  37. * Returns whether a user is a member of a specified group.
  38. *
  39. * @category API
  40. * @package StatusNet
  41. * @author Craig Andrews <candrews@integralblue.com>
  42. * @author Evan Prodromou <evan@status.net>
  43. * @author Jeffery To <jeffery.to@gmail.com>
  44. * @author Zach Copley <zach@status.net>
  45. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46. * @link http://status.net/
  47. */
  48. class ApiGroupIsMemberAction extends ApiBareAuthAction
  49. {
  50. var $group = null;
  51. /**
  52. * Take arguments for running
  53. *
  54. * @param array $args $_REQUEST args
  55. *
  56. * @return boolean success flag
  57. */
  58. protected function prepare(array $args=array())
  59. {
  60. parent::prepare($args);
  61. $this->target = $this->getTargetProfile(null);
  62. $this->group = $this->getTargetGroup(null);
  63. return true;
  64. }
  65. /**
  66. * Handle the request
  67. *
  68. * Save the new message
  69. *
  70. * @return void
  71. */
  72. protected function handle()
  73. {
  74. parent::handle();
  75. if (empty($this->target)) {
  76. // TRANS: Client error displayed when checking group membership for a non-existing user.
  77. $this->clientError(_('No such user.'), 404);
  78. }
  79. if (empty($this->group)) {
  80. // TRANS: Client error displayed when checking group membership for a non-existing group.
  81. $this->clientError(_('Group not found.'), 404);
  82. }
  83. $is_member = $this->target->isMember($this->group);
  84. switch($this->format) {
  85. case 'xml':
  86. $this->initDocument('xml');
  87. $this->element('is_member', null, $is_member);
  88. $this->endDocument('xml');
  89. break;
  90. case 'json':
  91. $this->initDocument('json');
  92. $this->showJsonObjects(array('is_member' => $is_member));
  93. $this->endDocument('json');
  94. break;
  95. default:
  96. // TRANS: Client error displayed when coming across a non-supported API method.
  97. $this->clientError(_('API method not found.'));
  98. }
  99. }
  100. /**
  101. * Return true if read only.
  102. *
  103. * MAY override
  104. *
  105. * @param array $args other arguments
  106. *
  107. * @return boolean is read only action?
  108. */
  109. function isReadOnly($args)
  110. {
  111. return true;
  112. }
  113. }