Docs For Class ModRewrite

ModRewrite

Description

Class to create websafe names

TODO: Adapt to PHP 5 coding standards...

author: Stefan Seifarth / stese

Located in /classes/class.modrewrite.php (line 41)

Method Summary

ModRewrite ModRewrite ()

string build_new_url ([string $str_args = ""], [ $str_xhtml = true])

string build_recursiv_path ([integer $int_id = 0], [ $int_lang_id = 0], [ $int_lastid = 0])

string contenido_html_anchor ([array $arr_matches = array()], [ $str_xhtml = true])

array get_artids ([integer $int_id = 0])

string get_arttitle ([integer $int_id = 0], [integer $int_lang_id = 0])

string get_art_lang_websafename ([integer $int_id = 0])

string get_art_websafename ([integer $int_id = 0], [integer $int_lang_id = 0])

string get_catname ([integer $int_id = 0], [integer $int_lang_id = 0])

array get_cat_languages ([integer $int_id = 0])

array get_client_full_url_parts (string $url)

string get_client_name ([integer $int_id = 0])

Array get_id_from_idartlang ([integer $int_id = 0])

mixed get_id_from_pathresolver_result (array $results)

array get_language_name ([int $int_id = 0])

string get_language_name_old ([integer $int_id = 0])

boolean in_articles ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0], [ $int_idcat = 0])

boolean in_category ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0])

void is_enabled ()

void reset_aliases ()

void reset_articles_aliases ()

void reset_categories_aliases ()

string rewrite_html_anchor ([array $arr_matches = array()])

boolean set_article ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0], [ $int_idcat = 0])

boolean set_category ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0])

bool validate_setting_categories_as_html ()

Methods

Constructor ModRewrite (line 46)

Constructor Function

ModRewrite ModRewrite ()

build_new_url (line 474)

build_new_url()

build new url from given arguments

get querystring of front_content.php and convert this url to the new mod_rewrite url method will be startet before the complete output of the front site will be executed

return: new url
deprecated: Functionaliy will be managed by Contenido_UrlBuilder_MR Is no more used and should removed, Murat Purc

string build_new_url ([string $str_args = ""], [ $str_xhtml = true])

string $str_args: given arguments
$str_xhtml

build_recursiv_path (line 348)

build_recursiv_path()

build a recursiv path for mod_rewrite rule like server directories ( dir1/dir2/dir3 )

return: linkpath with correct uri

string build_recursiv_path ([integer $int_id = 0], [ $int_lang_id = 0], [ $int_lastid = 0])

integer $int_id: latest category id
$int_lang_id
$int_lastid

contenido_html_anchor (line 440)

return full contenido url from single anchor

return: new anchor

string contenido_html_anchor ([array $arr_matches = array()], [ $str_xhtml = true])

array $arr_matches: [0] = complete anchor, [1] = pre arguments, [2] = anchor name, [3] = post arguments
$str_xhtml

get_artids (line 329)

get_artids()

get article title, language id

return: title, idlang

array get_artids ([integer $int_id = 0])

integer $int_id: idartlang

get_arttitle (line 286)

get_arttitle()

get article name from article id and language id

return: article name

string get_arttitle ([integer $int_id = 0], [integer $int_lang_id = 0])

integer $int_id: article id
integer $int_lang_id: language id

get_art_lang_websafename (line 703)

get_art_lang_websafename()

get article websafe name from idartlang

return: article websafe name

string get_art_lang_websafename ([integer $int_id = 0])

integer $int_id: idartlang

get_art_websafename (line 685)

get_art_websafename()

get article websafe name from article id and language id

return: article websafe name

string get_art_websafename ([integer $int_id = 0], [integer $int_lang_id = 0])

integer $int_id: article id
integer $int_lang_id: language id

get_catname (line 267)

get_catname()

get category name from category id and language id

return: category name

string get_catname ([integer $int_id = 0], [integer $int_lang_id = 0])

