Tariqa
3.0
|
Static Public Member Functions | |
static | URL ($script, $parameters=null, $urlencode=false) |
static | tariqaClientLoggedIn ($soapConfig) |
static | tariqaClientLogIn ($user, $appConfig, $soapConfig) |
static | loadTariqaClient ($user, $appConfig=null, $soapConfig=null) |
static | open_db_connection ($config) |
static | load_user_prefs ($user, $db) |
static | get_country ($country_id, $get_maps=false, $get_wiki=false) |
static | get_wiki_data ($country_id) |
static | get_theme ($theme_id) |
static | listCountries ($continent_id=null, $eu_members_only=null, $official_only=null, $region_id=null, $country_ids=null) |
static | listThemes ($ids=null) |
static | listContinents () |
static | listOfficialRegions ($continent=null) |
static | loadSourceEngine ($query) |
static | getQuery ($query_id) |
static | listQueries ($access, $source_id, $weblogs_data=false) |
static | getThemeTopic ($topic_id, $access) |
static | getFlavour ($flavour_id) |
static | getSource ($source_id) |
static | getAdvSearchSources () |
static | ListQuickSearchSources ($access) |
static | getEngine ($engine_id) |
static | getAggregatedFeed ($feed_id) |
static | path ($path) |
static | listFlavours () |
static | listThemeQueries ($theme_id, $access) |
static | listCountryQueries ($country, $access) |
static | post2array ($s) |
static | ListThemeUsers ($theme_id) |
static | ListThemeTopics ($theme_id, $access) |
static | ListTVCategories () |
static | ListHotspots () |
static | getQueryIcon ($query, $config) |
static | getAllAggregatedRSSFeed () |
static | browseLexisNexisSources ($folder_id) |
static | getHomePageFlavours ($access) |
static | getHomePageQueries ($access, $flavour=null, $translationTable=null) |
static | getContinent ($id) |
static | _isIE () |
static | listOxanCountries () |
static | listOxanTopics () |
static | findSubTree ($db, $parent_id, $folder_id) |
static | archiveRecords () |
static | ListNewstickersFeeds () |
static | ListClusters () |
static | getRssLink ($user, $page, $flavour_id=null, $no_a=false) |
static | stripTags ($html) |
static | makeXhtml ($html, $body_only=true) |
static | LexisNexisGetSourceDetails ($sourceId) |
static | LexisNexisGetSource ($sourceId) |
static | LatestNewsListLanguages () |
static | log ($user, $db) |
static | completePath ($path, $delimiter= '/') |
static | getTranslations ($name) |
static | baseURL ($url, $no_path=false) |
static | ListFullSearchSources ($access) |
Static Public Attributes | |
static | $tariqaClient = null |
static | $tariqaToken = null |
static | $tariqaClientExpire = null |
Class defining the common functions that will be used without instantiating a class
static _isIE | ( | ) | [static] |
Returns true if the browser is IE public
static archiveRecords | ( | ) | [static] |
Gets the number of video archive files public
static baseURL | ( | $ | url, |
$ | no_path = false |
||
) | [static] |
Gets the base URL of an url. By default, also the path will be included (for example, http://www.google.com/search?q=test will return http://www.google.com/search/. If you only want http://www.google.com/ to be returned, then set no_path to true
string | $url | The URL public |
static browseLexisNexisSources | ( | $ | folder_id | ) | [static] |
Loads the LexisNexis sources
string | $folder_id | The folder identifier public |
static completePath | ( | $ | path, |
$ | delimiter = '/' |
||
) | [static] |
Transforms a path by adding a '/' character at the end if it doesn't already has it
string | $path | The path |
string | $delimiter | The path delimiter [OPTIONAL] public |
static findSubTree | ( | $ | db, |
$ | parent_id, | ||
$ | folder_id | ||
) | [static] |
Returns true if $folder_id is in the subtree of $parent_id
mMysql | $db | The database connection |
$parent_id | The parent folder identifier | |
$folder_id | The folder identifier public |
static get_country | ( | $ | country_id, |
$ | get_maps = false , |
||
$ | get_wiki = false |
||
) | [static] |
Gets a country
string | $country_id | The country ISO2 code |
boolean | $get_maps | If true, also get the ReliefWeb and GlobalAtlas maps [OPTIONAL] |
boolean | $get_wiki | If true, also get the Wikipedia country profile [OPTIONAL] public |
static get_theme | ( | $ | theme_id | ) | [static] |
static get_wiki_data | ( | $ | country_id | ) | [static] |
Gets the wikidata of a country
string | $country_id | The country identifier public |
static getAdvSearchSources | ( | ) | [static] |
Lists the sources for the advanced search public
static getAggregatedFeed | ( | $ | feed_id | ) | [static] |
static getAllAggregatedRSSFeed | ( | ) | [static] |
Gets the list of all feeds from the server public static
static getContinent | ( | $ | id | ) | [static] |
static getEngine | ( | $ | engine_id | ) | [static] |
static getFlavour | ( | $ | flavour_id | ) | [static] |
static getHomePageFlavours | ( | $ | access | ) | [static] |
Gets the home page tabs
string | $access | The current user access level public |
static getHomePageQueries | ( | $ | access, |
$ | flavour = null , |
||
$ | translationTable = null |
||
) | [static] |
static getQuery | ( | $ | query_id | ) | [static] |
static getQueryIcon | ( | $ | query, |
$ | config | ||
) | [static] |
Gets the icon of a given query
Query | $query | The query |
array | $config | The configuration array public static |
static getRssLink | ( | $ | user, |
$ | page, | ||
$ | flavour_id = null , |
||
$ | no_a = false |
||
) | [static] |
Retrieves the RSS link
tariqaUser | $user | The tariqa user |
string | $page | The page from which the RSS is created |
int | $flavour_id | The flavour identifier (for news page, not for the search page) [OPTIONAL] |
boolean | $no_a | If set to true, then no a href is generated. Only the img tag [OPTIONAL] public |
static getSource | ( | $ | source_id | ) | [static] |
static getThemeTopic | ( | $ | topic_id, |
$ | access | ||
) | [static] |
Retrieves a theme topic
int | $topic_id | The topic identifier |
string | $access | The current user access level public |
static getTranslations | ( | $ | name | ) | [static] |
Gets the translation for a specific module
string | $name | The module name public |
static LatestNewsListLanguages | ( | ) | [static] |
Gets the available languages for LatestNews search public
static LexisNexisGetSource | ( | $ | sourceId | ) | [static] |
Gets a LexisNexis source
string | $sourceId | The source identifier public |
static LexisNexisGetSourceDetails | ( | $ | sourceId | ) | [static] |
Gets the details for a LexisNexis source
string | $sourceId | The source identifier public |
static ListClusters | ( | ) | [static] |
Fetches the list of clusters public
static listContinents | ( | ) | [static] |
Loads the list of continents public
static listCountries | ( | $ | continent_id = null , |
$ | eu_members_only = null , |
||
$ | official_only = null , |
||
$ | region_id = null , |
||
$ | country_ids = null |
||
) | [static] |
Loads the list of countries
int | $continent_id | Restricts the list to a given Continent [OPTIONAL] |
boolean | $eu_members_only | If true, restricts the list to EU countries, if False, restricts it to NON-EU members [OPTIONAL] |
boolean | $official_only | It true, restricts the list to official countries, if False, restricts it to non official countries [OPTIONAL] |
int | $region_id | The official region identifier [OPTIONAL] |
string[] | $country_ids A list of countries ids [OPTIONAL] public |
static listCountryQueries | ( | $ | country, |
$ | access | ||
) | [static] |
static listFlavours | ( | ) | [static] |
Gets the list of flavours public
static ListFullSearchSources | ( | $ | access | ) | [static] |
Gets a list of full search sources
string | $access | The current user access level public |
static ListHotspots | ( | ) | [static] |
Gets the list of hotspots public
static ListNewstickersFeeds | ( | ) | [static] |
Gets the list of newstickers predefined feeds public
static listOfficialRegions | ( | $ | continent = null | ) | [static] |
Loads the list of regions
Continent | $continenthe | continent [OPTIONAL] public |
static listOxanCountries | ( | ) | [static] |
Gets the lists of OXAN countries public
static listOxanTopics | ( | ) | [static] |
Gets the lists of OXAN topics public
static listQueries | ( | $ | access, |
$ | source_id, | ||
$ | weblogs_data = false |
||
) | [static] |
List the queries
string | $access | The access level of the current user |
int | $source_id | The source identifier of the queries to retrieve [OPTIONAL] |
boolean | $weblogs_data | If true, then get also the weblogs data [OPTIONAL] public |
static ListQuickSearchSources | ( | $ | access | ) | [static] |
Lists the quick search sources
string | $access | The access level of the current user public |
static listThemeQueries | ( | $ | theme_id, |
$ | access | ||
) | [static] |
Gets the list of queries for a given theme
int | $theme_id | The theme identifier |
string | $access | The current user access level public |
static listThemes | ( | $ | ids = null | ) | [static] |
static ListThemeTopics | ( | $ | theme_id, |
$ | access | ||
) | [static] |
Gets the list of theme topics for a given theme
int | $theme_id | The theme identifier |
string | $access | The access level of current user public |
static ListThemeUsers | ( | $ | theme_id | ) | [static] |
List the users that can edit the text for a given theme
int | $theme_id | The theme identifier public |
static ListTVCategories | ( | ) | [static] |
Gets the list of TV categories public
static load_user_prefs | ( | $ | user, |
$ | db | ||
) | [static] |
Gets the user preferences from the database
tariqaUser | $user | The user |
mMysql | $db | The database connection to load the preferences from public |
static loadSourceEngine | ( | $ | query | ) | [static] |
static loadTariqaClient | ( | $ | user, |
$ | appConfig = null , |
||
$ | soapConfig = null |
||
) | [static] |
Loads the tariqa client
tariqaUser | $user | The ECAS user |
array | $appConfig | The main application configuration array |
array | $soapConfig | The SOAP configuration array public |
static log | ( | $ | user, |
$ | db | ||
) | [static] |
Logs the user trace
tariqaUser | $user | The current user |
mMysql | $db | The database connection |
public
static makeXhtml | ( | $ | html, |
$ | body_only = true |
||
) | [static] |
Ensure that the received html string is xhtml compliant
string | $html | Html data |
bool | $body_only | If set to true (default) only the body of the xhtml document is returned |
static open_db_connection | ( | $ | config | ) | [static] |
Initializes the connection to the database
array | $config | The database section of the config array public |
static path | ( | $ | path | ) | [static] |
Adds a '/' at the end of a path if it is the case
string | $path | The path public |
static post2array | ( | $ | s | ) | [static] |
Converts a POST string (like 'var1=value1&var2=value2') to a PHP array
string | $s | The post string public |
static stripTags | ( | $ | html | ) | [static] |
String the HTML tags using xslt
string | $html | The html string protected |
static tariqaClientLoggedIn | ( | $ | soapConfig | ) | [static] |
Is the tariqa client logged in?
array | $soapConfig | The soap configuration array public |
static tariqaClientLogIn | ( | $ | user, |
$ | appConfig, | ||
$ | soapConfig | ||
) | [static] |
Logs in the tariqa client
tariqaUser | $user | The ECAS user |
array | $appConfig | The main application configuration array |
array | $soapConfig | The SOAP configuration array public |
static URL | ( | $ | script, |
$ | parameters = null , |
||
$ | urlencode = false |
||
) | [static] |
Compose an URL from a script and a list of parameters
string | $script | The script name |
mixed | $params | The list of parameters (as a string or as an associative array)[OPTIONAL] |
bool | $urlencode | Set to true to URL encode arguments. Note: it will be ignored unless $params is an associative array of arguments [OPTIONAL] public |
TariqaClient $tariqaClient = null [static] |
The SOAP client
public
$tariqaClientExpire = null [static] |
$tariqaToken = null [static] |