NAME

HTML::Object::XQuery - HTML XQuery Extension

SYNOPSIS

use HTML::Object::DOM global_dom => 1;
use HTML::Object::XQuery;
my $e = HTML::Object::Element->new || die( HTML::Object::Element->error, "\n" );

VERSION

v0.2.1

DESCRIPTION

This class extends HTML::Object::DOM::Element and provided jQuery-like methods to manipulate and query HTML objects. It is very extensive and closely mirrors jQuery api with some additional features specific to perl.

By calling use HTML::Object::DOM global_dom = 1;>, this will instantiate a global DOM mimicking the one on a web page. This, in turns, enables calls such as:

$("li")->addClass("hello");

Without the need to specify any context like:

my $p = HTML::Object::DOM->new;
my $context = $p->parse_file( "/path/to/some/file.html" );
$("li", $context)->addClass("hello");

Calling use HTML::Object::DOM global_dom = 1;> also enables the use of the special function $(), which is, normally, not possible in perl.

Since HTML::Object::XQuery extends HTML::Object::DOM::Element, but does not inherit from it, you cannot create a HTML::Object::XQuery object. You can simply load HTML::Object::DOM and then load HTML::Object::XQuery to extend the methods available in HTML::Object::DOM::Element

use HTML::Object::DOM use_dom => 1;
use HTML::Object::XQuery;
# and the rest as usua;
my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $some_html ) || die( $p->error );
$('div')->css({ background => 'red' });

INHERITANCE

+--------------+     +----------------------------+     +----------------------+
| HTML::Object | --> | HTML::Object::DOM::Element | --> | HTML::Object::XQuery |
+--------------+     +----------------------------+     +----------------------+

METHODS

add

Create a new object with elements added to the set of matched elements.

This returns a new collection element. Contrary to what one could assume, this does not add the elements to the dom, but only to the collection.

The argument to "add" can be pretty much anything that $() ("xq") accepts, including a selector expression, elements objects, or an HTML snippet.

Takes:

a selector (e.g. '.some-class'); or
a collection (i.e. one or more elements resulting from a find or equivalent query); or
"HTML fragment to add to the set of matched elements."; or
a selector and a context (i.e. an element object); or
a element object

Returns a new HTML::Object::Collection object.

For example, consider:

<ul>
  <li>list item 1</li>
  <li>list item 2</li>
  <li>list item 3</li>
</ul>
<p>a paragraph</p>

$( "li" )->add( "p" )->css( "background-color", "red" );

This will select the li tags, then add the p tag to the collection set of elements objects and finally will apply the css change of background colour.

If we pass an HTML snippet as argument, such as:

$( "li" )->add( "<p id='new'>new paragraph</p>" )
  ->css( "background-color", "red" );

The paragraph will have been created dynamically and added to the set, but is not yet part of the dom until some methods are used to insert it.

$( "p" )->clone()->add( "<span>Again</span>" )->appendTo( "body" );

Note: To reverse the "add" you can use $e-not( elements | selector )> to remove elements from the collection results, or "end" to return to the selection before you added.

See https://api.jquery.com/add/

addClass

Provided with a css class name and this will add it to the current object, which can be either a collection object (HTML::Object::Collection), or an html element (HTML::Object::DOM::Element).

See https://api.jquery.com/addClass/

after

Insert content, specified by the parameter, after each element in the set of matched elements.

"after" and "insertAfter" methods perform the same task. The major difference is in the syntax—specifically, in the placement of the content and target. With "after", the content to be inserted comes from the method's argument:

xq(target)->after( contentToBeInserted );

With "insertAfter", on the other hand, the content precedes the method and is inserted after the target, which in turn is passed as the "insertAfter" method's argument:

xq(contentToBeInserted)->insertAfter(target);

For example, consider the following HTML:

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html );

Content can be created and then inserted after several elements at once:

xq( ".inner", $doc )->after( "<p>Test</p>" );

Each inner <div> element gets this new content:

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <p>Test</p>
  <div class="inner">Goodbye</div>
  <p>Test</p>
