[Openinteract-commits] CVS: OpenInteract2/lib/OpenInteract2/Action CommonSearch.pm,1.21,1.22

[Chris W. <la...@us...>]

Update of /cvsroot/openinteract/OpenInteract2/lib/OpenInteract2/Action
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv32738

Modified Files:
	CommonSearch.pm 
Log Message:
OIN-122: update docs to reflect modifications


Index: CommonSearch.pm
===================================================================
RCS file: /cvsroot/openinteract/OpenInteract2/lib/OpenInteract2/Action/CommonSearch.pm,v
retrieving revision 1.21
retrieving revision 1.22
diff -C2 -d -r1.21 -r1.22
*** CommonSearch.pm	26 Feb 2005 03:52:19 -0000	1.21
--- CommonSearch.pm	26 Feb 2005 03:56:36 -0000	1.22
***************
*** 601,606 ****
  =item *
  
! B<iterator>: An L<SPOPS::Iterator|SPOPS::Iterator> with your search
! results.
  
  =item *
--- 601,606 ----
  =item *
  
! B<iterator>: An L<SPOPS::Iterator|SPOPS::Iterator> (or one of its
! subclasses) with your search results.
  
  =item *
***************
*** 612,629 ****
  modify the fieldnames in C<_search_customize()>.
  
- =back
- 
- And if you have set C<c_search_results_paged> (see below) to 'yes'
- you will also get:
- 
- =over 4
- 
  =item *
  
! B<page_num>: Page of the results we are currently on.
  
  =item *
  
! B<total_pages>: The total number of pages in the result set.
  
  =item *
--- 612,624 ----
  modify the fieldnames in C<_search_customize()>.
  
  =item *
  
! B<page_num>: Page of the results we are currently on. (If results not
! paged, always '1'.)
  
  =item *
  
! B<total_pages>: The total number of pages in the result set. (If
! results not paged, always '1'.)
  
  =item *
***************
*** 633,647 ****
  =item *
  
! B<search_id>: The ID of this search.
  
  =back
  
- If C<c_search_results_paged> is set to 'no', you will get nothing
- beyond the default. The only difference is that 'iterator' will
- contain all of your search results. If you would like to get all the
- results in a list so you can see how many there are, call 'get_all()'
- on the iterator and ask the returned arrayref how many members it
- contains.
- 
  =head1 METHODS FOR 'search'
  
--- 628,635 ----
  =item *
  
! B<search_id>: The ID of this search. (Not set if results not paged.)
  
  =back
  
  =head1 METHODS FOR 'search'