[ Index ]

PHP Cross Reference of Mambo 4.6.5
[ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/includes/ -> cmtclasses.php (summary)

[Source view] [Print] [Project Stats]

Some Components, Modules, Mambots and Templates classes

Author: Mambo Foundation Inc see README.php
Copyright: (C) 2000 - 2009 Mambo Foundation Inc.
License: GNU/GPL Version 2, see LICENSE.php
File Size: 983 lines (33 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 10 classes

mosComponentHandler:: (5 methods):
  getInstance()
  getParamsByName()
  mosMainBody()
  startBuffer()
  endBuffer()

mosComponent:: (1 method):
  mosComponent()

mosComponentManager:: (5 methods):
  mosComponentManager()
  noMagicQuotes()
  remove_magic_quotes()
  restore_magic_quotes()
  checkCallable()

mosComponentUserManager:: (2 methods):
  mosComponentUserManager()
  newHTMLClassCheck()

mosComponentAdminManager:: (4 methods):
  mosComponentAdminManager()
  check_selection()
  getAction()
  newHTMLClassCheck()

mosComponentAdminControllers:: (2 methods):
  mosComponentAdminControllers()
  makePageNav()

mosTemplate:: (1 method):
  mosTemplate()

mosMambot:: (1 method):
  mosMambot()

mosModuleHandler:: (10 methods):
  mosModuleHandler()
  getInstance()
  get()
  initBuffers()
  initModules()
  mosCountModules()
  getByName()
  mosLoadModules()
  mosLoadAdminModules()
  canAccess()

mosModule:: (2 methods):
  mosModule()
  check()


Class: mosComponentHandler  - X-Ref

Singleton class to handle with current component

This class controls the start, end and send output buffer from current component
getInstance()   X-Ref
Return a reference to current handler

This function returns a reference to current component handler, if none handler exists,
it creates one.

Example of use:

<code>$c_handler =& mosComponentHandler::getInstance();</code>

return: object reference to current singleton Handler

getParamsByName($name)   X-Ref
Returns the admin parameters from a component

This function returns a reference to specified component in $name param, if none parameters
are founded it returns null.

return: object mosParameters object with parameters, null if none was founded.

mosMainBody()   X-Ref
Writes the output from current component

This function send to client browser the outputs from the component, it's
called by mosMainBody() global function.


startBuffer()   X-Ref
Start the use of buffer

This function start the use of buffers to components output


endBuffer()   X-Ref
Ends the use of buffer

This function ends the use of buffers to components output, all outputs
are stored in $this->_buffer


Class: mosComponent  - X-Ref

Components database table class

This class can be used to gain access to #_components database table

mosComponent()   X-Ref
mosComponent class Contructor


Class: mosComponentManager  - X-Ref

Abstract component common base class for both user and admin sides

Since 4.6 version a new way to develop components based in MVC pattern was included,
this requires that each component should to create a instance from mosComponentUserManager
to user(frontend) side and a instance from mosComponentAdminManager to admin(backend) side,
both classes are derived from this abstract class

mosComponentManager($component_name, $version)   X-Ref
mosComponentManager Class contructor

This constructor initiates all necessary members, clear all magic quotes if
is present and load the language from component

param: string component name
param: string component version

noMagicQuotes()   X-Ref
remove magic quotes from Superglobals arrays

This function removes the magic quotes if is present in $_REQUEST, $_GET
and $_POST arrays


remove_magic_quotes($array)   X-Ref
remove magic quotes and slashes from a array

This function removes the magic quotes if is present in passed array

param: array array to strip quotes and slashes
return: array reference to converted array

restore_magic_quotes()   X-Ref
restore magic quotes from old value

This function restore the old value of magic_quotes_runtime


checkCallable(&$object, $method)   X-Ref
checks for a method in a class

This function returns TRUE when $method is a member of $object

param: object Reference to the object
param: string method name that is looking for
return: bool TRUE when $method exits

Class: mosComponentUserManager  - X-Ref

Component base controller for user(frontend) side

Since 4.6 version a new way to develop components based in MVC pattern was included,
this requires that each component should to create a instance from mosComponentUserManager
to user(frontend) side.

mosComponentUserManager($component_name, $control_name, $alternatives, $default, $title, $version)   X-Ref
mosComponentUserManager Class contructor

This constructor initiates all necessary members, sets the title to browser,
creates a new instance of the correct class and calls the action to do, finally
restore the magic quotes to it initial state

param: string component name
param: string variable used as control
param: array array whin alternavite names to actions methods
param: string default action to do
param: string browser title to show when the component is in use
param: string component version

newHTMLClassCheck($name, &$controller, $total_items, $clist)   X-Ref
Loads and returns a class for render HTML (view Object)

This function load a class for view html an associated controller is passed

param: string HTML view class name
param: object reference to controller object
param: int not used
param: int list of items to show
return: mixed a instance to the HTML class, FALSE if the class is not founded

Class: mosComponentAdminManager  - X-Ref

Component base controller for admin side

Since 4.6 version a new way to develop components based in MVC pattern was included,
this requires that each component should to create a instance from mosComponentAdminManager
to admin(backend) side.

mosComponentAdminManager($component_name, $version)   X-Ref
mosComponentAdminManager Class contructor

This constructor initiates all necessary members with values passed trought REQUEST
creates a new instance of the correct class and calls the task to do, finally
restore the magic quotes to it initial state.

param: string component name
param: string component version

check_selection($text)   X-Ref
Checks that at least one item selected

param: string alert message

getAction()   X-Ref
returns the class name from the current action

return: string class name from the current action

newHTMLClassCheck($name, &$controller, $total_items, $clist)   X-Ref
Loads and returns a class for render HTML (view Object)

This function load a class for view html an associated controller is passed

param: string HTML view class name
param: object reference to controller object
param: int
param: int list of items to show
return: mixed a instance to the HTML class, FALSE if the class is not founded

Class: mosComponentAdminControllers  - X-Ref

Abstract component base class for admin side component controller logic (not used yet)

mosComponentAdminControllers($admin)   X-Ref
mosComponentAdminControllers Class contructor

param: object $admin

makePageNav(&$admin, $total)   X-Ref
Creates a mosPageNav object

param: object component name
param: int not used

Class: mosTemplate  - X-Ref

Template database table class

This class can be used to gain access to #_templates database table

mosTemplate( &$database )   X-Ref
mosTemplate Class contructor

Init a mosDBTable object.

param: object &$database reference to current database object

Class: mosMambot  - X-Ref

Mambot database table class

This class can be used to gain access to #_mambots database table

mosMambot( &$db )   X-Ref
mosMambot Class contructor

Init a mosDBTable object.

param: object reference to current database object

Class: mosModuleHandler  - X-Ref

Singleton class to handle with modules

This class loads, counts and caches modules for both sides, user and admin

mosModuleHandler()   X-Ref
mosModuleHandler Class contructor

Init the database object.


getInstance()   X-Ref
Returns a reference to current handler

This function returns a reference to current modules handler, if none handler exists,
it creates one.

return: object reference to current singleton Handler

get($property)   X-Ref
No description

initBuffers($isAdmin=false)   X-Ref
Caches some modules output

This function cache all modules output, a $isAdmin bool value can be passed to select
the side (user/admin) by default user modules are loaded.

param: bool TRUE when admin modules will loaded

initModules($isAdmin=false)   X-Ref
Caches some modules information

This function cache all modules, a $isAdmin bool value can be passed to select
the side (user/admin) by default user modules are loaded.

param: bool TRUE when admin modules will loaded

mosCountModules( $position='left', $isAdmin=false )   X-Ref
Returns the number of modules in a specified position, this method is called by
mosCountModules global function

param: string The template position
param: bool TRUE when admin modules will loaded

getByName( $name, $isAdmin=false, $unpublished=false )   X-Ref
Returns a array with modules that match whit $name, when $unpublished is TRUE
unpublished modules are returned too.

param: string Name of module required
param: bool TRUE when admin modules will loaded
param: bool TRUE whish to include unpublished modules too
return: array array with all modules that match

mosLoadModules( $position='left', $style=0, $isAdmin=false )   X-Ref
Loads all published modules from a specified position, a $style can be passed
to change the style of output

param: string The position
param: int The style.  0=normal(default), 1=horiz, -1=no wrapper
param: bool TRUE when admin modules will loaded

mosLoadAdminModules( $position='left', $style=0 )   X-Ref
Loads admin modules from a specified position,a $style can be passed
to change the style of output

param: string The position
param: int The style 0 = no style(default), 1 = tabbed, 2 = use div

canAccess($module, $gid)   X-Ref
Module access check

Used in

param: object a module object
param: int an array of groups

Class: mosModule  - X-Ref

Modules database table class

This class can be used to gain access to #_modules database table

Example of use:

To load all modules in a object..

<code>
$row = new mosModule();
$query = "SELECT * FROM #_modules";
$database =& mamboDatabase::getInstance();
$database->setQuery( $query );
if ($database->loadObject($row)) {
...
}
</code>
mosModule( &$db )   X-Ref
mosModule Class contructor

Init a mosDBTable object.

param: object reference to current database object

check()   X-Ref
overloaded check function