ParameterDescriptor.php 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. <?php
  2. /**
  3. * This file is part of amfPHP
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the license that is bundled
  8. * with this package in the file license.txt.
  9. */
  10. /**
  11. * Contains all collected information about a service method parameter
  12. *
  13. * @author Ariel Sommeria-klein
  14. * @package Amfphp_Plugins_Discovery
  15. */
  16. class AmfphpDiscovery_ParameterDescriptor {
  17. /**
  18. * name
  19. * @var string
  20. */
  21. public $name;
  22. /**
  23. * This can be gathered in 2 manners: commentary tag analysis and type hinting analysis.
  24. * @var String
  25. */
  26. public $type;
  27. /**
  28. * This can be gathered by commentary tag analysis. It should be in json format so that it can be used by the service browser.
  29. * This is an example tag @param object obj This is a really important object. example: {"key":"value"}
  30. * @var string
  31. */
  32. public $example;
  33. /**
  34. * @todo
  35. * @var Boolean
  36. */
  37. //public $isOptional;
  38. /**
  39. * constructor
  40. * @param String $name
  41. * @param String $type
  42. */
  43. public function __construct($name, $type, $example) {
  44. $this->name = $name;
  45. $this->type = $type;
  46. $this->example = $example;
  47. }
  48. }
  49. ?>