</div>

An element in the DOM can also be selected and inserted after another element:

xq( ".container", $doc )->after( xq( "h2", $doc ) );

If an element selected this way is inserted into a single location elsewhere in the DOM, it will be moved rather than cloned:

<div class="container">
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>
<h2>Greetings</h2>

You can also pass a code reference that returns the elements to insert.

xq( "p", $doc )->after(sub {
  return "<div>" + $_->className + "</div>";
});

https://api.jquery.com/after/

ajax

Perform an asynchronous HTTP (Ajax) request.

This takes an url and an optional hash reference of parameters.

This is still a work in progress

https://api.jquery.com/jQuery.ajax/

ajaxSetup

This is still a work in progress

https://api.jquery.com/jQuery.ajaxSetup/

append

This method inserts the specified content as the last child of each element in the collection (To insert it as the first child, use "prepend").

It takes the following possible arguments:

an html string
an array reference of html strings
an HTML::Object::DOM::Element object
code reference

Will be executed to retrieve the string

For example:

<h2>Greetings</h2>
<div class="container">
    <div class="inner">Hello</div>
    <div class="inner">Goodbye</div>
</div>

This will create content and insert it into several elements at once:

$( ".inner" )->append( "<p>Test</p>" );

Each inner <div> element gets this new content, such as:

<h2>Greetings</h2>
<div class="container">
    <div class="inner">
        Hello
        <p>Test</p>
    </div>
    <div class="inner">
        Goodbye
        <p>Test</p>
    </div>
</div>

You can also select an element on the page and insert it into another:

$( ".container" )->append( $( "h2" ) );

If an element selected this way is inserted into a single location elsewhere in the DOM, it will be moved into the target (not cloned):

<div class="container">
    <div class="inner">Hello</div>
    <div class="inner">Goodbye</div>
    <h2>Greetings</h2>
</div>

Important: If there is more than one target element, however, cloned copies of the inserted element will be created for each target except for the last one.

Additional Arguments

Similar to other content-adding methods such as "prepend" and "before", "append" also supports passing in multiple arguments as input. Supported input includes HTML elements, collection objects, HTML strings, and arrays of HTML elements.

For example, the following will insert two new <div>s and an existing <div> as the last three child nodes of the body:

my $newdiv1 = $( "<div id='object1'></div>" ),
my $newdiv2 = $doc->createElement( "div" ),
my $existingdiv1 = $doc->getElementById( "foo" );

$( "body" )->append( $newdiv1, [ newdiv2, existingdiv1 ] );

https://api.jquery.com/append/

appendTo

Same as "append", except that instead of using the current object, the current object is appended to the object specified.

https://api.jquery.com/appendTo/

attr

If more than 1 values are provided, it will set the attributes with their keys and associated values.

If only one parameter is provided, this will return the corresponding value.

https://api.jquery.com/attr/

before

"before" and "insertBefore" methods perform the same task. The major difference is in the syntax—specifically, in the placement of the content and target. With "before", the content to be inserted comes from the method's argument:

xq($target)->before( $contentToBeInserted )

With "insertBefore", on the other hand, the content precedes the method and is inserted before the target, which in turn is passed as the "insertBefore" method's argument:

xq($contentToBeInserted)->insertBefore( $target );

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html );

You can create content and insert it before several elements at once:

xq( ".inner", $doc )->before( "<p>Test</p>" );

Each inner <div> element gets this new content:

<div class="container">
  <h2>Greetings</h2>
  <p>Test</p>
  <div class="inner">Hello</div>
  <p>Test</p>
  <div class="inner">Goodbye</div>
</div>

You can also select an element on the page and insert it before another:

xq( ".container", $doc )->before( xq( "h2", $doc ) );

If an element selected this way is inserted into a single location elsewhere in the DOM, it will be moved before the target (not cloned):

<h2>Greetings</h2>
<div class="container">
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

https://api.jquery.com/before/

closest