integer $int_id: category id
integer $int_lang_id: language id

get_cat_languages (line 304)

get_cat_languages()

get language ids from category id

return: used language ids

array get_cat_languages ([integer $int_id = 0])

integer $int_id: category id

get_client_full_url_parts (line 790)

get_client_full_url_parts() Splits passed argument into scheme://host and path/query.

Example: input = http://host/front_content.php?idcat=123 return = array('htmlpath' => 'http://host', 'url' => 'front_content.php?idcat=123')

return: Assoziative array including the two parts:
- array('htmlpath' => $path, 'url' => $url)

array get_client_full_url_parts (string $url)

string $url: URL to split

get_client_name (line 721)

get_client_name()

get name of client id

return: language name

string get_client_name ([integer $int_id = 0])

integer $int_id: language id

get_id_from_idartlang (line 248)

get_id_from_idartlang()

get article id and language id from article language id

return: Array with idart and idlang of current article

Array get_id_from_idartlang ([integer $int_id = 0])

integer $int_id: current article id

get_id_from_pathresolver_result (line 893)

Used to postprocess resolved path

Error site handling if category not found

if percentage == 100 and there is no 100 percentage result value, error site will be shown - can be adjust by user settings for smooth similar effects - 80 to 95 will be best but have to check by user

return: Categoryid or false

mixed get_id_from_pathresolver_result (array $results)

array $results: Pathresolver results array

get_language_name (line 755)

Returns name of language

return: Assoziative array containing lanuage names ($a[id] = 'name')

array get_language_name ([int $int_id = 0])

int $int_id: Language id

get_language_name_old (line 739)

get_language_name()

get name of language id

return: language name

string get_language_name_old ([integer $int_id = 0])

integer $int_id: language id

in_articles (line 108)

in_articles()

Check articles on websafe name

Check all articles in the current category on existing same websafe name

return: true if websafename already exists, false if not

boolean in_articles ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0], [ $int_idcat = 0])

string $str_name: Websafe name to check
integer $int_id: current article id
integer $int_lang_id: current language id
$int_idcat

in_category (line 69)

in_categories()

Check categories on websafe name

Check all categories in the main parent category on existing same websafe name

return: true if websafename already exists, false if not

boolean in_category ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0])

string $str_name: Websafe name to check
integer $int_id: current category id
integer $int_lang_id: current language id

is_enabled (line 51)

void is_enabled ()

reset_aliases (line 875)

reset_aliases()

method to reset all aliases (category and article)

void reset_aliases ()

reset_articles_aliases (line 849)

reset_articles_aliases()

method to reset all aliases in articles

void reset_articles_aliases ()

reset_categories_aliases (line 823)

reset_categories_aliases()

method to reset all aliases in categories

void reset_categories_aliases ()

rewrite_html_anchor (line 394)

return full contenido url from single anchor

return: new anchor

string rewrite_html_anchor ([array $arr_matches = array()])

array $arr_matches: [0] = complete anchor, [1] = pre arguments, [2] = anchor name, [3] = post arguments

set_article (line 150)

set_article()

set websafe name in article list

insert new websafe name in article list

return: true if insert was successfully

boolean set_article ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0], [ $int_idcat = 0])

string $str_name: original name (will be converted)
integer $int_id: current article id
integer $int_lang_id: current language id
$int_idcat

set_category (line 200)

set_category()

set websafe name in category list

insert new websafe name in category list

return: true if insert was successfully

boolean set_category ([string $str_name = ""], [integer $int_id = 0], [integer $int_lang_id = 0])

string $str_name: original name (will be converted) or alias
integer $int_id: current article id
integer $int_lang_id: current language id

validate_setting_categories_as_html (line 913)

Analyses the settings for usage of categories as a html file and returns the result as a boolean

return: True if settings are active and valid otherwhise false.

bool validate_setting_categories_as_html ()

Documentation generated on Sun, 03 Aug 2008 22:21:45 +0200 by phpDocumentor 1.4.0