API:EPrints/Search - Revision history

Libjlrs: /* add_field */

2018-07-06T08:18:35Z

add_field

← Older revision		Revision as of 08:18, 6 July 2018
Line 196:		Line 196:
	To search for items with no value, use something similar to this - explicitly setting the value to undef.:		To search for items with no value, use something similar to this - explicitly setting the value to undef.:
	<source lang="perl">		<source lang="perl">
			### Example: search for items in the review area with no date set.
	my $ds = $session->dataset( "buffer" );		my $ds = $session->dataset( "buffer" );
	my $searchexp = $ds->prepare_search();		my $searchexp = $ds->prepare_search();

Libjlrs: /* add_field */

2018-07-06T08:17:52Z

add_field

← Older revision		Revision as of 08:17, 6 July 2018
Line 191:		Line 191:

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

			Note relating to the <code>for EX matches, NULL = is_null</code> documentation above.

			To search for items with no value, use something similar to this - explicitly setting the value to undef.:
			<source lang="perl">
			my $ds = $session->dataset( "buffer" );
			my $searchexp = $ds->prepare_search();
			$searchexp->add_field(
			fields => [
			$ds->field( 'date' ),
			],
			value => undef,
			match => "EX",
			);
			</source>


	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	<!-- Pod2Wiki=head_clear -->		<!-- Pod2Wiki=head_clear -->

	===clear===		===clear===

Tdb01r at 11:00, 24 July 2013

2013-07-24T11:00:21Z

← Older revision		Revision as of 11:00, 24 July 2013
Line 14:		Line 14:
	<!-- Pod2Wiki=head_description -->		<!-- Pod2Wiki=head_description -->
	==DESCRIPTION==		==DESCRIPTION==
	The Search object represents the conditions of a single search.		The Search object represents the conditions of a single search.

	Executing a search returns an [[API:EPrints/List\|EPrints::List]] object.		Executing a search returns an [[API:EPrints/List\|EPrints::List]] object.
Line 20:		Line 20:
	A search expression can also render itself as a web-form, populate itself with values from that web-form and render the results as a web page.		A search expression can also render itself as a web-form, populate itself with values from that web-form and render the results as a web page.

	[[API:EPrints/Search~~/Plugin~~\|EPrints::~~Search~~::~~Plugin~~]] provides a pluggable architecture for searching EPrints.		[[API:EPrints/Plugin/Search\|EPrints::Plugin::Search]] provides a pluggable architecture for searching EPrints.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 10:58, 24 July 2013

2013-07-24T10:58:44Z

Show changes

Pm705@zepler.net at 16:34, 12 February 2010

2010-02-12T16:34:08Z

Show changes

Cjg at 19:13, 25 August 2009

2009-08-25T19:13:23Z

← Older revision		Revision as of 19:13, 25 August 2009
Line 31:		Line 31:
	my $ds = $handle->get_dataset( "archive" );		my $ds = $handle->get_dataset( "archive" );

	my $~~searchexp~~ = EPrints::Search->new(		my $search = EPrints::Search->new(
	satisfy_all => 1,		satisfy_all => 1,
	handle => $handle,		handle => $handle,
Line 38:		Line 38:
	);		);

	$~~searchexp~~->add_field( $ds->get_field( "type" ), qw/ article book /, "EQ", "ANY" );		$search->add_field( $ds->get_field( "type" ), qw/ article book /, "EQ", "ANY" );

	# getting the results:		# getting the results:
	my $list = $~~searchexp~~->perform_search;		my $list = $search->perform_search;

	# Dispose of the Search object:		# Dispose of the Search object:
	$~~searchexp~~->dispose;		$search->dispose;

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 66:		Line 66:

	<!-- Pod2Wiki=item_new --></div>		<!-- Pod2Wiki=item_new --></div>
	===$~~searchexp~~ = EPrints::Search->new( %params )===		===$search = EPrints::Search->new( %params )===

	Create a new search expression.		Create a new search expression.
Line 126:		Line 126:
	where the meaning is the same as for search configuration in cfg.d/eprint_search_*.pl		where the meaning is the same as for search configuration in cfg.d/eprint_search_*.pl

	Search fields can also be added to the search expression after it has been constructed (by using $~~searchexp~~->add_field(...)).		Search fields can also be added to the search expression after it has been constructed (by using $search->add_field(...)).

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 222:		Line 222:

	<!-- Pod2Wiki=item_perform_search --></div>		<!-- Pod2Wiki=item_perform_search --></div>
	===$results = $~~searchexp~~->perform_search===		===$results = $search->perform_search===

	Execute this search and return a [[API:EPrints/List\|EPrints::List]] object representing the results.		Execute this search and return a [[API:EPrints/List\|EPrints::List]] object representing the results.
Line 232:		Line 232:

	<!-- Pod2Wiki=item_add_field --></div>		<!-- Pod2Wiki=item_add_field --></div>
	===$searchfield = $~~searchexp~~->add_field( $metafields, $value, $match, $merge, $id, $filter, $show_help )===		===$searchfield = $search->add_field( $metafields, $value, $match, $merge, $id, $filter, $show_help )===

	Adds the new search field $metafields (which is either a single [[API:EPrints/MetaField\|EPrints::MetaField]] or a list of fields in an array ref) with default $value. If a search field already exists, the value of that field is replaced with $value.		Adds the new search field $metafields (which is either a single [[API:EPrints/MetaField\|EPrints::MetaField]] or a list of fields in an array ref) with default $value. If a search field already exists, the value of that field is replaced with $value.
Line 242:		Line 242:

	<!-- Pod2Wiki=item_clear --></div>		<!-- Pod2Wiki=item_clear --></div>
	===$~~searchexp~~->clear===		===$search->clear===

	Clear the search values of all search fields in the expression.		Clear the search values of all search fields in the expression.
Line 254:		Line 254:

	<!-- Pod2Wiki=item_clone --></div>		<!-- Pod2Wiki=item_clone --></div>
	===$~~newsearchexp~~ = $~~searchexp~~->clone===		===$newsearch = $search->clone===

	Return a new search expression which is a duplicate of this one.		Return a new search expression which is a duplicate of this one.
Line 264:		Line 264:

	<!-- Pod2Wiki=item_render_description --></div>		<!-- Pod2Wiki=item_render_description --></div>
	===$xhtml = $~~searchexp~~->render_description===		===$xhtml = $search->render_description===

	Return an XHTML DOM description of this search expressions current parameters.		Return an XHTML DOM description of this search expressions current parameters.
Line 274:		Line 274:

	<!-- Pod2Wiki=item_render_conditions_description --></div>		<!-- Pod2Wiki=item_render_conditions_description --></div>
	===$xhtml = $~~searchexp~~->render_conditions_description===		===$xhtml = $search->render_conditions_description===

	Return an XHTML DOM description of this search expressions conditions. ie title is "foo"		Return an XHTML DOM description of this search expressions conditions. ie title is "foo"
Line 284:		Line 284:

	<!-- Pod2Wiki=item_render_order_description --></div>		<!-- Pod2Wiki=item_render_order_description --></div>
	===$xhtml = $~~searchexp~~->render_order_description===		===$xhtml = $search->render_order_description===

	Return an XHTML DOM description of how this search is ordered.		Return an XHTML DOM description of how this search is ordered.
Line 294:		Line 294:

	<!-- Pod2Wiki=item_set_property --></div>		<!-- Pod2Wiki=item_set_property --></div>
	===$~~searchexp~~->set_property( $property, $value );===		===$search->set_property( $property, $value );===

	Set any single property of this search, such as the order.		Set any single property of this search, such as the order.

Cjg at 14:03, 24 August 2009

2009-08-24T14:03:58Z

Show changes

Cjg at 13:08, 20 August 2009

2009-08-20T13:08:41Z

← Older revision		Revision as of 13:08, 20 August 2009
Line 3:		Line 3:
	-->		-->
	__NOTOC__		__NOTOC__
	{{Pod2Wiki}}{{API:Source\|file=EPrints/Search.pm\|package_name=EPrints::Search}}[[Category:API\|Search]]<div><!-- Edit below this comment -->		{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/Search.pm\|package_name=EPrints::Search}}[[Category:API\|Search]]<div><!-- Edit below this comment -->

Cjg at 16:01, 19 August 2009

2009-08-19T16:01:20Z

Show changes

Cjg at 15:59, 19 August 2009

2009-08-19T15:59:59Z

← Older revision	Revision as of 15:59, 19 August 2009
Line 1:	Line 1:
		wewe