iUseAuthentication.php 854 B

1234567891011121314151617181920212223242526272829303132
  1. <?php
  2. namespace Luracast\Restler;
  3. /**
  4. * Api classes or filter classes can implement this interface to know about
  5. * authentication status
  6. *
  7. * @category Framework
  8. * @package Restler
  9. * @author R.Arul Kumaran <arul@luracast.com>
  10. * @copyright 2010 Luracast
  11. * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
  12. * @link http://luracast.com/products/restler/
  13. *
  14. */
  15. interface iUseAuthentication
  16. {
  17. /**
  18. * This method will be called first for filter classes and api classes so
  19. * that they can respond accordingly for filer method call and api method
  20. * calls
  21. *
  22. * @abstract
  23. *
  24. * @param bool $isAuthenticated passes true when the authentication is
  25. * done false otherwise
  26. *
  27. * @return mixed
  28. */
  29. public function __setAuthenticationStatus($isAuthenticated=false);
  30. }