Class XFUI

Description

XFUI class handles user interface methods

Located in /class.ui.php (line 26)


	
			
Class Constant Summary
Variable Summary
static string $ajax_head
static resource $ajax_main
static resource $ajax_response
Method Summary
static true ajax_init ()
static boolean get_post_approvement ([integer $uid = 0], [integer $gid = 0])
static array get_post_prefix_list ([boolean $strict = false])
static array get_post_weight_list ([integer $gid = 0])
static boolean html_foot ()
static boolean html_head (string $title)
static void html_redirect (integer $class, string $uri, [string $msg = ''])
static string i18n (string $a, [string $b = ''])
static string lang_str (string $a)
static true load_lang_res (string $rlang, string $namespace)
static boolean topic_access ( &$cache,  &$prefix, [integer $uid = 0], [integer $gid = 0], array $cache, array $prefix)
Variables
static string $ajax_head = '' (line 42)
  • var: compiled head segments for html to serve asynchronous requests
  • access: public
static resource $ajax_main = null (line 34)
  • var: main instance for asynchronous requests
  • access: protected
static resource $ajax_response = null (line 38)
  • var: response instance for asynchronous requests
  • access: public
Methods
static method ajax_init (line 144)

init ajax engine. if you want to use it, call it before(!) html_head()

  • since: 1.0.0
  • access: public
static true ajax_init ()
static method get_post_approvement (line 356)

check whether a new posting of this user is approved by default or not

  • since: 1.0.0
  • access: public
static boolean get_post_approvement ([integer $uid = 0], [integer $gid = 0])
  • integer $uid: user id, current if not given
  • integer $gid: group id, current if not given
static method get_post_prefix_list (line 313)

fetch any posting prefixes and cache it

  • since: 1.0.0
  • access: public
static array get_post_prefix_list ([boolean $strict = false])
  • boolean $strict: if 'true', it returns only prefixes without access restrictions
static method get_post_weight_list (line 371)

get posting weight list for html output

  • since: 1.0.0
  • access: public
static array get_post_weight_list ([integer $gid = 0])
  • integer $gid: group id, current if not given
static method html_foot (line 87)

output html footer

  • since: 1.0.0
  • access: public
static boolean html_foot ()
static method html_head (line 53)

output html header

  • since: 1.0.0
  • access: public
static boolean html_head (string $title)
  • string $title: title text
static method html_redirect (line 115)

output a redirection

  • since: 1.0.0
  • access: public
static void html_redirect (integer $class, string $uri, [string $msg = ''])
  • integer $class: operation was a success '1', a failure '0' or redirect silently '-1'
  • string $uri: destination uri (local only; foobar.php?bla=1...)
  • string $msg: message to show, if class is not '-1'
static method i18n (line 228)

fetch a string from translation table

  • since: 1.0.0
  • access: public
static string i18n (string $a, [string $b = ''])
  • string $a: string key
  • string $b: selected language
static method lang_str (line 213)

do a translation request like '{[LANGUAGE]:STRING_IDENTIFIER}'

  • since: 1.0.0
  • access: public
static string lang_str (string $a)
  • string $a: input stream
static method load_lang_res (line 175)

load a language namespace and cache it locally

  • since: 1.0.0
  • access: public
static true load_lang_res (string $rlang, string $namespace)
  • string $rlang: name of language (i.e. 'en')
  • string $namespace: and its namespace (i.e. 'core')
static method topic_access (line 246)

check whether the selected user has access to a topic or not

  • since: 1.0.0
  • access: public
static boolean topic_access ( &$cache,  &$prefix, [integer $uid = 0], [integer $gid = 0], array $cache, array $prefix)
  • array $cache: returned resource from XFCache::topic()
  • array $prefix: returned resource from XFUI::get_post_prefix_list()
  • integer $uid: user id, current if not given
  • integer $gid: group id, current if not given
  • &$cache
  • &$prefix
Class Constants
COMPACT_PAGEBAR_THRESHOLD = 8 (line 30)
  • var: topics having less than x pages get a 'full' page nabvar

Documentation generated on Tue, 21 Oct 2008 20:58:31 +0200 by phpDocumentor 1.4.1