Takes a selector; or a selector and an HTML::Object::DOM::Element as a context; or a HTML::Object::DOM::Element object "Given a jQuery object that represents a set of DOM elements, the .closest() method searches through these elements and their ancestors in the DOM tree and constructs a new jQuery object from the matching elements."

It returns a HTML::Object::Collection object.

https://api.jquery.com/closest/

cmp

Comparison operator between objects

css

Takes a property name; or an array reference of one or more css properties; or a property name and a value; or a property name and a function; or an hash reference of property name-value pairs

This wil set the css attribute for that element.

css_cache_check

Provided with some data and this will check the checksum to re-use the cache or not.

It returns an empty string when no cache can be re-used.

css_cache_store

Provided with some css data for this element and this will cache it.

data

Provided with a name and some value and this will set the data attribute for this element or collection of elements accordingly.

If the data provided is an hash reference, each key-value pair will be added as data attribute to the element of the collection of elements.

If only a name is provided, with no value, this will return the corresponding value.

https://api.jquery.com/data/

detach

Detach the current element or the collection of elements and return the current object.

https://api.jquery.com/detach/

each

xq('.some-thing')->each(sub
{
    my( $i, $e ) = @_;
    # do something
});

Takes a code reference which receives the element position and element object as parameter.

It returns the current object it was called with.

https://api.jquery.com/each/

empty

This will empty the current element or collection of elements. This mean there will be no children elements anymore.

https://api.jquery.com/empty/

end

Sets or gets an HTML::Object::DOM::Element object.

https://api.jquery.com/end/

eq

Returns the children elements matching the value provided.

This calls "children", which returns an Module::Generic::Array object and calls "index" in Module::Generic::Array with the value provided.

https://api.jquery.com/eq/

even

Returns a new collection of elements whose position is an even number

https://api.jquery.com/even/

exists

Provided an xpath and this will check if the current object exists in the xpath provided.

filter

Takes a selector; or function with arguments are element position (starting from 0) and the element itself, expecting a true value in return; or an array of element objects; or an element object;

https://api.jquery.com/filter/

find

Takes a selector; or Element object

https://api.jquery.com/find/

find_xpath

Provided with an xpath value and this will find and return all matches.

findnodes

Provided with an xpath value and this will find and return all nodes.

findnodes_as_string

Provided with an xpath value and this will find and return all nodes as string.

findnodes_as_strings

Same as "findnodes_as_string", but plural

Provided with an xpath value and this will find and return all nodes as strings.

findvalue

Provided with an xpath value and this will find and return node value.

findvalues

Same as "findvalue", but plural

Provided with an xpath value and this will find and return nodes value.

first

Returns the first element of the collection if the object is a collection, or the element itself.

https://api.jquery.com/first/

get

Returns the current element.

Originally, in jQuery, this returns the underlying DOM element, but here, in perl context, this does not mean much, and we return our own object.

https://api.jquery.com/get/

head2 has

"has" method constructs a new HTML::Object::Collection object from a subset of the original object on which it is called, and that only includes elements with descendants that match the given selector.

Let’s say you wanted to find all paragraphs that have links in them. You’d use:

my $paragraphs = $xq('p', $doc);
my $paragraphsWithLinks = $paragraphs->has('a');

The difference with the "find" method[1], is that rather than returning a subset of the object on which it is called, returns a HTML::Object::Collection object representing the elements that match the given selector that are descendants of the original object.

So, similar to the above example, instead of selecting paragraphs that have links in them, we instead get the links themselves that are inside paragraphs:

my $paragraphs = $xq('p', $doc); 
my $linksInParagraphs = $paragraphs->find('a');

[1] Paraphrasing the explanation provided by Andy Farrell

hasClass

Provided with a css class name and this will returns true if the current element has this class, or false otherwise.

https://api.jquery.com/hasClass/

hide

This is roughly equivalent to calling "css"( "display", "none" ), except that the value of the display property is saved in the object's internal data cache so that display can later be restored to its initial value. If an element has a display value of inline and is hidden then shown, it will once again be displayed inline.

