From 2c487165fe31d250149e4d016d2ef4f23dcbe51d Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Mon, 27 Dec 2004 16:12:48 +0000 Subject: [PATCH] Document DOMElement::xx(), describe parameters, return value, added see also.. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175682 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/dom-domelement-getattribute.xml | 80 ++++++++---- .../dom-domelement-getattributenode.xml | 78 ++++++++---- .../dom-domelement-getattributenodens.xml | 92 +++++++++----- .../dom-domelement-getattributens.xml | 91 +++++++++----- .../dom-domelement-getelementsbytagname.xml | 80 ++++++++---- .../dom-domelement-getelementsbytagnamens.xml | 91 +++++++++----- .../functions/dom-domelement-hasattribute.xml | 76 ++++++++---- .../dom-domelement-hasattributens.xml | 90 ++++++++++---- .../dom-domelement-removeattribute.xml | 82 +++++++++---- .../dom-domelement-removeattributenode.xml | 84 +++++++++---- .../dom-domelement-removeattributens.xml | 94 +++++++++++---- .../functions/dom-domelement-setattribute.xml | 114 ++++++++++++------ .../dom-domelement-setattributenode.xml | 83 +++++++++---- .../dom-domelement-setattributenodens.xml | 83 +++++++++---- .../dom-domelement-setattributens.xml | 109 ++++++++++++----- 15 files changed, 929 insertions(+), 398 deletions(-) diff --git a/reference/dom/functions/dom-domelement-getattribute.xml b/reference/dom/functions/dom-domelement-getattribute.xml index 4127567d61..3b14630e82 100644 --- a/reference/dom/functions/dom-domelement-getattribute.xml +++ b/reference/dom/functions/dom-domelement-getattribute.xml @@ -1,30 +1,58 @@ - - - - DOMElement->getAttribute - Returns value of attribute - - - &reftitle.description; - - DOMElement - - string - getAttribute - stringname - - - - Returns the value of the attribute with name name - for the current node. If no attribute with given name is found, an empty - string is returned. - - - See also DOMElement->setAttribute() - - - + + + + DOMElement->getAttribute() + Returns value of attribute + + + &reftitle.description; + + DOMElement + + string + getAttribute + stringname + + + + Gets the value of the attribute with name name + for the current node. + + + + &reftitle.parameters; + + + + name + + + The name of the attribute. + + + + + + + + &reftitle.returnvalues; + + The value of the attribute, or an empty string if no attribute with the + given name is found. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->getAttributeNode - Returns attribute node - - - &reftitle.description; - - DOMElement - - DOMAttr - getAttributeNode - stringname - - - - Returns the attribute node with name name for the - current element. - - - See also DOMElement->setAttribute() - - - + + + + DOMElement->getAttributeNode() + Returns attribute node + + + &reftitle.description; + + DOMElement + + DOMAttr + getAttributeNode + stringname + + + + Returns the attribute node with name name for the + current element. + + + + &reftitle.parameters; + + + + name + + + The name of the attribute. + + + + + + + + &reftitle.returnvalues; + + The attribute node. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->getAttributeNodeNS - - Returns attribute node - - - - &reftitle.description; - - DOMElement - - DOMAttr - getAttributeNodeNS - stringnamespaceURI - stringlocalName - - - - Returns the attribute node in namespace namespaceURI - with local name localName for the current node. - - - See also DOMElement->setAttributeNodeNS() - - - + + + + DOMElement->getAttributeNodeNS() + + Returns attribute node + + + + &reftitle.description; + + DOMElement + + DOMAttr + getAttributeNodeNS + stringnamespaceURI + stringlocalName + + + + Returns the attribute node in namespace namespaceURI + with local name localName for the current node. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + localName + + + The local name. + + + + + + + + &reftitle.returnvalues; + + The attribute node. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->getAttributeNS - Returns value of attribute - - - &reftitle.description; - - DOMElement - - string - getAttributeNS - stringnamespaceURI - stringlocalName - - - - Returns the value of the attribute in namespace namespaceURI - with local name localName for the current node. - If no attribute with given name is found, an empty string is returned. - - - See also DOMElement->setAttributeNS() - - - + + + + DOMElement->getAttributeNS() + Returns value of attribute + + + &reftitle.description; + + DOMElement + + string + getAttributeNS + stringnamespaceURI + stringlocalName + + + + Gets the value of the attribute in namespace namespaceURI + with local name localName for the current node. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + localName + + + The local name. + + + + + + + + &reftitle.returnvalues; + + The value of the attribute, or an empty string if no attribute with the + given localName and namespaceURI + is found. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->getElementsByTagName - Gets elements by tagname - - - &reftitle.description; - - DOMElement - - DOMNodeList - getElementsByTagName - stringname - - - - This function returns a new instance of the class - DOMNodeList of all descendant elements with a - given tag name, in the order in which they are - encountered in a preorder traversal of this element tree. Use "*" as - parameter to return all elements within the element tree. - - - + + + + DOMElement->getElementsByTagName() + Gets elements by tagname + + + &reftitle.description; + + DOMElement + + DOMNodeList + getElementsByTagName + stringname + + + + This function returns a new instance of the class + DOMNodeList of all descendant elements with a + given tag name, in the order in which they are + encountered in a preorder traversal of this element tree. + + + + &reftitle.parameters; + + + + name + + + The tag name. Use * to return all elements within + the element tree. + + + + + + + + &reftitle.returnvalues; + + This function returns a new instance of the class + DOMNodeList of all matched elements. + + + + &reftitle.seealso; + + + + + + + - - - DOMElement->getElementsByTagNameNS - Get elements by namespaceURI and localName - - - &reftitle.description; - - DOMElement - - DOMNodeList - getElementsByTagNameNS - stringnamespaceURI - stringlocalName - - - - This function returns a new instance of the class - DOMNodeList, which lists all the descendant - elements with a given localName and - namespaceURI in the order in which they are - encountered in a preorder traversal of this element tree. - Use "*" for the local name to return all elements within the element - tree. - - - + + + + DOMElement->getElementsByTagNameNS() + Get elements by namespaceURI and localName + + + &reftitle.description; + + DOMElement + + DOMNodeList + getElementsByTagNameNS + stringnamespaceURI + stringlocalName + + + + This function fetch all the descendant elements with a given + localName and namespaceURI. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + localName + + + The local name. Use * to return all elements within + the element tree. + + + + + + + + &reftitle.returnvalues; + + This function returns a new instance of the class + DOMNodeList of all matched elements in the order in + which they are encountered in a preorder traversal of this element tree. + + + + &reftitle.seealso; + + + + + + + - - - DOMElement->hasAttribute - Checks to see if attribute exists - - - &reftitle.description; - - DOMElement - - bool - hasAttribute - stringname - - - - Indicates whether attribute named name - exists as a member of the element. - - - + + + + DOMElement->hasAttribute() + Checks to see if attribute exists + + + &reftitle.description; + + DOMElement + + bool + hasAttribute + stringname + + + + Indicates whether attribute named name + exists as a member of the element. + + + + &reftitle.parameters; + + + + name + + + The attribute name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + + + + + + + + - - - DOMElement->hasAttributeNS - - Checks to see if attribute exists - - - - &reftitle.description; - - DOMElement - - bool - hasAttributeNS - stringnamespaceURI - stringlocalName - - - - Indicates whether attribute in namespace namespaceURI - named localName exists as a member of the element. - - - + + + + DOMElement->hasAttributeNS() + + Checks to see if attribute exists + + + + &reftitle.description; + + DOMElement + + bool + hasAttributeNS + stringnamespaceURI + stringlocalName + + + + Indicates whether attribute in namespace namespaceURI + named localName exists as a member of the element. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + localName + + + The local name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.seealso; + + + + + + + + + + - - - DOMElement->removeAttribute - Removes attribute - - - &reftitle.description; - - DOMElement - - bool - removeAttribute - stringname - - - - Removes attribute named name from the element. - - - Throws DOMException if node cannot be modified. - - - + + + + DOMElement->removeAttribute() + Removes attribute + + + &reftitle.description; + + DOMElement + + bool + removeAttribute + stringname + + + + Removes attribute named name from the element. + + + + &reftitle.parameters; + + + + name + + + The name of the attribute. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->removeAttributeNode - Removes attribute - - - &reftitle.description; - - DOMElement - - bool - removeAttribute - DOMAttroldnode - - - - Removes attribute oldnode from the element. - - - Throws DOMException if node cannot be modified or - attribute is not a member of the element node. - - - + + + + DOMElement->removeAttributeNode() + Removes attribute + + + &reftitle.description; + + DOMElement + + bool + removeAttribute + DOMAttroldnode + + + + Removes attribute oldnode from the element. + + + + &reftitle.parameters; + + + + oldnode + + + The attribute node. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified or + attribute is not a member of the element node. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->removeAttributeNS - Removes attribute - - - &reftitle.description; - - DOMElement - - bool - removeAttributeNS - stringnamespaceURI - stringlocalName - - - - Removes attribute is namespace namespaceURI - named localName from the element. - - - Throws DOMException if node cannot be modified. - - - + + + + DOMElement->removeAttributeNS() + Removes attribute + + + &reftitle.description; + + DOMElement + + bool + removeAttributeNS + stringnamespaceURI + stringlocalName + + + + Removes attribute is namespace namespaceURI + named localName from the element. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + localName + + + The local name. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->setAttribute - Adds new attribute - - - &reftitle.description; - - DOMElement - - bool - setAttribute - stringname - stringvalue - - - - Sets an attribute with name name to the given - value. If the attribute does not exist, it will be created. - - - Throws DOMException if node cannot be modified. - - - - Setting an attribute - + + + + DOMElement->setAttribute() + Adds new attribute + + + &reftitle.description; + + DOMElement + + bool + setAttribute + stringname + stringvalue + + + + Sets an attribute with name name to the given + value. If the attribute does not exist, it will be created. + + + + &reftitle.parameters; + + + + name + + + The name of the attribute. + + + + + value + + + The value of the attribute. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.examples; + + + Setting an attribute + appendChild($node); $newnode->setAttribute("align", "left"); ?> ]]> - - - - - See also DOMElement->getAttribute() - - - + + + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->setAttributeNode - Adds new attribute node to element - - - &reftitle.description; - - DOMElement - - bool - setAttributeNode - DOMAttrattr - - - - Adds new attribute node attr to element. - Returns old node if attribute replaced. - - - Throws DOMException if node cannot be modified. - - - + + + + DOMElement->setAttributeNode() + Adds new attribute node to element + + + &reftitle.description; + + DOMElement + + DOMAttr + setAttributeNode + DOMAttrattr + + + + Adds new attribute node attr to element. + + + + &reftitle.parameters; + + + + attr + + + The attribute node. + + + + + + + + &reftitle.returnvalues; + + Returns old node if the attribute has been replaced. + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->setAttributeNodeNS - Adds new attribute node to element - - - &reftitle.description; - - DOMElement - - bool - setAttributeNodeNS - DOMAttrattr - - - - Adds new attribute node attr to element. - Returns old node if attribute replaced. - - - Throws DOMException if node cannot be modified. - - - + + + + DOMElement->setAttributeNodeNS() + Adds new attribute node to element + + + &reftitle.description; + + DOMElement + + DOMAttr + setAttributeNodeNS + DOMAttrattr + + + + Adds new attribute node attr to element. + + + + &reftitle.parameters; + + + + name + + + The attribute node. + + + + + + + + &reftitle.returnvalues; + + Returns the old node if the attribute hase been replaced. + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.seealso; + + + + + + + + + - - - DOMElement->setAttributeNS - Adds new attribute - - - &reftitle.description; - - DOMElement - - void - setAttributeNS - stringnamespaceURI - stringqualifiedName - stringvalue - - - - Sets an attribute with namespace namespaceURI and - name name to the given value. If the attribute - does not exist, it will be created. - - - Throws DOMException if node cannot be modified. - - - See also DOMElement->getAttributeNS() - - - + + + + DOMElement->setAttributeNS() + Adds new attribute + + + &reftitle.description; + + DOMElement + + + setAttributeNS + stringnamespaceURI + stringqualifiedName + stringvalue + + + + Sets an attribute with namespace namespaceURI and + name name to the given value. If the attribute + does not exist, it will be created. + + + + &reftitle.parameters; + + + + namespaceURI + + + The namespace URI. + + + + + qualifiedName + + + The qualified name of the attribute, as prefix:tagname. + + + + + value + + + The value of the attribute. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.exceptions; + + Throws DOMException if node cannot be modified. + + + + &reftitle.seealso; + + + + + + + + +