WWW::Ruler::Piece - a piece from "cut_off" in WWW::Ruler work. An instances of this object are returned from "cut_off" in WWW::Ruler.
Returns an array of ruler items. Every item of array is hashref with keys:
Here string name of type of ruler item:
Symbol of button [ < ] for example. An accompanying key is "page_number"
The button of page number. An accompanying keys are "page_number" and key "current_page"
Symbol of button [ > ] for example. An accompanying key is "page_number"
The symbol ... in ruler. It doesn't have any accompanying keys.
The digital number of page (starts from 1) for this item ruler.
If this key exists its value is true. This key exists only for current page.
A start index of array (a base is zero) for cutting. This number can be used as left value of range operator ..
..
A end index of array (a base is zero) for cutting. This number can be used as right value of range operator ..
A size of current page. It shows how many items in current page.
If a piece is located outside of array then returns true else false. It can happen when page_number is <= 0 or page_number is more than a maximal possible page number for this data array. If "outside" returned a true then "start", "end" and "size" methods will return 0 and "ruler" returns an empty array.
This module has been written by Perlover <perlover@perlover.com>
This module is free software and is published under the same terms as Perl itself.
To install WWW::Ruler, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WWW::Ruler
CPAN shell
perl -MCPAN -e shell install WWW::Ruler
For more information on module installation, please visit the detailed CPAN module installation guide.