Làm cách nào để ghi lại tham số mong đợi hằng số

Question

Cách được khuyến nghị để ghi lại các tham số hàm hoặc phương thức có giá trị được mong đợi là hằng số được xác định trước là gì? Cho đến nay, tôi sử dụng kiểu dữ liệu của hằng số và tôi thêm một chút giải thích sau.

Ví dụ:

<?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){ 
     // ... 
    } 
} 

Answer 1

Cho rằng bạn có thể sử dụng một lớp gọi là dataype trong các thẻ param và return, tôi cũng hy vọng rằng bạn có thể sử dụng một hằng số đã biết. Khi bạn muốn chỉ định nhiều tùy chọn loại, bạn chỉ cần phân tách danh sách bằng các đường ống. Sửa đổi ví dụ của bạn:

/** 
* Load a new foo 
* 
* @param Foo::METHOD_GET|Foo::METHOD_POST $method HTTP method to use 
*/ 
public function load($method=Foo::METHOD_POST){ 
    // ... 
} 

Kể từ khi datatype trong trường hợp này là một tiếng nội-to-the-class giá trị, nó thậm chí có thể làm việc mà không có tiền tố classname:

* @param METHOD_GET|METHOD_POST $method HTTP method to use 

Answer 2

Here tìm thấy thông tin về làm thế nào để ghi lại liên tục sử dụng PHPDoc

const/xác định nghĩa như nhau trong php