It takes 1 or 2 argument. THe first one originally in jQuery is either a timer in millisecond or an easing effect or some option hash, but since none of this has any effect under perl, the first argument is ignored.

$elem->hide( $hash_ref, sub{ $_->show() });

However, if there is only one argument and it is a code reference, it is used.

$elem->hide( sub{ $_->show() });

The optional second argument is a code reference (a callback) that will be called passing it the element object.

It returns the object used to call this method in the first place.

$elem->hide->show(); # Kind of meaningless, but hey this is an example

https://api.jquery.com/hide/

html

When no argument is provided, this returns the html string of its content for element object, or the html string of the content of the first object if this is a collection object, i.e. a HTML::Object::Collection object.

my $html_string = $element->html();
# or, here this is a collection object
xq('body', $doc)->html();
# or if this is a single html element object
xq('body', $doc)->first->html();

When an argument is provided, it takes either some html data as a string, or a code reference.

In the case of a code reference, it is called with the element position, starting at 0 and the old html data string. It expects in returns either:

1. an empty or undefined value, in which case the current element will have its content emptied using "empty"
2. some html data, in which case it is parsed using "parse_data" in HTML::Object::DOM and the object found are used to replace the content of the current element object.
3. an HTML::Object::DOM::Element object whose content elements will be used in replacement of the content of the current object

Quoting jQuery documentation, for example, consider this html:

<div class="demo-container">
  <div class="demo-box">Demonstration Box</div>
</div>

Assuming this html is stored in a variable $html:

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html ) || die( $p->error, "\n" );

The content of <div class="demo-container"> can be set like this:

xq( "div.demo-container", $doc )
  ->html( "<p>All new content. <em>You bet!</em></p>" );

That line of code will replace everything inside <div class="demo-container">:

<div class="demo-container">
  <p>All new content. <em>You bet!</em></p>
</div>

xq( "div.demo-container", $doc )->html(sub {
  my $emphasis = "<em>" + $xq( "p", $doc )->length + " paragraphs!</em>";
  return "<p>All new content for " + emphasis + "</p>";
});

Afer the html value is set, it returns the object it was called with.

To set the content of a <script> element, which does not contain HTML, use the "text" method and not "html".

https://api.jquery.com/html/

index

Search for a given element from among the matched elements.

When no argument is provided, the return value is an integer indicating the position of the element, starting from 0, within its parent.

If "index" is called on a collection of elements (i.e. a HTML::Object::Collection object) and an element object (HTML::Object::DOM::Element) is provided as argument, "index" returns an integer indicating the position of the provided element relative to the original collection.

This would behave as a complementary operation to "get", which accepts an index and returns a element object. Under jQuery, "get" would return DOM element, but there is no such thing in this perl context.

If a selector string is passed as an argument, "index" returns an integer indicating the position of the first element within the object relative to the elements matched by the selector. If the element is not found, -1 will be returned.

For example, consider the following html:

<ul>
  <li id="foo">foo</li>
  <li id="bar">bar</li>
  <li id="baz">baz</li>
</ul>

my $p = HTML::Object::DOM->new;
my $document = $p->parse_data( $html );

