什么是记录其值预期为预定义常量的函数或方法参数的推荐方法?到目前为止,我使用常量的数据类型,稍后我会添加一些解释.
例如.:
<?PHP class Foo{ const METHOD_GET = 'get'; const METHOD_POST = 'post'; /** * Load a new foo * * @param string $method HTTP method to use (either Foo::METHOD_GET or Foo::METHOD_POST) */ public function load($method=Foo::METHOD_POST){ // ... } /** * Sort current foo * * @param int $sort_order Sort order (either SORT_ASC or SORT_DESC) */ public function sort($sort_order=SORT_ASC){ // ... } }
鉴于您可以使用已知类作为param和return标记中的dataype,我还希望您可以使用已知常量.如果要指定多个类型选项,只需使用管道分隔列表即可.修改你的例子:
/** * Load a new foo * * @param Foo::METHOD_GET|Foo::METHOD_POST $method HTTP method to use */ public function load($method=Foo::METHOD_POST){ // ... }
由于这种情况下的数据类型是已知的内部到类值,因此它甚至可以在没有classname前缀的情况下工作:
* @param METHOD_GET|METHOD_POST $method HTTP method to use