##
# name: pQuery
# abstract: A port of jQuery.js to Perl
# author: Ingy döt Net <ingy@cpan.org>
# license: perl
# copyright: 2008, 2011
use v5.8.3;
package pQuery;
use strict;
use warnings;
use pQuery::DOM;
use Carp;
use HTML::TreeBuilder 4.2 ();
use base 'Exporter';
our $VERSION = '0.09';
our $document;
*pQuery = \$document;
our @EXPORT = qw(pQuery $pQuery PQUERY);
my $my = {};
my $lwp_user_agent;
my $quickExpr = qr/^([^<]*<(.|\s)+>[^>]*)$|^#(\w+)$/;
my $isSimple = qr/^.[^:#\[\.]*$/;
my $dom_element_class = 'pQuery::DOM';
sub pQuery {
return 'pQuery'->new(@_);
}
sub PQUERY {
return 'PQUERY'->new(@_);
}
#------------------------------------------------------------------------------#
# New ideas / Playing around stuffs
#------------------------------------------------------------------------------#
sub url {
my $this = shift;
return $my->{$this}{url}
if $my->{$this}{url};
while ($this = $my->{$this}{prevObject}) {
return $my->{$this}{url}
if $my->{$this}{url};
}
return;
}
#------------------------------------------------------------------------------#
# Truly ported from jQuery stuff
#------------------------------------------------------------------------------#
sub new {
my $class = shift;
my $this = bless [], $class;
$my->{$this} = {};
return $this->_init(@_);
}
sub _init {
my ($this, $selector, $context) = @_;
$selector ||= $document or return $this;
if (ref($selector) eq $dom_element_class) {
@$this = $selector;
return $this;
}
elsif (not ref($selector)) {
my $match = ($selector =~ $quickExpr);
if ($match and ($1 or not $context)) {
if ($1) {
my $html = $this->_clean($1);
$selector = [pQuery::DOM->fromHTML($html)];
# $selector = $this->_clean([$1], $context);
}
else {
my $elem = $document->getElementById($3);
if ($elem) {
@$this = $elem;
return $this;
}
else {
$selector = [];
}
}
}
else {
if ($selector =~ /^\s*(https?|file):/) {
$my->{$this}{url} = $selector;
return $document = $this->_new_from_url($selector);
}
elsif ($selector =~ /^\S+\.html?$/) {
$my->{$this}{file} = $selector;
open FILE, $selector
or croak "Can't open file '$selector' for input:\n$!";
my $html = do {local $/; <FILE>};
close FILE;
$html = $this->_clean($html);
$selector = [$document = pQuery::DOM->fromHTML($html)];
}
else {
$context ||= $document;
return pQuery($context)->find($selector);
}
}
}
@$this = (ref($selector) eq 'ARRAY' or ref($selector) eq 'pQuery')
? @$selector
: $selector;
return $this;
}
sub _clean {
my ($this, $html) = @_;
$html =~ s/^\s*<\?xml\s.*?>\s*//s;
$html =~ s/^\s*<!DOCTYPE\s.*?>\s*//s;
return $html;
}
sub pquery { return $VERSION }
sub size { return $#{$_[0]} + 1 }
sub get {
my $this = shift;
# Get could be for Ajax URL or Object Member
return $this->_web_get(@_)
if @_ and $_[0] !~ /^\d+$/;
return @_
? $this->[$_[0]]
: wantarray ? (@$this) : $this->[0];
}
sub pushStack {
my ($this, $elems) = @_;
my $ret = pQuery($elems);
$ret->_prevObject($this);
return $ret;
}
sub _prevObject {
my $this = shift;
return @_
? ($my->{$this}{prevObject} = $_[0])
: $my->{$this}{prevObject};
}
# Not needed in Perl
# sub _setArray {}
sub each {
my ($this, $sub) = @_;
my $i = 0;
&$sub($i++) for @$this;
return $this;
}
sub attr { # (name, value, type)
# TODO - Get/set a named attribute
}
sub css { # (key, value)
# TODO - Get/set a css attribute
}
# TODO/XXX Made up. Not ported yet.
sub text {
# TODO - Get/set text value
my $this = shift;
my @text;
$this->each(sub {
my $text = '';
_to_text($_, \$text);
$text =~ s/\s+/ /g;
$text =~ s/^\s+|\s+$//g;
push @text, $text;
});
return wantarray ? @text : join(' ', grep /\S/, @text);
}
sub wrapAll { # (html)
# TODO - Wrap element with HTML
}
sub wrapInner { # (html)
# TODO - Wrap sub elements with HTML
}
sub wrap { # (html)
# TODO - Wrap current objects with HTML
}
sub append { # (@_)
# TODO - Append arguments to current objects
}
sub prepend { # (@_)
# TODO - Prepend arguments to current objects
}
sub before { # (@_)
# TODO - Insert arguments before current objects
}
sub after { # (@_)
# TODO - Insert arguments after current objects
}
sub end {
my $this = shift;
return $this->_prevObject || pQuery([]);
}
sub find {
my ($this, $selector) = @_;
my $elems = [];
for (my $i = 0; $i < @$this; $i++) {
push @$elems, @{$this->_find($selector, $this->[$i])};
}
return $this->pushStack(
$selector =~ /[^+>] [^+>]/
? $this->_unique($elems)
: $elems
)
}
sub clone { # (events)
# TODO - Not sure if we need this one.
}
sub filter { # (selector)
# TODO - A kind of grep
}
sub add { # (selector)
# TODO - Some kind of merge
}
sub is { # (selector)
# TODO - One element matches the selector
}
sub hasClass {
my ($this, $selector) = @_;
$this.is(".$selector");
}
sub val { # (value)
# TODO Get/set
}
# XXX - Not really ported yet.
sub html {
my $this = shift;
return unless @$this;
if (@_) {
for (@$this) {
next unless ref($_);
$_->innerHTML(@_);
}
return $this;
}
return $this->[0]->innerHTML(@_);
}
# Not a jQuery function.
sub toHtml {
my $this = shift;
return unless @$this;
return $this->[0]->toHTML;
}
# TODO - Not tested
sub replaceWith { # (value)
my ($this, $value) = @_;
return $this->after($value)->remove;
}
# TODO - Not tested
sub eq {
my ($this, $i) = @_;
return $this->pushStack($this->[$i]);
}
sub slice { #(i, j)
# TODO - Behave like JS slice()
}
sub map {
my ($this, $callback) = @_;
return $this->pushStack(__map($this, sub {
my ($elem, $i) = @_;
return $callback->($elem, $i, $elem);
}));
}
# TODO - Not tested
sub andSelf {
my $this = shift;
return $this.add($this->prevObject);
}
sub data { # (key, value)
# TODO - Not sure
}
sub removeData { # (key)
# TODO - Not Sure
}
sub domManip {
my ($this, $args, $table, $reverse, $callback) = @_;
my $elems;
return $this->each(sub {
if (not defined $elems) {
$elems = $args;
@$elems = reverse @$elems
if $reverse;
}
pQuery::each($elems, sub {
$callback->($this, $_);
});
});
}
#------------------------------------------------------------------------------#
# "Class" methods
#------------------------------------------------------------------------------#
# sub noConflict {}
# sub isFunction {}
# sub isXMLdoc {}
# sub globalEval {}
sub _nodeName {
my ($this, $elem, $name) = @_;
return $elem->nodeName &&
uc($elem->nodeName) eq uc($name);
}
# sub cache {}
# sub data {}
# sub removeData {}
# sub each {}
# sub prop {}
# sub className {}
# sub swap {}
# sub css {}
# sub curCSS {}
# sub clean {}
# sub attr {}
sub _trim {
(my $string = $_[1]) =~ s/^\s+|\s+$//g;
return $string;
}
# sub makeArray {}
# sub inArray {}
sub _merge {
push @{$_[1]}, @{$_[2]};
return $_[1];
}
sub _unique {
my $seen = {};
return [ grep {not $seen->{$_}++} @{$_[1]} ];
}
sub _grep {
my ($this, $elems, $callback, $inv) = @_;
my $ret = [];
for (my ($i, $length) = (0, scalar(@$elems)); $i < $length; $i++) {
push @$ret, $elems->[$i]
if (not $inv and &$callback($elems->[$i], $i)) or
($inv and not &$callback($elems->[$i], $i));
}
return $ret;
}
# sub map {}
#------------------------------------------------------------------------------#
# Selector functions
#------------------------------------------------------------------------------#
my $chars = '(?:[\w\x{128}-\x{FFFF}*_-]|\\.)';
my $quickChild = qr/^>\s*($chars+)/;
my $quickId = qr/^($chars+)(#)($chars+)/;
my $quickClass = qr/^(([#.]?)($chars*))/;
my $expr = {
# XXX Can't figure out how to create tests for these yet :(
"" => sub {
die 'pQuery selector error #1001. Please notify ingy@cpan.org';
},
"#" => sub {
die 'pQuery selector error #1002. Please notify ingy@cpan.org';
},
":" => {
# Position Checks
lt => sub { return $_[1] < $_[2][3] },
gt => sub { return $_[1] > $_[2][3] },
nth => sub { return $_[2][3] == $_[1] },
eq => sub { return $_[2][3] == $_[1] },
first => sub { return $_[1] == 0 },
last => sub { return $_[1] == $#{$_[3]} },
even => sub { return $_[1] % 2 == 0 },
odd => sub { return $_[1] % 2 },
# Child Checks
"first-child" => sub {
return $_[0]->parentNode->getElementsByTagName("*")->[0] == $_[0];
},
"last-child" => sub {
return pQuery->_nth(
$_[0]->parentNode->lastChildRef,
1,
"previousSiblingRef"
) == $_[0];
},
"only-child" => sub {
return ! pQuery->_nth(
$_[0]->parentNode->lastChildRef,
2,
"previousSiblingRef"
);
},
# Parent Checks
parent => sub { return $_[0]->firstChild ? 1 : 0 },
empty => sub { return $_[0]->firstChild ? 0 : 1 },
# Text Check
contains => sub { return index(pQuery($_[0])->text, $_[2][3]) >= 0 },
# XXX Finish porting these if it makes sense...
# // Visibility
# visible: function(a){return "hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},
# hidden: function(a){return "hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},
#
# // Form attributes
# enabled: function(a){return !a.disabled;},
# disabled: function(a){return a.disabled;},
# checked: function(a){return a.checked;},
# selected: function(a){return a.selected||jQuery.attr(a,"selected");},
#
# // Form elements
# text: function(a){return "text"==a.type;},
# radio: function(a){return "radio"==a.type;},
# checkbox: function(a){return "checkbox"==a.type;},
# file: function(a){return "file"==a.type;},
# password: function(a){return "password"==a.type;},
# submit: function(a){return "submit"==a.type;},
# image: function(a){return "image"==a.type;},
# reset: function(a){return "reset"==a.type;},
# button: function(a){return "button"==a.type||jQuery.nodeName(a,"button");},
# input: function(a){return /input|select|textarea|button/i.test(a.nodeName);},
# :has()
# XXX - The first form should work. Indicates that context is messed up.
# has => sub { return pQuery->find($_[2][3], $_[0])->length ? 1 : 0 },
has => sub { return pQuery($_[0])->find($_[2][3])->length ? 1 : 0 },
# :header
header => sub { return $_[0]->nodeName =~ /^h[1-6]$/i },
},
};
# The regular expressions that power the parsing engine
my $parse = [
# Match: [@value='test'], [@foo]
qr/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,
# Match: :contains('foo')
qr/^(:)([\w-]+)\("?'?(.*?(\(.*?\))?[^(]*?)"?'?\)/,
# Match: :even, :last-chlid, #id, .class
qr/^([:.#]*)($chars+)/,
];
sub _multiFilter {
# XXX - Port me.
}
sub _find {
my ($this, $t, $context) = @_;
return [ $t ]
if ref($t);
return []
unless ref($context) and
$context->can('nodeType') and
$context->nodeType == 1;
$context ||= $document or return [];
my ($ret, $done, $last, $nodeName) = ([$context], [], '', '');
while ($t and $last ne $t) {
my $r = [];
$last = $t;
$t = $this->_trim($t);
my $foundToken = 0;
my $re = $quickChild;
if ($t =~ $re) {
$nodeName = uc($1);
for (my $i = 0; $ret->[$i]; $i++) {
for (my $c = $ret->[$i]; $c; $c = $c->nextSiblingRef) {
if ($c->nodeType == 1 and
(
$nodeName eq "*" or
uc($c->nodeName) eq $nodeName
)
) { push @$r, $c }
}
}
}
else {
if ($t =~ s/^([>+~])\s*(\w*)//) {
$r = [];
my $merge = {};
$nodeName = uc($2);
my $m = $1;
for (my ($j, $rl) = (0, scalar(@$ret)); $j < $rl; $j++) {
my $n = ($m eq "~" or $m eq "+")
? $ret->[$j]->nextSiblingRef
: $ret->[$j]->firstChild;
for (; $n; $n = $n->nextSiblingRef) {
if ($n->nodeType == 1) {
my $id = jQuery->data($n);
last if ($m eq "~" and $merge->{$id});
if (not $nodeName or
uc($n->nodeName) eq $nodeName
) {
$merge->{$id} = 1 if $m eq "~";
push @$r, $n;
}
last if $m eq "+";
}
}
}
$ret = $r;
$t = $this.trim($t);
$foundToken = 1;
}
}
my $m;
if ($t and not $foundToken) {
if ($t =~ s/^,//) {
shift @$ret if $context == $ret->[0];
$done = $this._merge($done, $ret);
$r = $ret = [$context];
$t = " $t";
}
else {
if ($t =~ s/$quickId//) {
$m = [0, $2, $3, $1];
}
else {
if ($t =~ s/$quickClass//) {
$m = [$1, $2, $3];
}
}
$m->[2] =~s/\\//g;
my $elem = $ret->[-1];
my $oid;
if ($m->[1] eq "#" and
$elem and
$elem->can('getElementById')
) {
$oid = $elem->getElementById($m->[2]);
$ret = $r = (
$oid &&
(not $m->[3] or $this->_nodeName($oid, $m->[3]))
) ? [$oid] : [];
}
else {
for (my $i = 0; $ret->[$i]; $i++) {
my $tag = ($m->[1] eq "#" and $m->[3])
? $m->[3]
: ($m->[1] ne "" or $m->[0] eq "")
? "*"
: $m->[2];
$r = $this->_merge(
$r,
$ret->[$i]->getElementsByTagName($tag)
);
}
$r = $this->_classFilter($r, $m->[2])
if ($m->[1] eq ".");
if ($m->[1] eq "#") {
my $tmp = [];
for (my $i = 0; $r->[$i]; $i++) {
if ($r->[$i]->getAttribute("id") eq $m->[2]) {
$tmp = [ $r->[$i] ];
last;
}
}
$r = $tmp;
}
$ret = $r;
}
}
}
if ($t) {
my $val = $this->_filter($t, $r);
$ret = $r = $val->{r};
$t = $this->_trim($val->{t});
}
}
# $ret = [] if $t;
die "selector error: $t" if $t;
shift(@$ret) if $ret and @$ret and $context == $ret->[0];
$done = $this->_merge($done, $ret);
return $done;
}
sub _classFilter {
my ($this, $r, $m, $not) = @_;
$m = " $m ";
my $tmp = [];
for (my $i = 0; $r->[$i]; $i++) {
my $pass = CORE::index((" " . $r->[$i]->className . " "), $m) >= 0;
push @$tmp, $r->[$i]
if not $not and $pass or $not and not $pass;
}
return $tmp;
}
sub _filter {
my ($this, $t, $r, $not) = @_;
my $last = '';
while ($t and $t ne $last) {
$last = $t;
my ($p, $m) = ($parse);
for (my $i = 0; $p->[$i]; $i++) {
my $re = $p->[$i];
if ($t =~ s/$re//) {
$m = [0, $1, $2, $3, $4, $5];
$m->[2] =~ s/\\//g;
last;
}
}
last
if not $m;
if ( $m->[1] eq ":" && $m->[2] eq "not") {
$r = ($m->[3] =~ $isSimple)
? $this->_filter($m->[3], $r, 1)->{r}
: pQuery($r)->not($m->[3]);
}
elsif ($m->[1] eq ".") {
$r = $this->_classFilter($r, $m->[2], $not);
}
elsif ($m->[1] eq "[") {
my ($tmp, $type) = ([], $m->[3]);
for (my ($i, $rl) = (0, scalar(@$r)); $i < $rl; $i++) {
my $a = $r->[$i];
my $z = $a->{($this->_props->{$m->[2]} || $m->[2])};
if (not defined $z or $m->[2] =~ /href|src|selected/) {
$z = $this->attr($a, $m->[2]) || '';
}
if (
((
$type eq "" and $z or
$type eq "=" and $z eq $m->[5] or
$type eq "!=" and $z ne $m->[5] or
$type eq "^=" and not index($z, $m->[5]) or
$type eq '$=' and substr($z, (0-length($m->[5]))) or
($type eq "*=" or $type eq "~=") and
index($z, $m->[5]) >= 0
) ? 1 : 0) ^ ($not ? 1 : 0)
) { push @$tmp, $a }
}
$r = $tmp;
}
elsif ($m->[1] eq ":" && $m->[2] eq "nth-child") {
# XXX - Finish porting this. Not sure how useful it is though...
}
else {
my $fn = $expr->{$m->[1]};
if (ref($fn) eq "HASH") {
$fn = $fn->{ $m->[2] };
}
# if ( typeof fn == "string" )
# fn = eval("false||function(a,i){return " + fn + ";}");
$fn = sub { 0 }
if ref($fn) ne 'CODE';
$r = $this->_grep(
$r,
sub {
return &$fn($_[0], $_[1], $m, $r);
},
$not
);
}
}
return { r => $r, t => $t };
}
sub _dir {
# XXX - Port me.
}
sub _nth {
my ($this, $cur, $result, $dir, $elem) = @_;
$result ||= 1;
my $num = 0;
for (; $cur; $cur = $cur->$dir) {
last if (ref($cur) and $cur->nodeType == 1 and ++$num == $result);
}
return $cur;
}
sub _sibling {
# XXX - Port me.
}
sub _props {
return {
for => "htmlFor",
class => "className",
# float => styleFloat,
# cssFloat => styleFloat,
# styleFloat => styleFloat,
innerHTML => "innerHTML",
className => "className",
value => "value",
disabled => "disabled",
checked => "checked",
readonly => "readOnly",
selected => "selected",
maxlength => "maxLength",
selectedIndex => "selectedIndex",
defaultValue => "defaultValue",
tagName => "tagName",
nodeName => "nodeName"
};
}
#------------------------------------------------------------------------------#
# These methods need to go down here because they are Perl builtins.
#------------------------------------------------------------------------------#
sub length { return $#{$_[0]} + 1 }
sub index {
my ($this, $elem) = @_;
my $ret = -1;
$this->each(sub {
$ret = shift
if (ref($_) && ref($elem)) ? ($_ == $elem) : ($_ eq $elem);
});
return $ret;
}
sub not { # (selector)
# TODO - An anti-grep??
}
#------------------------------------------------------------------------------#
# Helper functions (not methods)
#------------------------------------------------------------------------------#
sub _new_from_url {
require Encode;
my $this = shift;
my $url = shift;
my $response = $this->_web_get($url);
return $this
unless $response->is_success;
my $html = Encode::decode_utf8($response->content);
@$this = pQuery::DOM->fromHTML($html);
return $this;
}
sub _web_get {
my $this = shift;
my $url = shift;
require LWP::UserAgent;
$lwp_user_agent ||= LWP::UserAgent->new;
my $request = HTTP::Request->new(GET => $url);
my $response = $lwp_user_agent->request($request);
return $response;
}
sub _to_text {
my ($elem, $text) = @_;
if (ref $elem) {
for my $child (@{$elem->{_content}}) {
_to_text($child, $text);
}
}
else {
$$text .= $elem;
}
}
sub _find_elems {
my ($elem, $selector, $elems) = @_;
return unless ref $elem;
if ($selector =~ /^\w+$/) {
if ($elem->{_tag} eq $selector) {
push @$elems, $elem;
}
}
for my $child (@{$elem->{_content}}) {
_find_elems($child, $selector, $elems);
}
}
#------------------------------------------------------------------------------#
# THE AMAZING PQUERY
#------------------------------------------------------------------------------#
package PQUERY;
sub new {
my $class = shift;
my $this = bless [], $class;
@$this = map 'pQuery'->new($_), @_;
return $this;
}
sub AUTOLOAD {
(my $method = $PQUERY::AUTOLOAD) =~ s/.*:://;
my $this = shift;
my @args = @_;
$this->EACH(sub {
my $i = shift;
$this->[$i] = $_->$method(@args);
});
return $this;
}
sub EACH {
my ($this, $sub) = @_;
my $index = 0;
&$sub($index++) for @$this;
return $this;
}
sub DESTROY {}
1;
=head1 SYNOPSIS
use pQuery;
pQuery("http://google.com/search?q=pquery")
->find("h2")
->each(sub {
my $i = shift;
print $i + 1, ") ", pQuery($_)->text, "\n";
});
=head1 DESCRIPTION
pQuery is a pragmatic attempt to port the jQuery JavaScript framework to
Perl. It is pragmatic in the sense that it switches certain JavaScript
idioms for Perl ones, in order to make the use of it concise. A primary
goal of jQuery is to "Find things and do things, concisely". pQuery has
the same goal.
pQuery exports a single function called C<pQuery>. (Actually, it also
exports the special C<PQUERY> function. Read below.) This function acts
a constructor and does different things depending on the arguments you
give it. This is discussed in the L<CONSTRUCTORS> section below.
A pQuery object acts like an array reference (because, in fact, it is).
Typically it is an array of pQuery::DOM elements, but it can be an array
of anything.
pQuery::DOM is roughly an attempt to duplicate JavaScript's DOM in
Perl. It subclasses HTML::TreeBuilder/HTML::Element so there are a
few differences to be aware of. See the L<pQuery::DOM> documentation
for details.
Like jQuery, pQuery methods return a pQuery object; either the
original object or a new derived object. All pQuery L<METHODS> are
described below.
=head1 THE ROYAL PQUERY
The power of jQuery is that single method calls can apply to many DOM
objects. pQuery does the exact same thing but can take this one step
further. A single PQUERY object can contain several DOMs!
Consider this example:
> perl -MpQuery -le 'PQUERY(\
map "http://search.cpan.org/~$_/", qw(ingy gugod miyagawa))\
->find("table")->eq(1)->find("tr")\
->EACH(sub{\
printf("%40s - %s Perl distributions\n", $_->url, $_->length - 1)\
})'
http://search.cpan.org/~ingy/ - 88 Perl distributions
http://search.cpan.org/~gugod/ - 86 Perl distributions
http://search.cpan.org/~miyagawa/ - 138 Perl distributions
The power lies in C<PQUERY>, a special constructor that creates a
wrapper object for many pQuery objects, and applies all methods called
on it to all the pQuery objects it contains.
=head1 CONSTRUCTORS
The pQuery constructor is an exported function called C<pQuery>. It does
different things depending on the arguments you pass it.
=head2 URL
If you pass pQuery a URL, it will attempt to get the page and use its
HTML to create a pQuery::DOM object. The pQuery object will contain the
top level pQuery::DOM object.
pQuery("http://google.com");
It will also set the global variable C<$pQuery::document> to the
resulting DOM object. Future calls to pQuery methods will use this
document if none other is supplied.
=head2 HTML
If you already have an HTML string, pass it to pQuery and it will create
a pQuery::DOM object. The pQuery object will contain the top level
pQuery::DOM object.
pQuery("<p>Hello <b>world</b>.</p>");
=head2 FILE
If you pass pQuery a string that ends with .html and contains no
whitespace, pQuery will assume it is the name of a file containing html
and will read the contents and parse the HTML into a new DOM.
pQuery("my/webpage.html");
=head2 Selector String
You can create a pQuery object with a selector string just like in
jQuery. The problem is that Perl doesn't have a global document object
lying around like JavaScript does.
One thing you can do is set the global variable, C<$pQuery::document>,
to a pQuery::DOM document. This will be used by future selectors.
Another thing you can do is pass the document to select on as the second
parameter. (jQuery also has this second, context parameter).
pQuery("table.mygrid > td:eq(7)", $dom);
=head2 pQuery Object
You can create a new pQuery object from another pQuery object. The new
object will be a shallow copy.
my $pquery2 = pQuery($pquery1);
=head2 Array Reference
You can create a pQuery object as an array of anything you want; not
just pQuery::DOM elements. This can be useful to use the C<each> method to
iterate over the array.
pQuery(\ @some_array);
=head2 No Arguments
Calling pQuery with no arguments will return a pQuery object that is
just an empty array reference. This is useful for using it to call class
methods that don't need a DOM object.
my $html = pQuery->get("http://google.com")->content;
=head2 PQUERY(@list_of_pQuery_constructor_args)
The PQUERY constructor takes a list of any of the above pQuery forms and
creates a PQUERY object with one pQuery object per argument.
=head1 METHODS
This is a reference of all the methods you can call on a pQuery object. They
are almost entirely ported from jQuery.
=head2 pquery()
Returns the version number of the pQuery module.
=head2 size()
Returns the number of elements in the pQuery object.
=head2 length()
Also returns the number of elements in the pQuery object.
=head2 each($sub)
This method takes a subroutine reference and calls the subroutine once
for each member of the pQuery object that called C<each>. When the
subroutine is called it is passed an integer count starting at 0 at
incremented once for each call. It is also passed the current member of
the pQuery object in C<$_>.
pQuery("td", $dom)->each(sub {
my $i = shift;
print $i, " => ", pQuery($_)->text(), "\n";
});
The C<each> method returns the pQuery object that called it.
=head2 EACH($sub)
This method can only be called on PQUERY objects. The sub is called once
for every pQuery object within the PQUERY object. If you call C<each()>
on a PQUERY object, it iterates on all the DOM objects of each pQuery
object (as you would expect).
=head2 find($selector)
This method will search all the pQuery::DOM elements of the its caller for
all sub elements that match the selector string. It will return a new
pQuery object containing all the elements found.
my $pquery2 = $pquery1->find("h1,h2,h3");
=head2 html() html($html)
This method is akin to the famous JavaScript/DOM function C<innerHTML>.
If called with no arguments, this will return the the B<inner> HTML
string of the B<first> DOM element in the pQuery object.
If called with an HTML string argument, this will set the inner HTML of all
the DOM elements in the pQuery object.
=head2 toHtml()
This extremely handy method is not ported from jQuery. Maybe jQuery will
port it back some day. :)
This function takes no arguments, and returns the B<outer> HTML of the first
DOM object in the pQuery object. Outer HTML means the HTML of the current
object and its inner HTML.
For example:
pQuery('<p>I <b>like</b> pie</p>')->toHtml;
returns:
<p>I <b>like</b> pie</p>
while:
pQuery('<p>I <b>like</b> pie</p>')->html();
returns:
I <b>like</b> pie
=head2 end()
Revert the most recent 'destructive' operation, changing the set of
matched elements to its previous state (right before the destructive
operation). This method is useful for getting back to a prior context
when chaining pQuery methods.
pQuery("table", $dom) # Select all the tables
->find("td") # Select all the tds
->each(sub { ... }) # Do something with the tds
->end() # Go back to the tables selection
->each(sub { ... }); # Do something with the tables
=head2 get($index) get($url)
If this method is passed an integer, it will return that specific
element from the array of elements in the pQuery object.
Givn a URL, this method will fetch the HTML content of the URL and
return a HTML::Response object.
my $html = pQuery->get("http://google.com")->content;
=head2 index($elem)
This method returns the index number of its argument if the elem is in the
current pQuery object. Otherwise it returns -1.
=head1 UNDER CONSTRUCTION
This module is still being written. The documented methods all work as
documented (but may not be completed ports of their jQuery
counterparts yet).
The selector syntax is still very limited. (Single tags, IDs and classes
only).
Version 0.02 added the pQuery::DOM class which is a huge improvement, and
should facilitate making the rest of the porting easy.
But there is still much more code to port. Stay tuned...