If we retrieve one of the three list items (for example, through one of the element object's functions), "index" can search for this list item within the set of matched elements:

my $listItem = $document->getElementById( "bar" );
say( "Index: " + xq( "li", $document )->index( $listItem ) );

We get back the zero-based position of the list item:

Index: 1

Note that if a collection object (HTML::Object::Collection) is used as the "index" method's argument and it contains more than one element, the first element within that collection will be used.

If we use a string as the "index" method's argument, it is interpreted as a selector string. The first element among the HTML::Object::Collection object's matched elements which also matches this selector is located. If the object is just one HTML::Object::DOM::Element object, the selector is tested against it.

my $listItem = xq( "#bar", $document );
say( "Index: " + $listItem->index( "li" ) );

Or, using a single HTML::Object::DOM::Element, the same will check against that element alone.

my $element = xq( "#bar", $document )->first();
say( "Index: " + $listItem->index( "li" ) );

Without any arguments, "index" will return the position of the first element, if this is a HTML::Object::Collection, in relation to its siblings, or the position of the element itself if this is just an HTML::Object::DOM::Element

say( "Index: " + xq( "#bar", $document )->index() );

https://api.jquery.com/index/

insertAfter

Insert every element in the set of matched elements after the target.

The target can be one of a selector, an element object (HTML::Object::DOM::Element), an array of elements objects, or an HTML string.

if the current object is a collection, all of its elements contained will be inserted after the target.

If the current object is just an HTML::Object::DOM::Element object, it will be moved (not copied) after the target.

"after" and "insertAfter" perform the same task. The major difference is in the syntax—specifically, in the placement of the content and target. With "after", the object used to call the method is the container after which the content is inserted. While with "insertAfter", it is the opposite.

For example, consider the following HTML:

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html );

We can create content and insert it after several elements at once:

xq( "<p>Test</p>", $doc )->insertAfter( ".inner" );

Each inner ≤div> element gets this new content:

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <p>Test</p>
  <div class="inner">Goodbye</div>
  <p>Test</p>
</div>

We can also select an element on the page and insert it after another:

xq( "h2", $doc )->insertAfter( xq( ".container", $doc ) );

If an element selected this way is inserted into a single location elsewhere in the DOM, it will be moved after the target (not cloned) and a new set consisting of the inserted element is returned:

<div class="container">
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>
<h2>Greetings</h2>

If there is more than one target element, however, cloned copies of the inserted element will be created for each target after the first, and that new set (the original element plus clones) is returned.

https://api.jquery.com/insertAfter/

insertBefore

Insert every element in the set of matched elements before the target.

The target can be one of a selector, an element object (HTML::Object::DOM::Element), an array of elements objects, or an HTML string.

if the current object is a collection, all of its elements contained will be inserted before the target.

If the current object is just an HTML::Object::DOM::Element object, it will be moved (not copied) before the target.

"before" and "insertBefore" perform the same task. The major difference is in the syntax—specifically, in the placement of the content and target. With "before", the object used to call the method is the container before which the content is inserted. While with "insertBefore", it is the opposite.

For example, consider the following HTML:

<div class="container">
  <h2>Greetings</h2>
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html );

We can create content and insert it before several elements at once:

xq( "<p>Test</p>", $doc )->insertBefore( ".inner" );

Each inner ≤div> element gets this new content:

<div class="container">
  <h2>Greetings</h2>
  <p>Test</p>
  <div class="inner">Hello</div>
  <p>Test</p>
  <div class="inner">Goodbye</div>
</div>

We can also select an element on the page and insert it before another:

xq( "h2", $doc )->insertBefore( xq( ".container", $doc ) );

If an element selected this way is inserted into a single location elsewhere in the DOM, it will be moved before the target (not cloned) and a new set consisting of the inserted element is returned:

<h2>Greetings</h2>
<div class="container">
  <div class="inner">Hello</div>
  <div class="inner">Goodbye</div>
</div>

https://api.jquery.com/insertBefore/

is

Check the current matched set of elements against a selector, HTML::Object::DOM::Element, HTML::Object::Collection or a code reference and return true if at least one of these elements matches the given arguments.

Unlike other filtering methods, "is" does not create a new object. Instead, it allows you to test the contents of an object (element or collection) without modification.

Suppose you have a list, with two of its items containing a child element:

<ul>
  <li>list <strong>item 1</strong></li>
  <li><span>list item 2</span></li>
  <li>list item 3</li>
</ul>

my $p = HTML::Object::DOM->new;
my $doc = $p->parse_data( $html ) || die( $p->error );

You can check if an object is one of the li's like:

if( $elem->is( 'li' ) )
{
    # Make the background red
    $elem->css( "background-color", "red" );
}

"is" can also evaluate expressions related to elements based on a code reference rather than a selector. For each element, if the code reference returns true, "is" returns true as well. For example, given a somewhat more involved HTML snippet:

