Mambo > Projects > Mambo CMS > SVN

Diff of /mambo/branches/4.6/includes/cmtclasses.php

-revision 814, Fri Dec  8 12:53:45 2006 UTC
+revision 815, Sat Dec  9 04:02:08 2006 UTC
 Line 1
  <?php
  /**
- * Component handler class
+ * Some Components, Modules, Mambots and Templates classes
  * @package Mambo
+ * @copyright (C) 2005 - 2006 Mambo Foundation Inc.
+ * @license http://www.gnu.org/copyleft/gpl.html GNU/GPL
+ * @author Mambo Foundation Inc see README.php
  */
+ /**
+ * Singleton class to handle with current component
+ *
+ * This class controls the start, end and send output buffer from current component
+ * @package Mambo
+ * @acces public
+ */
  class mosComponentHandler {
+     /**
+     * stores the output from current component
+     *
+     * @acces private
+     * @var string
+     */
          var $_buffer = '';
+     /**
+     * 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>
+     *
+     * @acces public
+     * @return object reference to current singleton Handler
+     */
          function &getInstance () {
                  static $instance;
                  if (!is_object($instance)) $instance = new mosComponentHandler();
                  return $instance;
          }
+     /**
+     * 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.
+     *
+     * Example of use:
+     *
+     * Obtains the admin parameters from the syndicate component.
+     *
+     * <code>
+     * $c_handler =& mosComponentHandler::getInstance();
+     * $params =& $c_handler->getParamsByName("syndicate");
+     * </code>
+     *
+     * @acces public
+     * @return object mosParameters object with parameters, null if none was founded.
+     */
          function &getParamsByName ($name) {
                  $params = null;
                  $row = new mosComponent();
-Line 30
+Line 78
                  return $params;
          }
+     /**
+     * Writes the output from current component
+     *
+     * This function send to client browser the outputs from the component, it's
+     * called by mosMainBody() global function.
+     *
+     * @acces private
+     */
          function mosMainBody() {
                  // message passed via the url
                  $mosmsg = mosGetParam($_REQUEST, 'mosmsg', '');
-Line 42
+Line 98
  //              echo "\n<script language=\"javascript\">alert('$mosmsg');</script>";
          }
+     /**
+     * Start the use of buffer
+     *
+     * This function start the use of buffers to components output
+     *
+     * @acces private
+     */
          function startBuffer () {
                  $this->_buffer = '';
                  ob_start();
          }
+     /**
+     * Ends the use of buffer
+     *
+     * This function ends the use of buffers to components output, all outputs
+     * are stored in $this->_buffer
+     *
+     * @acces private
+     */
          function endBuffer () {
                  $this->_buffer = ob_get_contents();
                  ob_end_clean();
          }
  }
  /**
- * Component database table class
+ * Components database table class
+ *
+ * This class can be used to gain access to #_components database table
+ *
+ * Example of use:
+ *
+ * To load no core components...
+ *
+ * <code>
+ * $row = new mosComponent();
+ * $query = "SELECT * FROM #__components AS a WHERE iscore = 0";
+ * $database =& mamboDatabase::getInstance();
+ * $database->setQuery( $query );
+ * if ($database->loadObject($row)) {
+ * ...
+ * }
+ * </code>
  * @package Mambo
+ * @access public
  */
  class mosComponent extends mosDBTable {
          /** @var int Primary key */
          var $id=null;
-         /** @var string */
+     /** @var string component name*/
          var $name=null;
-         /** @var string */
+     /** @var string component link*/
          var $link=null;
-         /** @var int */
+     /** @var int menu id*/
          var $menuid=null;
-         /** @var int */
+     /** @var int parent menu*/
          var $parent=null;
-         /** @var string */
+     /** @var string component admin link*/
          var $admin_menu_link=null;
-         /** @var string */
+     /** @var string alternative text for admin menu*/
          var $admin_menu_alt=null;
-         /** @var string */
+     /** @var string component option id*/
          var $option=null;
-         /** @var string */
+     /** @var string order*/
          var $ordering=null;
-         /** @var string */
+     /** @var string image from admin menu*/
          var $admin_menu_img=null;
-         /** @var int */
+     /** @var int 1 core component ,0 others */
          var $iscore=null;
-         /** @var string */
+     /** @var string component parameters*/
          var $params=null;
          /**
-         * @param database A database connector object
+     * mosComponent class Contructor
+     * @access private
          */
          function mosComponent() {
                  $db = mamboDatabase::getInstance();
                  $this->mosDBTable( '#__components', 'id', $db );
          }
  }
  /**
- * Component common base class for both user and admin sides
+ * 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
+ *
  * @package Mambo
+ * @access public
  */
  class mosComponentManager {
+     /** @var string component name */
          var $plugin_name = '';
          var $magic_quotes_value = 0;
+     /** @var int current magic quotes value, used to restore it */
          var $magic_quotes_restore = '';
+     /** @var string component version*/
          var $plugin_version = '';
+     /** @var string option from URL*/
          var $option = '';
+     /**
+     * mosComponentManager Class contructor
+     *
+     * This constructor initiates all necessary members, clear all magic quotes if
+     * is present and load the language from component
+     *
+     * @access private
+     * @param string $component_name component name
+     * @param string $version component version
+     */
          function mosComponentManager ($component_name, $version) {
                  $this->text_name = $component_name;
                  $this->plugin_name = strtolower(str_replace(' ', '', $component_name));
-Line 116
+Line 228
          }
+     /**
+     * remove magic quotes from Superglobals arrays
+     *
+     * This function removes the magic quotes if is present in $_REQUEST, $_GET
+     * and $_POST arrays
+     *
+     * @access private
+     */
          function noMagicQuotes () {
                  // Is magic quotes on?
                  if (get_magic_quotes_gpc()) {
-Line 128
+Line 248
                  $this->magic_quotes_value = 0;
          }
+     /**
+     * remove magic quotes and slashes from a array
+     *
+     * This function removes the magic quotes if is present in passed array
+     *
+     * @access private
+     * @param array $array array to strip quotes and slashes
+     * @return array reference to converted array
+     */
          function &remove_magic_quotes ($array) {
                  foreach ($array as $k => $v) {
                          if (is_array($v)) $array[$k] = $this->remove_magic_quotes($v);
-Line 136
+Line 265
                  return $array;
          }
+     /**
+     * restore magic quotes from old value
+     *
+     * This function restore the old value of magic_quotes_runtime
+     *
+     * @access private
+     */
          function restore_magic_quotes () {
                  set_magic_quotes_runtime($this->magic_quotes_restore);
          }
+     /**
+     * checks for a method in a class
+     *
+     * This function returns TRUE when $method is a member of $object
+     *
+     * @access public
+     * @param object &$object Reference to the object
+     * @param string $method method name that is looking for
+     * @return bool TRUE when $method exits
+     */
          function checkCallable (&$object, $method) {
                  if (is_callable(array(&$object, $method))) return true;
                  $name = get_class($object);
-Line 148
+Line 294
          }
  }
  /**
- * Component base logic for user side
+ * 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.
+ *
+ * Example of use:
+ *
+ * <code>
+ * $alternatives = array ();
+ * $admin =& new mosComponentUserManager ('mycom', 'task', $alternatives, 'list', 'My Component', '1.0');
+ * </code>
+ *
  * @package Mambo
+ * @access public
  */
  class mosComponentUserManager extends mosComponentManager {
+     /**
+     * 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
+     *
+     * @access private
+     * @param string $component_name component name
+     * @param string $control_name variable used as control
+     * @param array $alternatives array whin alternavite names to actions methods
+     * @param string $default default action to do
+     * @param string $title browser title to show when the component is in use
+     * @param string $version component version
+     */
          function mosComponentUserManager ($component_name, $control_name, $alternatives, $default, $title, $version) {
                  mosComponentManager::mosComponentManager($component_name, $version);
                  $mainframe =& mosMainFrame::getInstance();
-Line 171
+Line 346
                  $this->restore_magic_quotes();
          }
+     /**
+     * Loads and returns a class for render HTML (view Object)
+     *
+     * This function load a class for view html an associated controller is passed
+     *
+     * @access public
+     * @param strinf $name HTML view class name
+     * @param object &$controller reference to controller object
+     * @param int $total_items not used
+     * @param int $clist list of items to show
+     * @return mixed a instance to the HTML class, FALSE if the class is not founded
+     */
          function newHTMLClassCheck ($name, &$controller, $total_items, $clist) {
                  if (class_exists($name)) return new $name ($controller, $this->limit, $clist);
                  trigger_error(sprintf(T_('Component %s error: attempt to use non-existent class %s'), $this->plugin_name, $name));
-Line 178
+Line 365
          }
  }
  /**
- * Component base logic for admin side
+ * 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.
+ *
+ * Example of use:
+ *
+ * <code>
+ * $admin =& new mosComponentAdminManager ('mycom', '1.0');
+ * </code>
+ *
  * @package Mambo
+ * @access public
  */
  class mosComponentAdminManager extends mosComponentManager {
+     /** @var string action executed */
          var $act = '';
+     /** @var string task executed */
          var $task = '';
+     /** @var int init offset to admin list*/
          var $limitstart = 0;
+     /** @var int quantity of elements to show in list*/
          var $limit = 0;
+     /** @var mixed id or id's of selected objects in admin list */
          var $cfid = 0;
+     /** @var array order positions for all items */
          var $order = 0;
+     /** @var int first element of cfid */
          var $currid = 0;
+     /**
+     * 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 component name
+     * @param string $version component version
+     * @access private
+     */
          function mosComponentAdminManager ($component_name, $version) {
                  mosComponentManager::mosComponentManager($component_name, $version);
                  $this->act = mosGetParam ($_REQUEST, 'act', $this->plugin_name);
-Line 216
+Line 434
                  $this->restore_magic_quotes();
          }
+     /**
+     * Checks that at least one item selected
+     *
+     * @param string $text alert message
+     * @access public
+     */
          function check_selection ($text) {
                  if (!is_array($this->cfid) OR count( $this->cfid ) < 1) {
                          echo "<script> alert('".$text."'); window.history.go(-1);</script>\n";
-Line 223
+Line 447
                  }
          }
+     /**
+     * returns the class name from the current action
+     *
+     * @return string class name from the current action
+     * @access public
+     */
          function getAction () {
                  $actname = strtoupper(substr($this->act,0,1)).strtolower(substr($this->act,1));
                  return strtolower($this->plugin_name).'Admin'.$actname;
          }
+     /**
+     * Loads and returns a class for render HTML (view Object)
+     *
+     * This function load a class for view html an associated controller is passed
+     *
+     * @access public
+     * @param strinf $name HTML view class name
+     * @param object &$controller reference to controller object
+     * @param int $total_items not used
+     * @param int $clist list of items to show
+     * @return mixed a instance to the HTML class, FALSE if the class is not founded
+     */
          function newHTMLClassCheck ($name, &$controller, $total_items, $clist) {
                  $controller->makePageNav($this, $total_items);
                  if (class_exists($name)) return new $name ($controller, $this->limit, $clist);
-Line 236
+Line 478
          }
  }
  /**
- * Component base class for admin side component controller logic
+ * Abstract component base class for admin side component controller logic (not used yet)
+ *
  * @package Mambo
+ * @access public
+ * @todo This class is not used yet
  */
  class mosComponentAdminControllers {
+     /** @var string action executed */
          var $admin = '';
+     /** @var string curren user */
          var $user = '';
+     /** @var object Page navigation Object */
          var $pageNav = '';
+     /** @var string curren root path */
          var $rootPath = '';
+     /** @var string curren language */
          var $language = '';
+     /**
+     * mosComponentAdminControllers Class contructor
+     *
+     * @param object $admin
+     * @access private
+     */
          function mosComponentAdminControllers ($admin) {
                  $this->admin = $admin;
                  $this->user = mamboCore::get('currentUser');
-Line 254
+Line 511
                  $this->language = mamboCore::get('mosConfig_lang');
          }
+     /**
+     * Creates a mosPageNav object
+     *
+     * @param object &$admin component name
+     * @param int $total not used
+     * @access public
+     */
          function makePageNav (&$admin, $total) {
                  require_once(mamboCore::get('mosConfig_absolute_path').'/administrator/includes/pageNavigation.php');
                  $this->pageNav =& new mosPageNav( $total, $admin->limitstart, $admin->limit );
-Line 262
+Line 526
  }
  /**
- * Template Table Class
+ * Template database table class
+ *
+ * This class can be used to gain access to #_templates database table
+ *
+ * Example of use:
  *
- * Provides access to the mos_templates table
+ * To load all templates in a object..
+ *
+ * <code>
+ * $row = new mosTemplate();
+ * $query = "SELECT * FROM #__templates";
+ * $database =& mamboDatabase::getInstance();
+ * $database->setQuery( $query );
+ * if ($database->loadObject($row)) {
+ * ...
+ * }
+ * </code>
  * @package Mambo
+ * @access public
+ * @todo This class is not used yet
  */
  class mosTemplate extends mosDBTable {
-         /** @var int */
+     /** @var int table primary key */
          var $id=null;
-         /** @var string */
+     /** @var string is act*/
          var $cur_template=null;
          /** @var int */
          var $col_main=null;
          /**
-         * @param database A database connector object
+     * mosTemplate Class contructor
+     *
+     * Init a mosDBTable object.
+     *
+     * @param object &$database reference to current database object
+     * @access private
          */
          function mosTemplate( &$database ) {
                  $this->mosDBTable( '#__templates', 'id', $database );
-Line 284
+Line 570
  }
  /**
- * Class mosMambot
+ * Mambot database table class
+ *
+ * This class can be used to gain access to #_mambots database table
+ *
+ * Example of use:
+ *
+ * To load editor mambots in a object..
+ *
+ * <code>
+ * $row = new mosMambot();
+ * $query = "SELECT * FROM #_mambots WHERE folder = 'editors'";
+ * $database =& mamboDatabase::getInstance();
+ * $database->setQuery( $query );
+ * if ($database->loadObject($row)) {
+ * ...
+ * }
+ * </code>
  * @package Mambo
+ * @access public
  */
  class mosMambot extends mosDBTable {
-         /** @var int */
+     /** @var int table primary key */
          var $id=null;
-         /** @var varchar */
+     /** @var string mambot name */
          var $name=null;
-         /** @var varchar */
+     /** @var string element name */
          var $element=null;
-         /** @var varchar */
+     /** @var string mambot kind  */
          var $folder=null;
-         /** @var tinyint unsigned */
+     /** @var int access level 0 public, 1 registered, 2 special */
          var $access=null;
-         /** @var int */
+     /** @var int order lower first*/
          var $ordering=null;
-         /** @var tinyint */
+     /** @var int 1 published, 0 unpublished */
          var $published=null;
-         /** @var tinyint */
+     /** @var int 1 core mambots ,0 others */
          var $iscore=null;
-         /** @var tinyint */
+     /** @var int 1 admin mambot, 0 user mambot*/
          var $client_id=null;
-         /** @var int unsigned */
+     /** @var int id from the user that checkout, 0 checkin */
          var $checked_out=null;
-         /** @var datetime */
+     /** @var datetime date and time from checkout*/
          var $checked_out_time=null;
-         /** @var text */
+     /** @var string mambot parameters */
          var $params=null;
+     /**
+     * mosMambot Class contructor
+     *
+     * Init a mosDBTable object.
+     *
+     * @param object &$db reference to current database object
+     * @access private
+     */
          function mosMambot( &$db ) {
                  $this->mosDBTable( '#__mambots', 'id', $db );
          }
  }
+ /**
+ * Singleton class to handle with modules
+ *
+ * This class loads, counts and caches modules for both sides, user and admin
+ *
+ * @package Mambo
+ * @acces public
+ */
  class mosModuleHandler {
+     /**
+     * @var object current database object
+     * @access private
+     */
          var $_db = null;
+     /**
+     * @var object modules cached
+     * @access private
+     */
          var $_modules = null;
+     /**
+     * @var array unpublished modules
+     * @access private
+     */
          var $_unpublished = null;
+     /**
+     * @var bool TRUE when admin modules are loaded
+     * @access private
+     */
          var $_isAdmin = null;
+     /**
+     * mosModuleHandler Class contructor
+     *
+     * Init the database object.
+     *
+     * @access private
+     */
          function mosModuleHandler () {
                  $this->_db =& mamboDatabase::getInstance();
          }
+     /**
+     * Returns a reference to current handler
+     *
+     * This function returns a reference to current modules handler, if none handler exists,
+     * it creates one.
+     *
+     * Example of use:
+     *
+     * <code>$m_handler =& mosModuleHandler::getInstance();</code>
+     *
+     * @acces public
+     * @return object reference to current singleton Handler
+     */
          function &getInstance () {
                  static $instance;
                  if (!is_object($instance)) $instance = new mosModuleHandler();
-Line 335
+Line 690
          }
          /**
-         * Cache some modules information
+     * Caches some modules information
-         * @return array
+     *
+     * This function cache all modules, a $isAdmin bool value can be passed to select
+     * the side (user/admin) by default user modules are loaded.
+     *
+     * @access private
+     * @param bool $isAdmin TRUE when admin modules will loaded
          */
          function initModules($isAdmin=false) {
                  if (!isset($this->_modules) OR $isAdmin != $this->_isAdmin) {
-Line 367
+Line 727
                  }
          }
          /**
-         * @param string THe template position
+     * Returns the number of modules in a specified position, this method is called by
+     * mosCountModules global function
+     *
+     * Example of use.
+     *
+     * to count all modules in top position
+     *
+     * <code>
+     * $handler =& mosModuleHandler::getInstance();
+     * $quan = $handler->mosCountModules('top');
+     * </code>
+     *
+     * @access public
+     * @param string The template position
+     * @param bool $isAdmin TRUE when admin modules will loaded
          */
          function mosCountModules( $position='left', $isAdmin=false ) {
                  $this->initModules($isAdmin);
-Line 375
+Line 749
          }
          /**
+     * Returns a array with modules that match whit $name, when $unpublished is TRUE
+     * unpublished modules are returned too.
+     *
+     * Example of use:
+     *
+     * To get all modules included unpublished called 'mod_mainmenu' you can..
+     *
+     * <code>
+     * $modulehandler =& mosModuleHandler::getInstance();
+     * $modMenus =& $modulehandler->getByName('mod_mainmenu', false, true);
+     * </code>
+     *
+     * @access public
          * @param string Name of module required
+     * @param bool $isAdmin TRUE when admin modules will loaded
+     * @param bool $unpublished TRUE whish to include unpublished modules too
+     * @return array array with all modules that match
          */
          function &getByName( $name, $isAdmin=false, $unpublished=false ) {
                  $this->initModules($isAdmin);
-Line 388
+Line 778
          }
          /**
-         * @param string The position
+     * Loads all published modules from a specified position, a $style can be passed
-         * @param int The style.  0=normal, 1=horiz, -1=no wrapper
+     * to change the style of output
+     *
+     * @param string $position The position
+     * @param int $style The style.  0=normal(default), 1=horiz, -1=no wrapper
+     * @param bool $isAdmin TRUE when admin modules will loaded
          */
          function mosLoadModules( $position='left', $style=0, $isAdmin=false ) {
                  $Itemid = mamboCore::get('Itemid');
-Line 432
+Line 826
          }
          /**
-         * Loads admin modules via module position
+     * Loads admin modules from a specified position,a $style can be passed
-         * @param string The position
+     * to change the style of output
-         * @param int 0 = no style, 1 = tabbed
+     *
+     * @param string $position The position
+     * @param int $style 0 = no style(default), 1 = tabbed, 2 = use div
          */
          function mosLoadAdminModules( $position='left', $style=0 ) {
                  global $my, $acl;
-Line 488
+Line 884
  }
  /**
- * Module database table class
+ * 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>
  * @package Mambo
+ * @access public
  */
  class mosModule extends mosDBTable {
          /** @var int Primary key */
          var $id=null;
-         /** @var string */
+     /** @var string module title */
          var $title=null;
-         /** @var string */
+     /** @var bool TRUE show title, FALSE hide title*/
          var $showtitle=null;
-         /** @var int */
+     /** @var string content to custom modules*/
          var $content=null;
-         /** @var int */
+     /** @var int order lower first*/
          var $ordering=null;
-         /** @var string */
+     /** @var string template position*/
          var $position=null;
-         /** @var boolean */
+     /** @var int id from the user that checkout, 0 checkin */
          var $checked_out=null;
-         /** @var time */
+     /** @var int date and time from checkout */
          var $checked_out_time=null;
-         /** @var boolean */
+     /** @var bool TRUE published, FALSE unpublished*/
          var $published=null;
-         /** @var string */
+     /** @var string module name*/
          var $module=null;
-         /** @var int */
+     /** @var int num of news from newsfeed modules*/
          var $numnews=null;
-         /** @var int */
+     /** @var int access level 0 public, 1 registered, 2 special */
          var $access=null;
-         /** @var string */
+     /** @var string module parameters*/
          var $params=null;
-         /** @var string */
+     /** @var int 1 core mambots ,0 others */
          var $iscore=null;
-         /** @var string */
+     /** @var int 1 admin module, 0 user module*/
          var $client_id=null;
          /**
-         * @param database A database connector object
+     * mosModule Class contructor
+     *
+     * Init a mosDBTable object.
+     *
+     * @param object &$db reference to current database object
+     * @access private
          */
          function mosModule( &$db ) {
                  $this->mosDBTable( '#__modules', 'id', $db );
          }
-         // overloaded check function
+     /**
+     * overloaded check function
+     *
+     * @access private
+     */
          function check() {
                  // check for valid name
                  if (trim( $this->title ) == '') {

 Legend:



Removed from v.814
 


changed lines


 
Added in v.815
 Legend:



Removed from v.814
 


changed lines


 
Added in v.815
-Removed from v.814
+Added in v.815

	ViewVC Help
Powered by ViewVC 1.0.0

Web Hosting provided by Network Redux.

MyGforge Home

Mambo CMS

Diff of /mambo/branches/4.6/includes/cmtclasses.php