Difference between revisions of "API:EPrints/Language"

From EPrints Documentation
Jump to: navigation, search
(Removing all content from page)
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.
 +
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Language.pm|package_name=EPrints::Language}}[[Category:API|Language]]<div><!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 +
==NAME==
 +
'''EPrints::Language''' - A Single Language supported by a repository.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 +
The language class handles loading the "phrase" files for a single language. See the mail documentation for a full explanation of the format of phrase files.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_new -->
 +
===$language = EPrints::Language-&gt;new( $langid, $repository, [$fallback] )===
 +
 +
Create a new language object representing the phases eprints will use in a given language, loading them from the phrase config XML files.
 +
 +
$langid is the ISO language ID of the language, $repository is the  repository to which this language object belongs. $fallback is either undef or a reference to the main language object for the repository.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_phrase_info -->
 +
===$info = $lang-&gt;get_phrase_info( $phraseid, $session )===
 +
 +
Returns a hash describing the phrase $phraseid. Contains:
 +
 +
  langid - the language the phrase is from
 +
  phraseid - the phrase id
 +
  xml - the raw XML fragment
 +
  fallback - whether the phrase was from the fallback language
 +
  system - whether the phrase was from the system files
 +
  filename - the file the phrase came from
 +
 
 +
If $phraseid doesn't exist returns undef.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_phrase_ids -->
 +
===$phraseids = $language-&gt;get_phrase_ids( $fallback )===
 +
 +
Return a reference to an array of all phrase ids that are defined in this language (repository and system).
 +
 +
If $fallback is true returns any additional phrase ids defined in the fallback language.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_phrase -->
 +
===$xhtml = $language-&gt;phrase( $phraseid, $inserts, $session )===
 +
 +
Return an XHTML DOM structure for the phrase with the given phraseid.
 +
 +
The phraseid is looked for in the following order, if it's not in one phrase file the system checks the next.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_this_languages_repository_specific_phrases -->
 +
===This languages repository specific phrases.===
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_phrases -->
 +
===The fallback languages repository specific phrases (if there is a fallback).===
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_this_languages_general_phrases -->
 +
===This languages general phrases.===
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_phrases -->
 +
===The fallback languages general phrases (if there is a fallback).===
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_failing_that_it_returns_an_xhtml_dom_encoded_error -->
 +
===Failing that it returns an XHTML DOM encoded error.===
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_has_phrase -->
 +
===$boolean = $language-&gt;has_phrase( $phraseid, $session )===
 +
 +
Return 1 if the phraseid is defined for this language. Return 0 if it is only available as a fallback or unavailable.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_id -->
 +
===$langid = $language-&gt;get_id===
 +
 +
Return the ISO language ID of this language object.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_fallback -->
 +
===$lang = $language-&gt;get_fallback()===
 +
 +
Return the fallback language for this language. Returns undef if there is no fallback.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_load_phrases -->
 +
===$ok = $language-&gt;load_phrases( $session, $file )===
 +
 +
Load phrases from $file into the current language (use with care!).
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_create_phrase_doc -->
 +
===$doc = EPrints::Language-&gt;create_phrase_doc( $session, [ $comment ] )===
 +
 +
Create and return a new, empty, phrases document. Optionally put $comment at the top.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 13:21, 25 February 2010

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.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Language - A Single Language supported by a repository.

User Comments


DESCRIPTION

The language class handles loading the "phrase" files for a single language. See the mail documentation for a full explanation of the format of phrase files.

User Comments


$language = EPrints::Language->new( $langid, $repository, [$fallback] )

Create a new language object representing the phases eprints will use in a given language, loading them from the phrase config XML files.

$langid is the ISO language ID of the language, $repository is the repository to which this language object belongs. $fallback is either undef or a reference to the main language object for the repository.

User Comments


$info = $lang->get_phrase_info( $phraseid, $session )

Returns a hash describing the phrase $phraseid. Contains: 

 langid - the language the phrase is from
 phraseid - the phrase id
 xml - the raw XML fragment
 fallback - whether the phrase was from the fallback language
 system - whether the phrase was from the system files
 filename - the file the phrase came from

If $phraseid doesn't exist returns undef.

User Comments


$phraseids = $language->get_phrase_ids( $fallback )

Return a reference to an array of all phrase ids that are defined in this language (repository and system).

If $fallback is true returns any additional phrase ids defined in the fallback language.

User Comments


$xhtml = $language->phrase( $phraseid, $inserts, $session )

Return an XHTML DOM structure for the phrase with the given phraseid.

The phraseid is looked for in the following order, if it's not in one phrase file the system checks the next.

User Comments


This languages repository specific phrases.

User Comments


The fallback languages repository specific phrases (if there is a fallback).

User Comments


This languages general phrases.

User Comments


The fallback languages general phrases (if there is a fallback).

User Comments


Failing that it returns an XHTML DOM encoded error.

User Comments


$boolean = $language->has_phrase( $phraseid, $session )

Return 1 if the phraseid is defined for this language. Return 0 if it is only available as a fallback or unavailable.

User Comments


$langid = $language->get_id

Return the ISO language ID of this language object.

User Comments


$lang = $language->get_fallback()

Return the fallback language for this language. Returns undef if there is no fallback.

User Comments


$ok = $language->load_phrases( $session, $file )

Load phrases from $file into the current language (use with care!).

User Comments


$doc = EPrints::Language->create_phrase_doc( $session, [ $comment ] )

Create and return a new, empty, phrases document. Optionally put $comment at the top.

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Language&oldid=8745’