<ul>
  <li><strong>list</strong> item 1 - one strong tag</li>
  <li><strong>list</strong> item <strong>2</strong> -
    two <span>strong tags</span></li>
  <li>list item 3</li>
  <li>list item 4</li>
  <li>list item 5</li>
</ul>

$li here is an element that you have defined earlier in your code.

my $isWithTwo = $li->is(sub {
    return xq( "strong", $_ )->length == 2;
});
if( $isWithTwo ) 
{
    $li->css( "background-color", "green" );
} 
else
{
    $li->css( "background-color", "red" );
}

<form>
  <input type="checkbox">
</form>
<div></div>

my $isFormParent = xq( "input[type='checkbox']", $doc )->parent()->is( "form" );
xq( "div", $doc )->text( "isFormParent = " + $isFormParent );

Checks against an existing collection of alternating list elements. Blue, alternating list elements set background to yellow while others turn red.

   <ul id="browsers">
     <li>Chrome</li>
     <li>Safari</li>
     <li>Firefox</li>
     <li>Opera</li>
   </ul>

   my $alt = xq( "#browsers li:nth-child(2n)", $doc )->css( "background", "#0ff" );
   my $li = xq( "li" );
   if( $li->is( $alt ) )
   {
       $li->css( "background", "yellow" );
   }
   else
   {
       $li->css( "background", "red" );
   }

See https://api.jquery.com/is/

isa_collection

Returns true if the current element is a HTML::Object::Collection object, or false otherwise.

length

Returns the number of children if the current element is a collection, or 1 if the current element is an element.

load

$e->load( $uri );
# or
$e->load( $uri, { key1 => value1, key2 => value2 } );
# or
$e->load( $uri, $callback_subroutine );
# or
$e->load( $uri, { key1 => value1, key2 => value2 }, $callback_subroutine );

The callback function receives 3 arguments: $responseContent, $textStatus and $responseObject

This method fetches data from the given uri and, when a successful response is detected (i.e. when textStatus is success or notmodified), "load" sets the HTML contents of the matched elements to the returned data. This means that most uses of the method can be quite simple:

$( "#result" )->load( "/some/test.html" );

Upon error, be it internal, or when the returned http code is not a 2XX code, $textStatus is set to error

If no element is matched by the selector — in this case, if the document does not contain an element with id="result" — the http request will not be sent.

It returns the current element object upon success, or upon error, sets an error and returns undef.

This methods uses LWP::UserAgent to do the work and it must be installed as well as URI, or else this method will return an error.

The uri provided must be an absolute URI, or LWP::UserAgent will return an error.

Callback subroutine

If a callback subroutine is provided, it is executed after post-processing of the HTML with HTML::Object::DOM and insertion of the HTML element objects have been performed. The callback is fired once for each element in the object collection, and $_ is set to each element object in turn.

$( "#result" )->load( "/somewhere/test.html", sub
{
    print( "Load was performed.\n" );
});

The $responseObject is a HTTP::Response object.

The $responseContent is an utf8 decoded (i.e. perl internal utf8) text string.

Request method

The POST method is used if data is provided as an hash reference; otherwise, GET is assumed.

Loading page fragments

This method makes it possible to specify a portion of the remote document to be inserted. This is achieved with a special syntax for the uri parameter. If one or more space characters are included in the string, the portion of the string following the first space is assumed to be a selector that determines the content to be loaded. For example:

$( "#result" )->load( "/somewhere/test.html #container" );

Upon execution, this method retrieves the content of /somewhere/test.html, but then HTML::Object::DOM parses the returned document to find the element with an ID of container. This element, along with its contents, is inserted into the element with an ID of result, and the rest of the retrieved document is discarded.

For example, given the following HTML document:

<!DOCTYPE html>
<html lang="en-GB">
    <head>
        <meta charset="utf-8" />
        <title>load demo</title>
        <meta name="generator" content="BBEdit 13.5" />
    </head>
    <body>
        <b>Projects:</b>
        <ol id="new-projects"></ol>
    </body>
