API:EPrints/URL

From EPrints Documentation
Revision as of 15:26, 16 December 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::URL - URL utility methods

User Comments


DESCRIPTION

This module contains utility methods for generating and getting URLs, relative paths etc.

User Comments


SYNOPSIS

 use EPrints;
 
 my $base_url = $session->get_url->get(
   scheme => "auto",
   host => 1,
   path => "cgi",
   query => 0,
 );
 

User Comments


METHODS

User Comments


get

$url = $url->get( %opts [, $page ] )

Constructs a $url based on the current configuration and %opts. If $page is specified will return a URL to that page.

User Comments


scheme_auto

scheme => "auto"

Link to same protocol as is active now (N/A to shell scripts).

User Comments


scheme_http

scheme => "http"

Link to the non-secure location.

User Comments


scheme_https

scheme => "https"

Link to the secure location.

User Comments


host_1

host => 1

Create an absolute link (including host and port).

User Comments


path_auto

path => "auto"

Use the current path (N/A to shell scripts).

User Comments


path_static_path_cgi_path_images

path => "static", path => "cgi", path => "images"

Link to the root of the static, cgi and images respectively.

User Comments


query_1

query => 1

Create a self-referential link (i.e. include all parameters in the query part).

User Comments


COPYRIGHT

User Comments