File/contenido/plugins/mod_rewrite/includes/functions.mod_rewrite.php

Description

Defines the 'modrewrite' related helper functions

Functions
mr_arrayValue (line 700)

Returns value of an array key (assoziative or indexed).

Shortcut function for some ways to access to arrays:

  1.  // old way
  2.  if (is_array($foo&& isset($foo['bar']&& $foo['bar'== 'yieeha'{
  3.      // do something
  4.  }
  5.  
  6.  // new, more readable way:
  7.  if (mr_arrayValue($foo'bar'== 'yieeha'{
  8.      // do something
  9.  }
  10.  
  11.  // old way
  12.  if (is_array($foo&& isset($foo['bar'])) {
  13.      $jep $foo['bar'];
  14.  else {
  15.      $jep 'yummy';
  16.  }
  17.  
  18.  // new way
  19.  $jep mr_arrayValue($foo'bar''yummy');

  • return: Either the found value or the default value
mixed mr_arrayValue (array $array, mixed $key, [mixed $default = null])
  • array $array: The array
  • mixed $key: Position of an indexed array or key of an assoziative array
  • mixed $default: Default value to return
mr_buildGeneratedCode (line 428)

Replaces existing ancors inside passed code, while rebuilding the urls.

Will be called by chain 'Contenido.Content.conGenerateCode' or 'Contenido.Frontend.HTMLCodeOutput' depening on mod_rewrite settings.

  • return: New code
string mr_buildGeneratedCode (string $code)
  • string $code: Code to prepare
mr_buildNewUrl (line 401)

Works as a wrapper for creation of urls using Contenido_UrlBuilder_MR.

Will be called by chain 'Contenido.Frontend.CreateURL'.

  • return: New URL
string mr_buildNewUrl (string $url)
  • string $url: URL to rebuild
mr_conCopyArtLang (line 326)

Processes mod_rewrite related job for duplicated articles.

Will be called by chain 'Contenido.Article.conCopyArtLang_AfterInsert'.

  • return: Loop through of arguments
array mr_conCopyArtLang (array $data)
  • array $data: Assoziative array with record entries
mr_conMoveArticles (line 297)

Processes mod_rewrite related job for articles beeing moved.

Will be called by chain 'Contenido.Article.conMoveArticles_Loop'.

  • return: Loop through of arguments
array mr_conMoveArticles (array $data)
  • array $data: Assoziative array with record entries
mr_conSaveArticle (line 253)

Processes mod_rewrite related job for saved articles (new or modified article).

Will be called by chain 'Contenido.Action.con_saveart.AfterCall'.

  • return: Passed parameter
array mr_conSaveArticle ( $data)
  • array $data: Assoziative array with some article properties
mr_conSyncArticle (line 361)

Processes mod_rewrite related job for synchronized articles.

Will be called by chain 'Contenido.Article.conSyncArticle_AfterInsert'.

  • return: Loop through of argument
array mr_conSyncArticle (array $data)
  • array $data: Assoziative array with record entries as follows:
    1.  array(
    2.      'src_art_lang'  => Recordset (assoziative arrayof source item from con_art_lang table
    3.      'dest_art_lang' => Recordset (assoziative arrayof inserted destination item from con_art_lang table
    4.  );
mr_debugOutput (line 785)

Debug output only during development

void mr_debugOutput ([ $print = true])
  • $print
mr_header (line 768)

Replaces calling of header method for redirects in front_content.php, used during development.

void mr_header ($header $header)
  • $header $header: Header value for redirect
mr_loadConfiguration (line 558)

Loads Advanced Mod Rewrite configuration for passed client using serialized file containing the settings.

File is placed in /contenido/mod_rewrite/includes/and is named like config.mod_rewrite_{client_id}.php.

void mr_loadConfiguration (int $clientId, [bool $forceReload = false])
  • int $clientId: Id of client
  • bool $forceReload: Flag to force to reload configuration, e. g. after done changes on it
mr_queryAndNextRecord (line 657)

Database query helper. Used to execute a select statement and to return the result of first recordset.

Minimizes following code:

  1.  // default way
  2.  $db  new DB_Contenido();
  3.  $sql "SELECT * FROM foo WHERE bar='foobar'";
  4.  $db->query($sql);
  5.  $db->next_record();
  6.  $data $db->Record;
  7.  
  8.  // new way
  9.  $sql  "SELECT * FROM foo WHERE bar='foobar'";
  10.  $data mr_queryAndNextRecord($sql);

  • return: Assoziative array including recordset or null
mixed mr_queryAndNextRecord (string $query)
  • string $query: Query to execute
mr_removeMultipleChars (line 624)

Cleanups passed string from characters beeing repeated two or more times

  • return: Cleaned string
string mr_removeMultipleChars (string $char, string $string)
  • string $char: Character to remove
  • string $string: String to clean from character
mr_requestCleanup (line 735)

Request cleanup function. Request data is allways tainted and must be filtered.

Pass the array to cleanup using several options. Emulates array_walk_recursive().

  • return: Cleaned data
mixed mr_requestCleanup ( &$data, [array $options = null], mixed $data)
  • mixed $data: Data to cleanup
  • array $options: Default options array, provides only 'filter' key with several filter functions which are to execute as follows:
    1.  $options['filter'array('trim''myFilterFunc');
    If no filter functions are set, 'trim', 'strip_tags' and 'stripslashes' will be used by default. A userdefined function must accept the value as a parameter and must return the filtered parameter, e. g.
    1.  function myFilter($data{
    2.     // do what you want with the data, e. g. cleanup of xss content
    3.     return $data;
    4.  }
  • &$data
mr_runFrontendController (line 599)

Includes the frontend controller script which parses the url and extacts needed data like idcat, idart, lang and client from it.

Will be called by chain 'Contenido.Frontend.AfterLoadPlugins' at front_content.php.

  • return: Just a return value
bool mr_runFrontendController ()
mr_setClientLanguageId (line 516)

Sets language of client, like done in front_content.php

void mr_setClientLanguageId (int $client)
  • int $client: Client id
mr_strCopyCategory (line 224)

Processes mod_rewrite related job after copying a category subtree.

Will be called by chain 'Contenido.Category.strCopyCategory'.

  • return: Passed parameter
array mr_strCopyCategory ( $data)
  • array $data: Assoziative array with some values
mr_strMovedownCategory (line 150)

Processes mod_rewrite related job after moving a category down.

Will be called by chain 'Contenido.Action.str_movedowncat.AfterCall'.

  • return: Category id
  • todo: do we really need processing of the category? there is no mr relevant data changes while moving the category on same level, level and name won't change
int mr_strMovedownCategory (int $idcat)
  • int $idcat: Id of category beeing moved down
mr_strMoveSubtree (line 181)

Processes mod_rewrite related job after moving a category subtree.

Will be called by chain 'Contenido.Action.str_movesubtree.AfterCall'.

  • return: Passed parameter
array mr_strMoveSubtree ( $data)
  • array $data: Assoziative array with some values
mr_strMoveUpCategory (line 115)

Processes mod_rewrite related job after moving a category up.

Will be called by chain 'Contenido.Action.str_moveupcat.AfterCall'.

  • return: Category id
  • todo: do we really need processing of the category? there is no mr relevant data changes while moving the category on same level, level and name won't change
int mr_strMoveUpCategory (int $idcat)
  • int $idcat: Category id
mr_strNewCategory (line 67)

Processes mod_rewrite related job for created new category.

Will be called by chain 'Contenido.Action.str_newcat.AfterCall'.

  • return: Passed parameter
array mr_strNewCategory ( $data)
  • array $data: Assoziative array with some values
mr_strNewTree (line 43)

Processes mod_rewrite related job for created new tree.

Will be called by chain 'Contenido.Action.str_newtree.AfterCall'.

  • return: Passed parameter
array mr_strNewTree ( $data)
  • array $data: Assoziative array with some values
mr_strRenameCategory (line 90)

Processes mod_rewrite related job for renamed category.

Will be called by chain 'Contenido.Action.str_renamecat.AfterCall'.

  • return: Passed parameter
array mr_strRenameCategory ( $data)
  • array $data: Assoziative array with some values

Documentation generated on Tue, 25 Nov 2008 22:07:35 +0100 by phpDocumentor 1.4.1