</html>

We could do:

use HTML::Object::DOM;
use Module::Generic::File qw( file );
my $parser = HTML::Object::DOM->new;
my $doc = $parser->parse( $html ) || die( $parser->error );
HTML::Object::DOM->set_dom( $doc );
my $part = file( "./resources/load.html" );
my $uri  = $part->uri; # e.g. file:///home/joe/www/resources/load.html
$( "#new-projects" )->load( "$uri #projects li" );

This would make the following change to the html:

<ol id="new-projects"><li>jQuery</li><li>jQuery UI</li><li>jQuery Mobile</li><li>QUnit</li><li>Sizzle</li></ol>

Error handling

If an error occurs, the $textStatus would be set to error, which you can check as follows:

$( "#success" ).load( "https://example.org/not-here.html", sub { my( $content, $status, $resp ) = @_; if( $status == "error" ) { my $msg = "Sorry but there was an error: "; $( "#error" )->html( $msg . $resp->code . " " . $resp->message ); } });

map

Provided with a code reference, and this will execute on each of the children.

matches

Provided with a xpath and this will return all matching nodes.

name

Sets or gets the name attribute.

new_attribute

Provided with an hash or hash reference of parameters, and this will return a new HTML::Object::DOM::Attribute object by passing it the parameters.

new_collection

Provided with an hash or hash reference of parameters, and this will return a new HTML::Object::Collection object by passing it the parameters.

new_parser

This will return a new HTML::Object::DOM object.

new_root

Provided with an hash or hash reference of parameters, and this will return a new HTML::Object::DOM::Root object by passing it the parameters.

not

Takes a selector expression; or a element object; or a collection of elements; or an array of element objects to match against the set.

It returns all elements that do not match.

https://api.jquery.com/not/

odd

Returns a new collection of elements whose position is an even number

https://api.jquery.com/odd/

prepend

Takes html string (start with <tag...), text object (HTML::Object::DOM::Text), array or element object or alternatively a code reference that returns the above

https://api.jquery.com/prepend/

prependTo

https://api.jquery.com/prependTo/

promise

Provided with a code reference to be executed asynchronously and this will return a Promise::Me object.

my $p = $e->promise(sub
{
   # Some regular code here
})->then(sub
{
   my $res = shift( @_ ); # return value from the code executed above
   # more processing...
})->then(sub
{
   my $more = shift( @_ ); # return value from the previous then
   # more processing...
})->catch(sub
{
   my $exception = shift( @_ ); # error that occured is caught here
})->finally(sub
{
   # final processing
})->then(sub
{
   # A last then may be added after finally
};

remove

If the current object is a collection, this will remove all of its children. Otherwise, if this is an element, it will simply remove it.

You can also provide an xpath as an argument and the matching nodes will be removed.

removeAttr

Provided with an attribute name and this will remove it from the collection if the current element is a collection, or from the current element itself if it is a HTML::Parser::Element object.

It returns the current object.

https://api.jquery.com/removeAttr/

removeClass

Provided with a class name and this will remove it from the current element or the current collection.

https://api.jquery.com/removeClass/

replaceWith

Takes html string, array of elements, an element (including a collection object) or a code reference and this will replace the current element with the new element.

https://api.jquery.com/replaceWith/

set_namespace

Set the new namespace for the current node.

show

Since this is a perl context, this only set the inline css 1) back to its previous value, if any; or 2) remove the display property if there was no previous value set.

Any parameter provided will be ignored

See the hide() method for its alter ego.

https://api.jquery.com/show/

string_value

Returns "value" if the current element is comment node. Otherwise, returns "as_text"

tagname

Returns the tag name for the current element.

toggleClass

Takes a class name; or class name and state (true or false); or array of class names; or array of class names and a state; or a code reference called with the index position of the current class and its name. Returns a space separated list of classes or an array

https://api.jquery.com/toggleClass/

to_number

Returns a new HTML::Object::DOM::Number object by passing it the current node value ("getValue")

