Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
RT::Client::REST::SearUsersContributed Perl DRT::Client::REST::SearchResult(3)

NAME
       RT::Client::REST::SearchResult -- Search	results	representation.

SYNOPSIS
	 my $iterator =	$search->get_iterator;
	 my $count = $iterator->count;

	 while (defined(my $obj	= &$iterator)) {
	   # do	something with the $obj
	 }

DESCRIPTION
       This class is a representation of a search result.  This	is the type of
       the object you get back when you	call method "search()" on
       RT::Client::REST::Object-derived	objects.  It makes it easy to iterate
       over results and	find out just how many there are.

METHODS
       count
	   Returns the number of search	results.  This number will always be
	   the same unless you stick your fat dirty fingers into the object
	   and abuse it.  This number is not affected by calls to
	   "get_iterator()".

       get_iterator
	   Returns a reference to a subroutine which is	used to	iterate	over
	   the results.

	   Evaluating it in scalar context, returns the	next object or "undef"
	   if all the results have already been	iterated over.	Note that for
	   each	object to be instantiated with correct values, retrieve()
	   method is called on the object before returning it to the caller.

	   Evaluating the subroutine reference in list context returns a list
	   of all results fully	instantiated.  WARNING:	this may be expensive,
	   as each object is issued retrieve() method.	Subsequent calls to
	   the iterator	result in empty	list.

	   You may safely mix calling the iterator in scalar and list context.
	   For example:

	     $iterator = $search->get_iterator;

	     $first = &$iterator;
	     $second = &$iterator;
	     @the_rest = &$iterator;

	   You can get as many iterators as you	want --	they will not step on
	   each	other's	toes.

       new You should not have to call it yourself, but	just for the sake of
	   completeness, here are the arguments:

	     my	$search	= RT::Client::REST::SearchResult->new(
	       ids => [1 .. 10],
	       object => sub {	     # Yup, that's a closure.
		 RT::Client::REST::Ticket->new(
		   id => shift,
		   rt => $rt,
		 );
	       },
	     );

SEE ALSO
       RT::Client::REST::Object, RT::Client::REST.

AUTHOR
       Dmitri Tikhonov <dtikhonov@yahoo.com>

perl v5.24.1			  2015-11-27 RT::Client::REST::SearchResult(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=RT::Client::REST::SearchResult&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help