phpDocumentor Developer
[ class tree: Developer ] [ index: Developer ] [ all elements ]

Class: CAT

Source Location: /core/CAT.php

Class CAT

Class Overview

Define some variables which need to be globally accessible and some general purpose methods

Located in /core/CAT.php [line 33]



		
				Author(s):
		
		
		
Information Tags:

Properties

Methods

[ Top ]
Descendants
Child Class Description
UserAPI The basic methoods for the user GUI

[ Top ]
Property Summary
static mixed   $lang_index   language code for the language set by the constructor
static mixed   $locale   language display name for the language set by the constructor
static mixed   $root   stores the location of the root directory

[ Top ]
Method Summary
static string   set_locale()   Sets the gettext domain
static boolean   writeAudit()   Writes an audit log entry to the audit log file. These audits are semantic logs; they don't record every single modification in the database, but provide a logical "who did what" overview. The exact modification SQL statements are logged automatically with writeSQLAudit() instead. The log file path is configurable in _config.php.
static void   writeSQLAudit()   Write an audit log entry to the SQL log file. Every SQL statement which is not a simple SELECT one will be written to the log file. The log file path is configurable in _config.php.
CAT   __construct()   Constructor sets the language by calling set_lang
array   printCountryList()   Prepares a list of countries known to the CAT.
void   totalIdPs()  

[ Top ]
Properties
static mixed   $lang_index [line 252]

language code for the language set by the constructor

API Tags:
Access:  public


[ Top ]
static mixed   $locale [line 257]

language display name for the language set by the constructor

API Tags:
Access:  public


[ Top ]
static mixed   $root [line 247]

stores the location of the root directory

API Tags:
Access:  public


[ Top ]
Methods
static method set_locale  [line 90]

  static string set_locale( string $domain  )

Sets the gettext domain

Parameters:
string   $domain: 

API Tags:
Return:  previous seting so that you can restore it later
Access:  public


[ Top ]
static method writeAudit  [line 195]

  static boolean writeAudit( string $user, string $category, string $message  )

Writes an audit log entry to the audit log file. These audits are semantic logs; they don't record every single modification in the database, but provide a logical "who did what" overview. The exact modification SQL statements are logged automatically with writeSQLAudit() instead. The log file path is configurable in _config.php.

Parameters:
string   $user:  persistent identifier of the user who triggered the action
string   $category:  type of modification, from the fixed vocabulary: "NEW", "OWN", "MOD", "DEL"
string   $message:  message to log into the audit log

API Tags:
Return:  TRUE if successful. Will terminate script execution on failure.
Access:  public


[ Top ]
static method writeSQLAudit  [line 226]

  static void writeSQLAudit( string $query  )

Write an audit log entry to the SQL log file. Every SQL statement which is not a simple SELECT one will be written to the log file. The log file path is configurable in _config.php.

Parameters:
string   $query:  the SQL query to be logged

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 46]

  CAT __construct( )

Constructor sets the language by calling set_lang

and stores language settings in object properties additionally it also sets static variables $laing_index and $root


API Tags:
Access:  public


[ Top ]
printCountryList  [line 165]

  array printCountryList( [int $active_only = 0]  )

Prepares a list of countries known to the CAT.

Parameters:
int   $active_only:  is set and nonzero will cause that only countries with some institutions underneath will be listed

API Tags:
Return:  Array indexed by (uppercase) lang codes and sorted according to the current locale
Access:  public


[ Top ]
totalIdPs  [line 59]

  void totalIdPs( $level  )

Parameters:
   $level: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Thu, 16 Apr 2015 10:26:07 +0000 by phpDocumentor 1.4.4