API EPrints::Session - Revision history

https://wiki.ext-9.eprints-hosting.org/w/index.php?action=history&feed=atom&title=API_EPrints%3A%3ASession API EPrints::Session - Revision history 2026-05-10T08:28:22Z Revision history for this page on the wiki MediaWiki 1.43.6 https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API_EPrints::Session&diff=6631&oldid=prev Tdb01r: Removing all content from page 2009-08-10T16:30:27Z

<p>Removing all content from page</p> <a href="https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API_EPrints::Session&diff=6631&oldid=6617">Show changes</a>

Tdb01r https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API_EPrints::Session&diff=6617&oldid=prev Tdb01r: New page: <!-- 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. -... 2009-08-10T16:15:49Z

<p>New page: [[Category:API]]<br /> =NAME=<br /> '''EPrints::Session''' - Single connection to the EPrints system<br /> <br /> =DESCRIPTION=<br /> This module is not really a session. The name is out of date, buthard to change.<br /> EPrints::Session represents a connection to the EPrints system. Itconnects to a single EPrints repository, and the database used bythat repository. Thus it has an associated EPrints::Database andEPrints::Repository object.<br /> Each "session" has a "current language". If you are running in a multilingual mode, this is used by the HTML rendering functions tochoose what language to return text in.<br /> The "session" object also knows about the current apache connection,if there is one, including the CGI parameters. <br /> If the connection requires a username and password then it can also give access to the EPrints::DataObj::User object representing the user who iscausing this request. <br /> The session object also provides many methods for creating XHTML results which can be returned via the web interface. <br /> <br /> ==new==<br /> <br /> $session = EPrints::Session-&gt;new( $mode, [$repository_id], [$noise], [$nocheckdb] )<br /> <br /> Create a connection to an EPrints repository which provides access to the database and to the repository configuration.<br /> This method can be called in two modes. Setting $mode to 0 means thisis a connection via a CGI web page. $repository_id is ignored, insteadthe value is taken from the "PerlSetVar EPrints_ArchiveID" option inthe apache configuration for the current directory.<br /> If this is being called from a command line script, then $mode shouldbe 1, and $repository_id should be the ID of the repository we want toconnect to.<br /> $mode :mode = 0 - We are online (CGI script)mode = 1 - We are offline (bin script) $repository_id is repository_idmode = 2 - We are online, but don't create a CGI query (so we<br /> don't consume the data).<br /> $noise is the level of debugging output.0 - silent1 - quietish2 - noisy3 - debug all SQL statements4 - debug database connection<br /> Under normal conditions use "0" for online and "1" for offline.<br /> $nocheckdb - if this is set to 1 then a connection is made to thedatabase without checking that the tables exist. <br /> <br /> ==get_request==<br /> <br /> $request = $session-&gt;get_request;<br /> <br /> Return the Apache request object (from mod_perl) or undefined if this isn't a CGI script.<br /> <br /> ==get_query==<br /> <br /> $query = $session-&gt;get_query;<br /> <br /> Return the CGI.pm object describing the current HTTP query, or undefined if this isn't a CGI script.<br /> <br /> ==terminate==<br /> <br /> $session-&gt;terminate<br /> <br /> Perform any cleaning up necessary, for example SQL cache tables whichare no longer needed.<br /> <br /> ==Language Related Methods==<br /> <br /> ===get_session_language===<br /> <br /> $langid = EPrints::Session::get_session_language( $repository, $request )<br /> <br /> Given an repository object and a Apache (mod_perl) request object, thismethod decides what language the session should be.<br /> First it looks at the HTTP cookie "eprints_lang", failing that itlooks at the prefered language of the request from the HTTP header,failing that it looks at the default language for the repository.<br /> The language ID it returns is the highest on the list that the giveneprint repository actually supports.<br /> <br /> ===change_lang===<br /> <br /> $session-&gt;change_lang( $newlangid )<br /> <br /> Change the current language of the session. $newlangid should be avalid country code for the current repository.<br /> An invalid code will cause eprints to terminate with an error.<br /> <br /> ===html_phrase===<br /> <br /> $xhtml_phrase = $session-&gt;html_phrase( $phraseid, %inserts )<br /> <br /> Return an XHTML DOM object describing a phrase from the phrase files.<br /> $phraseid is the id of the phrase to return. If the same ID appearsin both the repository-specific phrases file and the system phrases filethen the repository-specific one is used.<br /> If the phrase contains &lt;ep:pin&gt; elements, then each one should havean entry in %inserts where the key is the "ref" of the pin and thevalue is an XHTML DOM object describing what the pin should be replaced with.<br /> <br /> ===phrase===<br /> <br /> $utf8_text = $session-&gt;phrase( $phraseid, %inserts )<br /> <br /> Performs the same function as html_phrase, but returns plain text.<br /> All HTML elements will be removed, &lt;br&gt; and &lt;p&gt; will be converted into breaks in the text. &lt;img&gt; tags will be replaced with their "alt" values.<br /> <br /> ===get_lang===<br /> <br /> $language = $session-&gt;get_lang<br /> <br /> Return the EPrints::Language object for this sessions current language.<br /> <br /> ===get_langid===<br /> <br /> $langid = $session-&gt;get_langid<br /> <br /> Return the ID code of the current language of this session.<br /> <br /> ===best_language===<br /> <br /> $value = EPrints::Session::best_language( $repository, $lang, %values )<br /> <br /> $repository is the current repository. $lang is the prefered language.<br /> %values contains keys which are language ids, and values which istext or phrases in those languages, all translations of the same thing.<br /> This function returns one of the values from %values based on the following logic:<br /> If possible, return the value for $lang.<br /> Otherwise, if possible return the value for the default language ofthis repository.<br /> Otherwise, if possible return the value for "en" (English).<br /> Otherwise just return any one value.<br /> This means that the view sees the best possible phrase. <br /> <br /> ===get_view_name===<br /> <br /> $viewname = $session-&gt;get_view_name( $dataset, $viewid )<br /> <br /> Return a UTF8 encoded string containing the human readable nameof the /view/ section with the ID $viewid.<br /> <br /> ==Accessor Methods==<br /> <br /> ===get_database===<br /> <br /> $db = $session-&gt;get_database<br /> <br /> Return the current EPrints::Database connection object.<br /> <br /> ===get_storage===<br /> <br /> $store = $session-&gt;get_storage<br /> <br /> Return the storage control object.<br /> <br /> ===get_repository===<br /> <br /> $repository = $session-&gt;get_repository<br /> <br /> Return the EPrints::Repository object associated with the Session.<br /> <br /> ===get_url===<br /> <br /> $url = $session-&gt;get_url( [ @OPTS ] [, $page] )<br /> <br /> Utility method to get various URLs. See L!EPrints::URL!. With no arguments returns the same as get_uri().<br /> # Return the current static path<br /> $session-&gt;get_url( path =&gt; "static" );<br /> # Return the current cgi path<br /> $session-&gt;get_url( path =&gt; "cgi" );<br /> # Return a full URL to the current cgi path<br /> $session-&gt;get_url( host =&gt; 1, path =&gt; "cgi" );<br /> # Return a full URL to the static path under HTTP<br /> $session-&gt;get_url( scheme =&gt; "http", host =&gt; 1, path =&gt; "static" );<br /> # Return a full URL to the image 'foo.png'<br /> $session-&gt;get_url( host =&gt; 1, path =&gt; "images", "foo.png" );<br /> <br /> ===get_uri===<br /> <br /> $uri = $session-&gt;get_uri<br /> <br /> Returns the URL of the current script. Or "undef".<br /> <br /> ===get_full_url===<br /> <br /> $uri = $session-&gt;get_full_url<br /> <br /> Returns the URL of the current script plus the CGI params.<br /> <br /> ===get_noise===<br /> <br /> $noise_level = $session-&gt;get_noise<br /> <br /> Return the noise level for the current session. See the explainationunder EPrints::Session-&gt;new()<br /> <br /> ===get_online===<br /> <br /> $boolean = $session-&gt;get_online<br /> <br /> Return true if this script is running via CGI, return false if we'reon the command line.<br /> <br /> ===get_secure===<br /> <br /> $secure = $session-&gt;get_secure<br /> <br /> Returns true if we're using HTTPS/SSL (checks get_online first).<br /> <br /> ==DOM Related Methods==<br /> These methods help build XML. Usually, but not always XHTML.<br /> <br /> ===make_element===<br /> <br /> $dom = $session-&gt;make_element( $element_name, %attribs )<br /> <br /> Return a DOM element with name ename and the specified attributes.<br /> eg. $session-&gt;make_element( "img", src =&gt; "/foo.gif", alt =&gt; "my pic" )<br /> Will return the DOM object describing:<br /> &lt;img src="/foo.gif" alt="my pic" /&gt;<br /> Note that in the call we use "=&gt;" not "=".<br /> <br /> ===make_indent===<br /> <br /> $dom = $session-&gt;make_indent( $width )<br /> <br /> Return a DOM object describing a C.R. and then $width spaces. Thisis used to make nice looking XML for things like the OAI interface.<br /> <br /> ===make_comment===<br /> <br /> $dom = $session-&gt;make_comment( $text )<br /> <br /> Return a DOM object describing a comment containing $text.<br /> eg.<br /> &lt;!-- this is a comment --&gt;<br /> <br /> ===make_text===<br /> <br /> $DOM = $session-&gt;make_text( $text )<br /> <br /> Return a DOM object containing the given text. $text should beUTF-8 encoded.<br /> Characters will be treated as _text_ including &lt; &gt; etc.<br /> eg.<br /> $session-&gt;make_text( "This is &lt;b&gt; an example" );<br /> Would return a DOM object representing the XML:<br /> "This is &amp;lt;b&amp;gt; an example"<br /> <br /> ===make_javascript===<br /> <br /> $DOM = $session-&gt;make_javascript( $code, %attribs )<br /> <br /> Return a new DOM "script" element containing $code in javascript. %attribs willbe added to the script element, similar to make_element().<br /> E.g.<br /> &lt;script type="text/javascript"&gt;<br /> // &lt;![CDATA[<br /> alert("Hello, World!");<br /> // ]]&gt;<br /> &lt;/script&gt;<br /> <br /> ===make_doc_fragment===<br /> <br /> $fragment = $session-&gt;make_doc_fragment<br /> <br /> Return a new XML document fragment. This is an item which can haveXML elements added to it, but does not actually get rendered itself.<br /> If appended to an element then it disappears and its children jointhe element at that point.<br /> <br /> ==XHTML Related Methods==<br /> These methods help build XHTML.<br /> <br /> ===render_ruler===<br /> <br /> $ruler = $session-&gt;render_ruler<br /> <br /> Return an HR.in ruler.xml<br /> <br /> ===render_nbsp===<br /> <br /> $nbsp = $session-&gt;render_nbsp<br /> <br /> Return an XHTML &amp;nbsp; character.<br /> <br /> ===render_data_element===<br /> <br /> $xhtml = $session-&gt;render_data_element( $indent, $elementname, $value, [%opts] )<br /> <br /> This is used to help render neat XML data. It returns a fragment containing an element of name $elementname containing the value$value, the element is indented by $indent spaces.<br /> The %opts describe any extra attributes for the element<br /> eg.$session-&gt;render_data_element( 4, "foo", "bar", class=&gt;"fred" )<br /> would return a XML DOM object describing:<br /> &lt;foo class="fred"&gt;bar&lt;/foo&gt;<br /> <br /> ===render_link===<br /> <br /> $xhtml = $session-&gt;render_link( $uri, [$target] )<br /> <br /> Returns an HTML link to the given uri, with the optional $target ifit needs to point to a different frame or window.<br /> <br /> ===render_row===<br /> <br /> $table_row = $session-&gt;render_row( $key, @values );<br /> <br /> Return the key and values in a DOM encoded HTML table row. eg.<br /> &lt;tr&gt;&lt;th&gt;$key:&lt;/th&gt;&lt;td&gt;$value[0]&lt;/td&gt;&lt;td&gt;...&lt;/td&gt;&lt;/tr&gt;<br /> <br /> ===render_language_name===<br /> <br /> $xhtml = $session-&gt;render_language_name( $langid ) Return a DOM object containing the description of the specified languagein the current default language, or failing that from languages.xml<br /> <br /> <br /> ===render_type_name===<br /> <br /> $xhtml = $session-&gt;render_type_name( $type_set, $type ) <br /> <br /> Return a DOM object containing the description of the specified typein the type set. eg. "eprint", "article"<br /> <br /> ===get_type_name===<br /> <br /> $string = $session-&gt;get_type_name( $type_set, $type ) <br /> <br /> As above, but return a utf-8 string. Used in &lt;option&gt; elements, forexample.<br /> <br /> ===render_name===<br /> <br /> $xhtml_name = $session-&gt;render_name( $name, [$familylast] )<br /> <br /> $name is a ref. to a hash containing family, given etc.<br /> Returns an XML DOM fragment with the name rendered in the mannerof the repository. Usually "John Smith".<br /> If $familylast is set then the family and given parts are reversed, eg."Smith, John"<br /> <br /> ===render_option_list===<br /> <br /> $xhtml_select = $session-&gt;render_option_list( %params )<br /> <br /> This method renders an XHTML &lt;select&gt;. The options are complicatedand may change, so it's better not to use it.<br /> <br /> ===render_single_option===<br /> <br /> $option = $session-&gt;render_single_option( $key, $desc, $selected )<br /> <br /> Used by render_option_list.<br /> <br /> ===render_hidden_field===<br /> <br /> $xhtml_hidden = $session-&gt;render_hidden_field( $name, $value )<br /> <br /> Return the XHTML DOM describing an &lt;input&gt; element of type "hidden"and name and value as specified. eg.<br /> &lt;input type="hidden" name="foo" value="bar" /&gt;<br /> <br /> ===render_upload_field===<br /> <br /> $xhtml_uploda = $session-&gt;render_upload_field( $name )<br /> <br /> Render into XHTML DOM a file upload form button with the given name. <br /> eg.&lt;input type="file" name="foo" /&gt;<br /> <br /> ===render_action_buttons===<br /> <br /> $dom = $session-&gt;render_action_buttons( %buttons )<br /> <br /> Returns a DOM object describing the set of buttons.<br /> The keys of %buttons are the ids of the action that button will cause,the values are UTF-8 text that should appear on the button.<br /> Two optional additional keys may be used:<br /> _order =&gt; [ "action1", "action2" ]<br /> will force the buttons to appear in a set order.<br /> _class =&gt; "my_css_class" <br /> will add a class attribute to the &lt;div&gt; containing the buttons to allow additional styling.<br /> <br /> ===render_internal_buttons===<br /> <br /> $dom = $session-&gt;render_internal_buttons( %buttons )<br /> <br /> As for render_action_buttons, but creates buttons for actions whichwill modify the state of the current form, not continue with whateverprocess the form is part of.<br /> eg. the "More Spaces" button and the up and down arrows on multipletype fields.<br /> <br /> ===render_form===<br /> <br /> $dom = $session-&gt;render_form( $method, $dest )<br /> <br /> Return a DOM object describing an HTML form element. <br /> $method should be "get" or "post"<br /> $dest is the target of the form. By default the current page.<br /> eg.<br /> $session-&gt;render_form( "GET", "http://example.com/cgi/foo" );<br /> returns a DOM object representing:<br /> &lt;form method="get" action="http://example.com/cgi/foo" accept-charset="utf-8" /&gt;<br /> If $method is "post" then an addition attribute is set:enctype="multipart/form-data" <br /> This just controls how the data is passed from the browser to theCGI library. You don't need to worry about it.<br /> <br /> ===render_subjects===<br /> <br /> $ul = $session-&gt;render_subjects( $subject_list, [$baseid], [$currentid], [$linkmode], [$sizes] )<br /> <br /> Return as XHTML DOM a nested set of &lt;ul&gt; and &lt;li&gt; tags describingpart of a subject tree.<br /> $subject_list is a array ref of subject ids to render.<br /> $baseid is top top level node to render the tree from. If only a singlesubject is in subject_list, all subjects up to $baseid will still berendered. Default is the ROOT element.<br /> If $currentid is set then the subject with that ID is rendered in&lt;strong&gt;<br /> $linkmode can 0, 1, 2 or 3.<br /> 0. Don't link the subjects.<br /> 1. Links subjects to the URL which edits them in edit_subjects.<br /> 2. Links subjects to "subjectid.html" (where subjectid is the id of the subject)<br /> 3. Links the subjects to "subjectid/". $sizes must be set. Only subjects with a size of more than one are linked.<br /> 4. Links the subjects to "../subjectid/". $sizes must be set. Only subjects with a size of more than one are linked.<br /> $sizes may be a ref. to hash mapping the subjectid's to the numberof items in that subject which will be rendered in brackets next toeach subject.<br /> <br /> ===render_error===<br /> <br /> $session-&gt;render_error( $error_text, $back_to, $back_to_text )<br /> <br /> Renders an error page with the given error text. A link, with thetext $back_to_text, is offered, the destination of this is $back_to,which should take the user somewhere sensible.<br /> <br /> ===render_input_form===<br /> <br /> $dom = $session-&gt;render_input_form( %params )<br /> <br /> Return a DOM object representing an entire input form.<br /> %params contains the following options:<br /> dataset: The EPrints::Dataset to which the form relates, if any.<br /> fields: a reference to an array of EPrint::MetaField objects,which describe the fields to be added to the form.<br /> values: a set of default values. A reference to a hash wherethe keys are ID's of fields, and the values are the defaultvalues for those fields.<br /> show_help: if true, show the fieldhelp phrase for each input field.<br /> show_name: if true, show the fieldname phrase for each input field.<br /> buttons: a description of the buttons to appear at the bottomof the form. See render_action_buttons for details.<br /> top_buttons: a description of the buttons to appear at the topof the form (optional).<br /> default_action: the id of the action to be performed by default, ie. if the user pushes "return" in a text field.<br /> dest: The URL of the target for this form. If not defined thenthe current URI is used.<br /> type: if this form relates to a user or an eprint, the type ofeprint/user can effect what fields are flagged as required. Thisparam contains the ID of the eprint/user if any, and if relevant.<br /> staff: if true, this form is being presented to repository staff (admin, or editor). This may change which fields are required.<br /> hidden_fields: reference to a hash. The keys of which are CGI keysand the values are the values they are set to. This causes hiddenform elements to be set, so additional information can be passed.<br /> object: The DataObj which this form is editing, if any.<br /> comment: not yet used.<br /> <br /> ==Methods relating to the current XHTML page==<br /> <br /> ===write_static_page===<br /> <br /> $session-&gt;write_static_page( $filebase, $parts, [$page_id], [$wrote_files] )<br /> <br /> Write an .html file plus a set of files describing the parts of thepage for use with the dynamic template option.<br /> File base is the name of the page without the .html suffix.<br /> parts is a reference to a hash containing DOM trees.<br /> If $wrote_files is defined then any filenames written are logged in it as keys.<br /> <br /> ===prepare_page===<br /> <br /> $session-&gt;prepare_page( $parts, %options )<br /> <br /> Create an XHTML page for this session. <br /> $parts is a hash of XHTML elements to insert into the pins in thetemplate. Usually: title, page. Maybe pagetop and head.<br /> If template is set then an alternate template file is used.<br /> This function only builds the page it does not output it any way, seethe methods below for that.<br /> Options include:<br /> page_id=&gt;"id to put in body tag"template=&gt;"The template to use instead of default."<br /> <br /> ===send_page===<br /> <br /> $session-&gt;send_page( %httpopts )<br /> <br /> Send a web page out by HTTP. Only relevant if this is a CGI script.build_page must have been called first.<br /> See send_http_header for an explanation of %httpopts<br /> Dispose of the XML once it's sent out.<br /> <br /> ===page_to_file===<br /> <br /> $session-&gt;page_to_file( $filename, [$wrote_files] )<br /> <br /> Write out the current webpage to the given filename.<br /> build_page must have been called first.<br /> Dispose of the XML once it's sent out.<br /> If $wrote_files is set then keys are created in it for each filecreated.<br /> <br /> ===set_page===<br /> <br /> $session-&gt;set_page( $newhtml )<br /> <br /> Erase the current page for this session, if any, and replace it withthe XML DOM structure described by $newhtml.<br /> This page is what is output by page_to_file or send_page.<br /> $newhtml is a normal DOM Element, not a document object.<br /> <br /> ===clone_for_me===<br /> <br /> $copy_of_node = $session-&gt;clone_for_me( $node, [$deep] )<br /> <br /> XML DOM items can only be added to the document which they belong to.<br /> A EPrints::Session has it's own XML DOM DOcument. <br /> This method copies an XML node from _any_ document. The copy belongsto this sessions document.<br /> If $deep is set then the children, (and their children etc.), are copied too.<br /> <br /> ===redirect===<br /> <br /> $session-&gt;redirect( $url, [%opts] )<br /> <br /> Redirects the browser to $url.<br /> <br /> ===not_found===<br /> <br /> $session-&gt;not_found( [ $message ] )<br /> <br /> Send a 404 Not Found header. If $message is undef sets message to'Not Found' but does '''NOT''' print an error message, otherwisedefaults to the normal 404 Not Found type response.<br /> <br /> ===send_http_header===<br /> <br /> $session-&gt;send_http_header( %opts )<br /> <br /> Send the HTTP header. Only makes sense if this is running as a CGI script.<br /> Opts supported are:<br /> content_type. Default value is "text/html; charset=UTF-8". This setsthe http content type header.<br /> lang. If this is set then a cookie setting the language preferenceis set in the http header.<br /> <br /> ==Input Methods==<br /> These handle input from the user, browser and apache.<br /> <br /> ===param===<br /> <br /> $value or @values = $session-&gt;param( $name )<br /> <br /> Passes through to CGI.pm param method.<br /> $value = $session-&gt;param( $name ): returns the value of CGI parameter$name.<br /> $value = $session-&gt;param( $name ): returns the value of CGI parameter$name.<br /> @values = $session-&gt;param: returns an array of the names of all theCGI parameters in the current request.<br /> <br /> ===have_parameters===<br /> <br /> $bool = $session-&gt;have_parameters<br /> <br /> Return true if the current script had any parameters (post or get)<br /> <br /> ===current_user===<br /> <br /> $user = $session-&gt;current_user<br /> <br /> Return the current EPrints::DataObj::User for this session.<br /> Return undef if there isn't one.<br /> <br /> ===seen_form===<br /> <br /> $boolean = $session-&gt;seen_form<br /> <br /> Return true if the current request contains the values from aform generated by EPrints.<br /> This is identified by a hidden field placed into forms named_seen with value "true".<br /> <br /> ===internal_button_pressed===<br /> <br /> $boolean = $session-&gt;internal_button_pressed( $buttonid )<br /> <br /> Return true if a button has been pressed in a form which is intendedto reload the current page with some change.<br /> Examples include the "more spaces" button on multiple fields, the "lookup" button on succeeds, etc.<br /> <br /> ===get_action_button===<br /> <br /> $action_id = $session-&gt;get_action_button<br /> <br /> Return the ID of the eprint action button which has been pressed ina form, if there was one. The name of the button is "_action_" followed by the id. <br /> This also handles the .x and .y inserted in image submit.<br /> This is designed to get back the name of an action button createdby render_action_buttons.<br /> <br /> ===get_internal_button===<br /> <br /> $button_id = $session-&gt;get_internal_button<br /> <br /> Return the id of the internal button which has been pushed, or undef if one wasn't.<br /> <br /> ===client===<br /> <br /> $client = $session-&gt;client<br /> <br /> Return a string representing the kind of browser that made the current request.<br /> Options are GECKO, LYNX, MSIE4, MSIE5, MSIE6, ?.<br /> GECKO covers mozilla and firefox.<br /> ? is what's returned if none of the others were matched.<br /> These divisions are intended for modifying the way pages are renderednot logging what browser was used. Hence merging mozilla and firefox.<br /> <br /> ===get_http_status===<br /> <br /> $status = $session-&gt;get_http_status<br /> <br /> Return the status of the current HTTP request.<br /> <br /> ==Methods related to Plugins==<br /> <br /> ===plugin===<br /> <br /> $plugin = $session-&gt;plugin( $pluginid )<br /> <br /> Return the plugin with the given pluginid, in this repository or, failingthat, from the system level plugins.<br /> <br /> ===plugin_list===<br /> <br /> @plugin_ids = $session-&gt;plugin_list( %restrictions )<br /> <br /> Return either a list of all the plugins available to this repository orreturn a list of available plugins which can accept the given restrictions.<br /> Restictions:<br /> vary depending on the type of the plugin.<br /> <br /> ===get_plugins===<br /> <br /> @plugins = $session-&gt;get_plugins( [ $params, ] %restrictions )<br /> <br /> Returns a list of plugin objects that conform to %restrictions (may be empty).<br /> If $params is given uses that hash reference to initialise the plugins. Always passes this session to the plugin constructor method.<br /> <br /> ==Other Methods==<br /> <br /> ===microtime===<br /> <br /> $time = EPrints::Session::microtime();<br /> <br /> This function is currently buggy so just returns the time in seconds.<br /> Return the time of day in seconds, but to a precision of microseconds.<br /> Accuracy depends on the operating system etc.<br /> <br /> ===mail_administrator===<br /> <br /> $foo = $session-&gt;mail_administrator( $subjectid, $messageid, %inserts )<br /> <br /> Sends a mail to the repository administrator with the given subject andmessage body.<br /> $subjectid is the name of a phrase in the phrase file to usefor the subject.<br /> $messageid is the name of a phrase in the phrase file to use as thebasis for the mail body.<br /> %inserts is a hash. The keys are the pins in the messageid phrase andthe values the utf8 strings to replace the pins with.<br /> <br /> ===destroy===<br /> <br /> $session-&gt;DESTROY<br /> <br /> Destructor. Don't call directly.<br /> <br /> </div>

Tdb01r