Рестлер, не требующий обязательных свойств

У меня есть это для моего класса объектов и класса API. Я могу позвонить по почте, не отправляя task_list_id или display_order. Пока я просто передаю title, он вызывает метод.

class BaseTaskObj
{   
  /// @var int    $task_list_id   The SQL ident of the Task List to use for the Task. {@min 1}{@required true}
  public $task_list_id;
}

class PostTaskObj extends BaseTaskObj
{
  /// @var int    $assigned_id    The SQL ident of the Person who this task is assigned to {@min 1}{@required false}
  public $assigned_id;
}

class MyTaskAPI {
  /**
   * Creates a new Task associated with an existing task list.
   *
   * @param PostTaskObj $info The details of the Task object to create. {@required title, display_order}
   *
   * @status 201
   *
   * @return int The SQL ident of the newly created Task
   */
   function post(PostTaskObj $info) {
   }  
}

person Gargoyle    schedule 02.02.2017    source источник
comment
Если вы знаете правильный синтаксис комментариев к документам, почему вы их не используете?   -  person Arul Kumaran    schedule 03.02.2017
comment
Потому что, насколько мне известно, я использую их.   -  person Gargoyle    schedule 03.02.2017
comment
См. phpdoc.org/docs/latest/references/phpdoc/tags/var. .html также обратите внимание, что рестлер не поддерживает compound statements, как в примере 2.   -  person Arul Kumaran    schedule 03.02.2017


Ответы (1)


task_list_id и assigned_id в настоящее время не имеют действительных комментариев phpdoc. Они также не имеют никакого присвоенного значения. Это делает их необходимыми параметрами для вызова API.

Но тогда у вас есть {@required title, display_order}, который перезаписывает требуемый список недопустимыми параметрами, делая их ненужными.

person Arul Kumaran    schedule 03.02.2017
comment
Простите, как у них нет комментариев? Я дал тип, имя переменной, описание и т.д. - person Gargoyle; 03.02.2017
comment
Чтобы не усложнять вопрос, я не показывал ВСЕ свойства в примерах классов. Я должен был сказать это в вопросе. - person Gargoyle; 03.02.2017
comment
Затем убедитесь, что вы отредактировали то, что публикуете здесь, в качестве рабочего примера для вашего случая. - person Arul Kumaran; 03.02.2017
comment
Ваши комментарии начинаются с ///, что не является допустимым началом комментария к документу. См. ссылку, которую я дал в комментарии к вопросу о допустимом синтаксисе. - person Arul Kumaran; 03.02.2017
comment
Таким образом, Рестлер не принимает синтаксис однострочных комментариев, который показан в ссылке, которую вы мне предоставили. Когда я сделал его многострочной версией, он начал работать правильно. - person Gargoyle; 03.02.2017