[DomCrawler] fixed phpdoc

This commit is contained in:
Pascal Borreli 2010-04-20 00:29:58 +00:00 committed by Fabien Potencier
parent 72fe9fa52f
commit 5b8a88476b
6 changed files with 29 additions and 1 deletions

View File

@ -292,6 +292,8 @@ class Crawler extends \SplObjectStorage
* Returns the siblings nodes of the current selection * Returns the siblings nodes of the current selection
* *
* @return Crawler A Crawler instance with the sibling nodes * @return Crawler A Crawler instance with the sibling nodes
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function siblings() public function siblings()
{ {
@ -307,6 +309,8 @@ class Crawler extends \SplObjectStorage
* Returns the next siblings nodes of the current selection * Returns the next siblings nodes of the current selection
* *
* @return Crawler A Crawler instance with the next sibling nodes * @return Crawler A Crawler instance with the next sibling nodes
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function nextAll() public function nextAll()
{ {
@ -337,6 +341,8 @@ class Crawler extends \SplObjectStorage
* Returns the parents nodes of the current selection * Returns the parents nodes of the current selection
* *
* @return Crawler A Crawler instance with the parents nodes of the current selection * @return Crawler A Crawler instance with the parents nodes of the current selection
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function parents() public function parents()
{ {
@ -362,7 +368,9 @@ class Crawler extends \SplObjectStorage
/** /**
* Returns the children nodes of the current selection * Returns the children nodes of the current selection
* *
* @return Crawler A Crawler instance with the chidren nodes * @return Crawler A Crawler instance with the children nodes
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function children() public function children()
{ {
@ -380,6 +388,8 @@ class Crawler extends \SplObjectStorage
* @param string $attribute The attribute name * @param string $attribute The attribute name
* *
* @return string The attribute value * @return string The attribute value
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function attr($attribute) public function attr($attribute)
{ {
@ -395,6 +405,8 @@ class Crawler extends \SplObjectStorage
* Returns the node value of the first node of the list. * Returns the node value of the first node of the list.
* *
* @return string The node value * @return string The node value
*
* @throws \InvalidArgumentException When current node is empty
*/ */
public function text() public function text()
{ {

View File

@ -46,6 +46,8 @@ class ChoiceFormField extends FormField
* Sets the value of the field. * Sets the value of the field.
* *
* @param string $value The value of the field * @param string $value The value of the field
*
* @throws \InvalidArgumentException When value type provided is not correct
*/ */
public function setValue($value) public function setValue($value)
{ {
@ -103,6 +105,8 @@ class ChoiceFormField extends FormField
* This method should only be used internally. * This method should only be used internally.
* *
* @param \DOMNode $node A \DOMNode * @param \DOMNode $node A \DOMNode
*
* @throws \LogicException When choice provided is not multiple nor radio
*/ */
public function addChoice(\DOMNode $node) public function addChoice(\DOMNode $node)
{ {
@ -141,6 +145,8 @@ class ChoiceFormField extends FormField
/** /**
* Initializes the form field. * Initializes the form field.
*
* @throws \LogicException When node type is incorrect
*/ */
protected function initialize() protected function initialize()
{ {

View File

@ -24,6 +24,8 @@ class FileFormField extends FormField
* Sets the PHP error code associated with the field. * Sets the PHP error code associated with the field.
* *
* @param integer $error The error code (one of UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE, UPLOAD_ERR_PARTIAL, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_NO_TMP_DIR, UPLOAD_ERR_CANT_WRITE, or UPLOAD_ERR_EXTENSION) * @param integer $error The error code (one of UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE, UPLOAD_ERR_PARTIAL, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_NO_TMP_DIR, UPLOAD_ERR_CANT_WRITE, or UPLOAD_ERR_EXTENSION)
*
* @throws \InvalidArgumentException When error code doesn't exist
*/ */
public function setErrorCode($error) public function setErrorCode($error)
{ {
@ -60,6 +62,8 @@ class FileFormField extends FormField
/** /**
* Initializes the form field. * Initializes the form field.
*
* @throws \LogicException When node type is incorrect
*/ */
protected function initialize() protected function initialize()
{ {

View File

@ -25,6 +25,8 @@ class InputFormField extends FormField
{ {
/** /**
* Initializes the form field. * Initializes the form field.
*
* @throws \LogicException When node type is incorrect
*/ */
protected function initialize() protected function initialize()
{ {

View File

@ -22,6 +22,8 @@ class TextareaFormField extends FormField
{ {
/** /**
* Initializes the form field. * Initializes the form field.
*
* @throws \LogicException When node type is incorrect
*/ */
protected function initialize() protected function initialize()
{ {

View File

@ -273,6 +273,8 @@ class Form
* @param string $name The field name * @param string $name The field name
* *
* @return Field\FormField The field instance * @return Field\FormField The field instance
*
* @throws \InvalidArgumentException When field is not present in this form
*/ */
public function getField($name) public function getField($name)
{ {