Difference between revisions of "API:EPrints/URL"
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- 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. | 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. | ||
| − | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/URL.pm|package_name=EPrints::URL}}[[Category:API|URL]][[Category:API:EPrints/URL|URL]]<div><!-- Edit below this comment --> | + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/URL.pm|package_name=EPrints::URL}}[[Category:API|URL]][[Category:API:EPrints/URL|URL]]<div><!-- Edit below this comment --> |
Revision as of 15:26, 16 December 2011
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::URL - URL utility methods
DESCRIPTION
This module contains utility methods for generating and getting URLs, relative paths etc.
SYNOPSIS
use EPrints; my $base_url = $session->get_url->get( scheme => "auto", host => 1, path => "cgi", query => 0, );
METHODS
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.
scheme_auto
scheme => "auto"
Link to same protocol as is active now (N/A to shell scripts).
scheme_http
scheme => "http"
Link to the non-secure location.
scheme_https
scheme => "https"
Link to the secure location.
host_1
host => 1
Create an absolute link (including host and port).
path_auto
path => "auto"
Use the current path (N/A to shell scripts).
path_static_path_cgi_path_images
path => "static", path => "cgi", path => "images"
Link to the root of the static, cgi and images respectively.
query_1
query => 1
Create a self-referential link (i.e. include all parameters in the query part).
COPYRIGHT