toString

Returns the current node value as "as_xml"

xp

Returns an already instantiated XML::XPathEngine object, or instantiate one and returns it.

xq

Ref: <https://api.jquery.com/Types/#jQuery>

xq( '#myId', $document )
xq( '<div />', { id => 'Pouec', class => 'Hello' } );
xq( '<html><head><title>Hello world</title></head><body>Hello!</body></html>' );
xq();

PRIVATE METHODS

_append_prepend

Called by "append" and "prepend" to do the heavy work.

_append_prepend_to

Takes html string; or selector; or element object; or array of objects; or collection "If there is more than one target element, however, cloned copies of the inserted element will be created for each target except the last, and that new set (the original element plus clones) is returned."

Called by "append_to" and "prepend_to" to do the heavy work.

_before_after

Takes html string (start with <tag...), text object (HTML::Object::DOM::Text), array or element object or alternatively a code reference that returns the above

_child_as_object

called on a parent, with a child as second argument and its rank as third returns the child if it is already an element, or a new HTML::Object::DOM::Text element if it is a plain string

_compare

Takes another element and compares the current one to it. Returns true if they are the same, false otherwise.

It achieves this by check if the current element "eid" in HTML::Object::Element is same, of if the element is a collection it check it is of the same size and the other element is among the collection.

_css_object

If argument is provided, pass a CSS::Object::Builder::Rule object

If no argument is provided, get a CSS::Object::Builder::Rule of the inline css, if any at all.

Returns undef if no css attribute is set yet.

_css_builder

Returns a new CSS*:Object object using the format set to CSS::Object::Format::Inline.

_insert_before_after

Takes selector, html, element or array

xq( '<p>Test</p>' )->insertBefore( xq( '.inner', $doc ) );
$elem->insertBefore( '.inner' );

_is_html

Returns true if the data provided looks like html, or false otherwise.

_is_same_node

Returns true if the current element and the provided element have he same "eid"t

_xpath_value

Returns the xpath value fot the current element

ERROR HANDLING

Methods in this package returns undef either because no value is available, or because an error occurred

You can find out about an error after a method call by calling error, such as:

# Try to change the tag name
my $rv = $e->tag( $something );
die( $e->error ) if( !defined( $rv ) );

But keep in mind that an undefined value returned does not necessarily means there was an error. Consider:

my $div = $('<div />', { class => 'hello' });
my $id = $div->attr( 'id' );

$id will be undefined because there is no 'id' attribute set, and this is not an error.

If you are using the global dom feature, you can get the posible errors like this:

$('#someId')->load( '/some/where.html' ) || die( HTML::Object::DOM->error );

"error" in HTML::Object::DOM is guaranteed to be set upon error. You can also get the global variable $HTML::Object::DOM::ERROR

If you prefer, you can choose to make every error fatal and catch them with a try-catch implementation like Nice::Try

use HTML::Object::DOM
$HTML::Object::DOM::FATAL_ERROR = 1;
# or
use HTML::Object::DOM fatal_error => 1;
use Nice::Try;

try
{
    # Try to change the tag name
    $e->tag( $something );
}
catch( $ex )
{
    die( "Could not change the tag name: ", $ex->message );
}

Or, if you wanted to filter the exception by class:

try
{
    # Try to change the tag name
    $e->tag( $something );
}
catch( HTML::Object::Exception $ex )
{
    die( "An HTML::Object::DOM error occurred: ", $ex->message );
}
catch( $ex )
{
    die( "Caught an exception: $ex\n" );
}

Note that HTML::Object::Exception object has stringification capability so you can embed it in a string:

die( "Could not change the tag name: $ex\n" );

TODO

addBack

https://api.jquery.com/addBack/

AUTHOR

Jacques Deguest <jack@deguest.jp>

COPYRIGHT & LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install HTML::Object, copy and paste the appropriate command in to your terminal.

cpanm

cpanm HTML::Object

CPAN shell

perl -MCPAN -e shell
install HTML::Object

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)