|
|
| 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 -->
| |
