API:EPrints/DataObj/SavedSearch - Revision history

Pod2wiki at 17:29, 10 January 2022

2022-01-10T17:29:11Z

Pod2wiki at 17:28, 10 January 2022

2022-01-10T17:28:30Z

Pod2wiki at 00:06, 4 January 2022

2022-01-04T00:06:35Z

Show changes

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

2010-02-12T16:34:03Z

Tdb01r: Removing all content from page

2009-08-12T15:40:41Z

Removing all content from page

@@ Line 350: / Line 350: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=head_object_methods -->
+<!-- Pod2Wiki=head_utility_methods -->
-===Object Methods===
+===Utility Methods===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
-A saved search is a sub class of [[API:EPrints/DataObj|EPrints::DataObj]].
+A saved search is a sub class of [[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]].
 Each one belongs to one and only one user, although one user may own multiple saved searches.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 30: / Line 144: @@
 <!-- Pod2Wiki=head_instance_variables -->
 ==INSTANCE VARIABLES==
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 277: / Line 393: @@
 <!-- Pod2Wiki=head_see_also -->
 ==SEE ALSO==
-[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
+[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]], [[API:EPrints/DataObj|EPrints::DataObj]] and  [[API:EPrints/DataSet|EPrints::DataSet]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

← Older revision	Revision as of 16:34, 12 February 2010
Line 1:	Line 1:
	+	<!-- Pod2Wiki=_preamble_
	+	This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
	+	-->
	+	__NOTOC__
	+	{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj/SavedSearch.pm\|package_name=EPrints::DataObj::SavedSearch}}[[Category:API\|SavedSearch]]<div><!-- Edit below this comment -->

	+
	+	<!-- Pod2Wiki=head_name --></div>
	+	==NAME==
	+	'''EPrints::DataObj::SavedSearch''' - Single saved search.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=head_description --></div>
	+	==DESCRIPTION==
	+	A saved search is a sub class of EPrints::DataObj.
	+
	+	Each one belongs to one and only one user, although one user may own multiple saved searches.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_get_system_field_info --></div>
	+	===$field_config = EPrints::DataObj::SavedSearch->get_system_field_info===
	+
	+	Return an array describing the system metadata of the saved search. dataset.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_get_dataset_id --></div>
	+	===$dataset = EPrints::DataObj::SavedSearch->get_dataset_id===
	+
	+	Returns the id of the [[API:EPrints/DataSet\|EPrints::DataSet]] object to which this record belongs.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_commit --></div>
	+	===$success = $saved_search->commit( [$force] )===
	+
	+	Write this object to the database.
	+
	+	If $force isn't true then it only actually modifies the database if one or more fields have been changed.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_get_user --></div>
	+	===$user = $saved_search->get_user===
	+
	+	Return the EPrints::User which owns this saved search.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_make_searchexp --></div>
	+	===$searchexp = $saved_search->make_searchexp===
	+
	+	Return a EPrints::Search describing how to find the eprints which are in the scope of this saved search.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_send_out_alert --></div>
	+	===$saved_search->send_out_alert===
	+
	+	Send out an email for this subcription. If there are no matching new items then an email is only sent if the saved search has mailempty set to true.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_process_set --></div>
	+	===EPrints::DataObj::SavedSearch::process_set( $session, $frequency );===
	+
	+	Static method. Calls send_out_alert on every saved search with a frequency matching $frequency.
	+
	+	Also saves a file logging that the alerts for this frequency was sent out at the current time.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_get_last_timestamp --></div>
	+	===$timestamp = EPrints::DataObj::SavedSearch::get_last_timestamp( $session, $frequency );===
	+
	+	Static method. Return the timestamp of the last time this frequency of alert was sent.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=item_has_owner --></div>
	+	===$boolean = $user->has_owner( $possible_owner )===
	+
	+	True if the users are the same record.
	+
	+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	+	<h4><span style='display:none'>User Comments</span></h4>
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision		Revision as of 15:40, 12 August 2009
Line 1:		Line 1:
−	~~<!-- Pod2Wiki=_preamble_~~
−	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
−	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj/SavedSearch.pm\|package_name=EPrints::DataObj::SavedSearch}}[[Category:API\|SavedSearch]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~'''EPrints::DataObj::SavedSearch''' - Single saved search.~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
−	~~A saved search is a sub class of EPrints::DataObj.~~
−
−	~~Each one belongs to one and only one user, although one user may own multiple saved searches.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==~~
−
−	~~$field_config = EPrints::DataObj::SavedSearch->get_system_field_info~~
−
−	~~Return an array describing the system metadata of the saved search. dataset.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new -->==new==~~
−
−	~~$saved_search = EPrints::DataObj::SavedSearch->new( $session, $id )~~
−
−	~~Return new Saved Search object, created by loading the Saved Search with id $id from the database.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new_from_data -->==new_from_data==~~
−
−	~~$saved_search = EPrints::DataObj::SavedSearch->new_from_data( $session, $data )~~
−
−	~~Construct a new EPrints::DataObj::SavedSearch object based on the $data hash reference of metadata.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_defaults -->==get_defaults==~~
−
−	~~$defaults = EPrints::DataObj::SavedSearch->get_defaults( $session, $data )~~
−
−	~~Return default values for this object based on the starting data.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_remove -->==remove==~~
−
−	~~$success = $saved_search->remove~~
−
−	~~Remove the saved search.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_commit -->==commit==~~
−
−	~~$success = $saved_search->commit( [$force] )~~
−
−	~~Write this object to the database.~~
−
−	~~If $force isn't true then it only actually modifies the database if one or more fields have been changed.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_user -->==get_user==~~
−
−	~~$user = $saved_search->get_user~~
−
−	~~Return the EPrints::User which owns this saved search.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_make_searchexp -->==make_searchexp==~~
−
−	~~$searchexp = $saved_search->make_searchexp~~
−
−	~~Return a EPrints::Search describing how to find the eprints which are in the scope of this saved search.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_send_out_alert -->==send_out_alert==~~
−
−	~~$saved_search->send_out_alert~~
−
−	~~Send out an email for this subcription. If there are no matching new items then an email is only sent if the saved search has mailempty set to true.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_process_set -->==process_set==~~
−
−	~~EPrints::DataObj::SavedSearch::process_set( $session, $frequency );~~
−
−	~~Static method. Calls send_out_alert on every saved search with a frequency matching $frequency.~~
−
−	~~Also saves a file logging that the alerts for this frequency was sent out at the current time.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_last_timestamp -->==get_last_timestamp==~~
−
−	~~$timestamp = EPrints::DataObj::SavedSearch::get_last_timestamp( $session, $frequency );~~
−
−	~~Static method. Return the timestamp of the last time this frequency of alert was sent.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_has_owner -->==has_owner==~~
−
−	~~$boolean = $user->has_owner( $possible_owner )~~
−
−	~~True if the users are the same record.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=~~
−	~~{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_create -->==create==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_url -->==get_url==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~

API:EPrints/DataObj/SavedSearch - Revision history

Pod2wiki at 17:29, 10 January 2022

Pod2wiki at 17:28, 10 January 2022

Pod2wiki at 00:06, 4 January 2022

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

Tdb01r: Removing all content from page

Tdb01r: New page: