XOOPS RMCommon Utilities  2.1.8.91RC
 All Classes Namespaces Files Functions Variables
RMFunctions Class Reference

Public Member Functions

 add_keywords_description ($description, $keywords='', $limit=50)
 
 comments_form ($obj, $params, $type='module', $file=array())
 
 configs ($name='')
 
 create_toolbar ()
 
 current_url ()
 
 delete_comments ($module, $params)
 
 get ()
 
 get_comments ($obj, $params, $type='module', $parent=0, $user=null, $assign=true)
 
 get_groups_names ($groups, $list=true)
 
 get_image ($id, $size='')
 
 get_modules_list ($active=-1)
 
 get_num_records ($table, $filters='')
 
 installed_plugins ()
 
 load_images_categories ($filters='ORDER BY id_cat DESC', $object=false)
 
 load_module ($mod)
 
 load_plugin ($name)
 
 plugin_installed ($dir)
 
 plugin_settings ($dir, $values=false)
 
 urlencode_array ($array, $name, $separator='&')
 

Private Member Functions

 getConfValueForOutput ($confs)
 

Private Attributes

 $plugin_settings = array()
 

Detailed Description

Definition at line 11 of file functions.php.

Member Function Documentation

RMFunctions::add_keywords_description (   $description,
  $keywords = '',
  $limit = 50 
)

Add keywords and description metas

Parameters
stringDescription for meta content
stringKeywords for meta content. If hti svalue is empty then will generate from description
intLimit of keywrods to generate

Definition at line 571 of file functions.php.

References $id, $limit, $tpl, RMTemplate\get(), and TextCleaner\getInstance().

Here is the call graph for this function:

RMFunctions::comments_form (   $obj,
  $params,
  $type = 'module',
  $file = array() 
)

Create the comments form You need to include the template 'rmc_comments_form.html' where you wish to show this form

Parameters
stringObject name (eg. mywords, qpages, etc.)
stringParams to be included in form
stringObject type (eg. module, plugin, etc.)
stringFile path to get the methods to update comments

Definition at line 298 of file functions.php.

References $file, $type, $xoopsUser, __(), current_url(), RMEvents\get(), RMTemplate\get(), and RMCURL.

Here is the call graph for this function:

RMFunctions::configs (   $name = '')
RMFunctions::create_toolbar ( )

Create the module toolbar. This function must be called only from rmcommon module administration

Definition at line 76 of file functions.php.

References $cat, __(), elseif(), RMEvents\get(), RMTemplate\get(), rmc_server_var(), and RMCLOCATION.

Referenced by configure_rm_plugin(), edit_comment(), edit_image(), images_form(), module_install(), module_install_now(), module_uninstall_now(), module_update_now(), new_category(), show_categories(), show_comments(), show_dashboard(), show_images(), show_modules_list(), show_rm_blocks(), show_rm_plugins(), show_users(), update_thumbnails(), and user_form().

Here is the call graph for this function:

Here is the caller graph for this function:

RMFunctions::current_url ( )

Definition at line 377 of file functions.php.

Referenced by comments_form(), RmcommonCorePreload\eventCoreIncludeCommonLanguage(), and RmcommonRmcommonPreload\eventRmcommonXoopsCommonEnd().

Here is the caller graph for this function:

RMFunctions::delete_comments (   $module,
  $params 
)

Delete comments assigned to a object

Parameters
stringModule name
stringParams

Definition at line 363 of file functions.php.

References $db, $sql, and RMEvents\get().

Here is the call graph for this function:

RMFunctions::get_comments (   $obj,
  $params,
  $type = 'module',
  $parent = 0,
  $user = null,
  $assign = true 
)

Get all comments for given parameters

Parameters
stringObject id (can be a module name)
stringParams for comment item
stringObject type (eg. module, plugin, etc)
intComment parent id, will return all comments under a given parent
intUser that has been posted the comments
Returns
array

Definition at line 194 of file functions.php.

References $db, $result, $rmc_config, $sql, $type, $xoopsUser, __(), configs(), elseif(), RMEvents\get(), TextCleaner\getInstance(), and RMCURL.

Here is the call graph for this function:

RMFunctions::get_groups_names (   $groups,
  $list = true 
)

This functions allows to get the groups names for a single category

Parameters
arrayGroups ids
boolReturn as list
Returns
array|list

Definition at line 137 of file functions.php.

References $db, $result, $ret, $sql, and __().

Referenced by show_categories().

Here is the call graph for this function:

Here is the caller graph for this function:

RMFunctions::get_image (   $id,
  $size = '' 
)

Get an image from image manager

Parameters
$idint Image id
stringSize name from category

Definition at line 532 of file functions.php.

References $cat, $file, $id, and $s.

RMFunctions::get_modules_list (   $active = -1)

Get modules list

Definition at line 494 of file functions.php.

References $db, $modules, $result, and $sql.

Referenced by RMBlocksFunctions\get_available_list(), and show_rm_blocks().

Here is the caller graph for this function:

RMFunctions::get_num_records (   $table,
  $filters = '' 
)

Check the number of images category on database

Definition at line 60 of file functions.php.

References $db, and $sql.

Referenced by save_category(), show_categories(), and show_images().

Here is the caller graph for this function:

RMFunctions::getConfValueForOutput (   $confs)
private

Definition at line 421 of file functions.php.

References $data.

Referenced by plugin_settings().

Here is the caller graph for this function:

RMFunctions::installed_plugins ( )

Definition at line 512 of file functions.php.

References $db, $plugins, $result, and RMEvents\get().

Here is the call graph for this function:

RMFunctions::load_images_categories (   $filters = 'ORDER BY id_cat DESC',
  $object = false 
)

Load all categories from database

Parameters
stringSQL Filters
Returns
array

Definition at line 164 of file functions.php.

References $db, $result, and $sql.

Referenced by edit_image(), images_form(), and show_images().

Here is the caller graph for this function:

RMFunctions::load_module (   $mod)

Load a module as XoopsModule object

Parameters
int|stringModule id or module name
Returns
object XoopsModule

Definition at line 480 of file functions.php.

References $mh, and $mod.

Referenced by RMBlocksFunctions\construct_blocks(), insertBlock(), DesigniaFunctions\module_icon(), Twop6Functions\moduleIcon(), DesigniaFunctions\moduleMenu(), Twop6Functions\moduleMenu(), RMFormModules\render(), rmc_bkcomments_show(), and show_rm_blocks().

Here is the caller graph for this function:

RMFunctions::load_plugin (   $name)

Get a existing plugin

Definition at line 458 of file functions.php.

References $class, and RMCPATH.

RMFunctions::plugin_installed (   $dir)

Check if a plugin is installed and active in Common Utilities

Definition at line 446 of file functions.php.

References $dir, and $GLOBALS.

Referenced by show_images().

Here is the caller graph for this function:

RMFunctions::plugin_settings (   $dir,
  $values = false 
)

Get plugins settings

Parameters
stringPlugin dirname
boolType of values returned

Definition at line 390 of file functions.php.

References $db, $dir, $result, $ret, $sql, and getConfValueForOutput().

Here is the call graph for this function:

RMFunctions::urlencode_array (   $array,
  $name,
  $separator = '&' 
)

Encode array keys to make a valid url string

Parameters
arrayArray to encode
stringVar name to generate url
stringURL separator

Definition at line 117 of file functions.php.

Member Data Documentation

RMFunctions::$plugin_settings = array()
private

Definition at line 13 of file functions.php.


The documentation for this class was generated from the following file: