From beb6db8d31fdd4aa39fab3662a346c648d989ade Mon Sep 17 00:00:00 2001
From: abraar <abraar@colosa.com>
Date: Thu, 27 Jan 2011 15:31:33 +0000
Subject: [PATCH] Changes done for PhpDoc

---
 .../classes/model/AuthenticationSource.php    | 26 +++++++++++++------
 .../model/AuthenticationSourcePeer.php        | 24 ++++++++++-------
 rbac/engine/classes/model/Permissions.php     | 12 ++++++++-
 rbac/engine/classes/model/PermissionsPeer.php |  4 +++
 rbac/engine/classes/model/RbacUsers.php       | 12 ++++++---
 rbac/engine/classes/model/RbacUsersPeer.php   |  8 ++++--
 rbac/engine/classes/model/Roles.php           | 16 +++++++++---
 rbac/engine/classes/model/RolesPeer.php       |  9 ++++---
 .../engine/classes/model/RolesPermissions.php |  8 ++++--
 .../classes/model/RolesPermissionsPeer.php    |  9 ++++---
 rbac/engine/classes/model/Systems.php         | 15 +++++++----
 rbac/engine/classes/model/SystemsPeer.php     |  7 +++--
 rbac/engine/classes/model/UsersRoles.php      | 10 ++++++-
 rbac/engine/classes/model/UsersRolesPeer.php  |  9 ++++---
 14 files changed, 122 insertions(+), 47 deletions(-)

diff --git a/rbac/engine/classes/model/AuthenticationSource.php b/rbac/engine/classes/model/AuthenticationSource.php
index 1d29c8b45..effa0a60d 100644
--- a/rbac/engine/classes/model/AuthenticationSource.php
+++ b/rbac/engine/classes/model/AuthenticationSource.php
@@ -1,19 +1,25 @@
 <?php
-
-require_once 'classes/model/om/BaseAuthenticationSource.php';
-
-
 /**
+ *  AuthenticationSource.php
+ *  @package  rbac-classes-model
  * Skeleton subclass for representing a row from the 'AUTHENTICATION_SOURCE' table.
  *
  *
- *
  * You should add additional methods to this class to meet the
  * application requirements.  This class will only be generated as
  * long as it does not already exist in the output directory.
- *
- * @package  rbac-classes-model
+ * 
  */
+
+ /**
+  * access public
+  */
+require_once 'classes/model/om/BaseAuthenticationSource.php';
+
+ /**
+  * @package  rbac-classes-model
+  */
+
 class AuthenticationSource extends BaseAuthenticationSource {
   function getAllAuthSources() {
     $oCriteria = new Criteria('rbac');
@@ -21,7 +27,7 @@ class AuthenticationSource extends BaseAuthenticationSource {
     $oCriteria->add(AuthenticationSourcePeer::AUTH_SOURCE_UID, '', Criteria::NOT_EQUAL);
     return $oCriteria;
   }
-
+  
   public function load($sUID) {
   	try {
   	  $oAuthenticationSource = AuthenticationSourcePeer::retrieveByPK($sUID);
@@ -107,6 +113,10 @@ class AuthenticationSource extends BaseAuthenticationSource {
     }
   }
 
+  /**
+   * Function remove
+   * access public
+   */
   function remove($sUID) {
     $oConnection = Propel::getConnection(AuthenticationSourcePeer::DATABASE_NAME);
   	try {
diff --git a/rbac/engine/classes/model/AuthenticationSourcePeer.php b/rbac/engine/classes/model/AuthenticationSourcePeer.php
index c8dc910fb..c5ba749a0 100644
--- a/rbac/engine/classes/model/AuthenticationSourcePeer.php
+++ b/rbac/engine/classes/model/AuthenticationSourcePeer.php
@@ -1,13 +1,7 @@
 <?php
-
-  // include base peer class
-  require_once 'classes/model/om/BaseAuthenticationSourcePeer.php';
-
-  // include object class
-  include_once 'classes/model/AuthenticationSource.php';
-
-
 /**
+ * AuthenticationSourcePeer.php
+ * @package  rbac-classes-model *
  * Skeleton subclass for performing query and update operations on the 'AUTHENTICATION_SOURCE' table.
  *
  * 
@@ -16,8 +10,20 @@
  * application requirements.  This class will only be generated as
  * long as it does not already exist in the output directory.
  *
- * @package  rbac-classes-model
  */
+
+ /**
+ * @access public
+ */
+  // include base peer class
+  require_once 'classes/model/om/BaseAuthenticationSourcePeer.php';
+
+  // include object class
+  include_once 'classes/model/AuthenticationSource.php';
+
+  /**
+   * @package  rbac-classes-model
+  */
 class AuthenticationSourcePeer extends BaseAuthenticationSourcePeer {
 
 } // AuthenticationSourcePeer
diff --git a/rbac/engine/classes/model/Permissions.php b/rbac/engine/classes/model/Permissions.php
index ba7f2db42..ab0b79f0c 100644
--- a/rbac/engine/classes/model/Permissions.php
+++ b/rbac/engine/classes/model/Permissions.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * Permissions.php
+ * @package  rbac-classes-model
  *
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,6 +24,9 @@
  *
  */
 
+  /**
+  * @access public
+  */
 require_once 'classes/model/om/BasePermissions.php';
 
 
@@ -38,6 +42,12 @@ require_once 'classes/model/om/BasePermissions.php';
  * @package  rbac-classes-model
  */
 class Permissions extends BasePermissions {
+    
+    /**
+     * Function loadByCode
+     * access public
+     */
+
   function loadByCode($sCode = '') {
     try {
       $oCriteria = new Criteria('rbac');
diff --git a/rbac/engine/classes/model/PermissionsPeer.php b/rbac/engine/classes/model/PermissionsPeer.php
index 0457b8148..cf073908c 100644
--- a/rbac/engine/classes/model/PermissionsPeer.php
+++ b/rbac/engine/classes/model/PermissionsPeer.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * PermissionsPeer.php
+ * @package  rbac-classes-model
  *  
  * ProcessMaker Open Source Edition
  * Copyright (C) 2004 - 2008 Colosa Inc.23
@@ -23,6 +24,9 @@
  * 
  */
 
+  /**
+  * @access public
+  */
   // include base peer class
   require_once 'classes/model/om/BasePermissionsPeer.php';
 
diff --git a/rbac/engine/classes/model/RbacUsers.php b/rbac/engine/classes/model/RbacUsers.php
index b1c82fb97..b06e83b8a 100644
--- a/rbac/engine/classes/model/RbacUsers.php
+++ b/rbac/engine/classes/model/RbacUsers.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * RbacUsers.php
+ * @package  rbac-classes-model
  *
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,7 +23,9 @@
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
  *
  */
-
+  /**
+  * @access public
+  */
 require_once 'classes/model/om/BaseRbacUsers.php';
 
 
@@ -44,8 +47,9 @@ class RbacUsers extends BaseRbacUsers {
    * verifica que un usuario tiene derechos de iniciar una aplicacion
    *
    * @author Fernando Ontiveros Lira <fernando@colosa.com>
-   * @access public
-
+   * access public
+   * Function verifyLogin
+   *
    * @param  string $strUser    UserId  (login) de usuario
    * @param  string $strPass    Password
    * @return
diff --git a/rbac/engine/classes/model/RbacUsersPeer.php b/rbac/engine/classes/model/RbacUsersPeer.php
index 99bc7a48f..26d98b455 100644
--- a/rbac/engine/classes/model/RbacUsersPeer.php
+++ b/rbac/engine/classes/model/RbacUsersPeer.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * RbacUsersPeer.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,6 +24,9 @@
  * 
  */
 
+  /**
+  * @access public
+  */
   // include base peer class
   require_once 'classes/model/om/BaseRbacUsersPeer.php';
 
diff --git a/rbac/engine/classes/model/Roles.php b/rbac/engine/classes/model/Roles.php
index 01772cec0..26b5d1188 100644
--- a/rbac/engine/classes/model/Roles.php
+++ b/rbac/engine/classes/model/Roles.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * Roles.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,7 +23,9 @@
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
  * 
  */
-
+ /**
+  * @access public
+  */
 require_once 'classes/model/Permissions.php';
 require_once 'classes/model/Systems.php';
 require_once 'classes/model/RolesPermissions.php';
@@ -47,7 +50,12 @@ require_once 'classes/model/Content.php';
 class Roles extends BaseRoles {
     
     public $rol_name;
-    
+
+   /**
+    * Function load
+    * access public
+   */
+
     public function load($Uid) {
         try {
             $oRow = RolesPeer::retrieveByPK($Uid);
diff --git a/rbac/engine/classes/model/RolesPeer.php b/rbac/engine/classes/model/RolesPeer.php
index 9982b6624..6a375f0d6 100644
--- a/rbac/engine/classes/model/RolesPeer.php
+++ b/rbac/engine/classes/model/RolesPeer.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * RolesPeer.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,7 +23,9 @@
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
  * 
  */
-
+  /**
+  * @access public
+  */
   // include base peer class
   require_once 'classes/model/om/BaseRolesPeer.php';
 
diff --git a/rbac/engine/classes/model/RolesPermissions.php b/rbac/engine/classes/model/RolesPermissions.php
index c3fbed3c3..cec3f31f7 100644
--- a/rbac/engine/classes/model/RolesPermissions.php
+++ b/rbac/engine/classes/model/RolesPermissions.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * RolesPermissions.php
- *
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,6 +24,9 @@
  *
  */
 
+  /**
+  * @access public
+  */
 require_once 'classes/model/om/BaseRolesPermissions.php';
 
 
diff --git a/rbac/engine/classes/model/RolesPermissionsPeer.php b/rbac/engine/classes/model/RolesPermissionsPeer.php
index bdf2d7d0f..469adec48 100644
--- a/rbac/engine/classes/model/RolesPermissionsPeer.php
+++ b/rbac/engine/classes/model/RolesPermissionsPeer.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * RolesPermissionsPeer.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,7 +24,9 @@
  * 
  */
 
-  // include base peer class
+  /**
+  * @access public
+  */
   require_once 'classes/model/om/BaseRolesPermissionsPeer.php';
 
   // include object class
diff --git a/rbac/engine/classes/model/Systems.php b/rbac/engine/classes/model/Systems.php
index aaf99cea5..0c8d6297a 100644
--- a/rbac/engine/classes/model/Systems.php
+++ b/rbac/engine/classes/model/Systems.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * Systems.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,7 +23,9 @@
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
  * 
  */
-
+  /**
+  * @access public
+  */
 require_once 'classes/model/om/BaseSystems.php';
 
 
@@ -42,8 +45,10 @@ class Systems extends BaseSystems {
   /**
    * Load the Application row specified in [app_id] column value.
    * 
-   * @param      string $AppUid   the uid of the application 
-   * @return     array  $Fields   the fields 
+   * param      string $AppUid   the uid of the application 
+   * return     array  $Fields   the fields
+   * Function Load
+   * access public
    */
   
   function Load ( $SysUid ) {
diff --git a/rbac/engine/classes/model/SystemsPeer.php b/rbac/engine/classes/model/SystemsPeer.php
index 5648052af..97dfdbcfc 100644
--- a/rbac/engine/classes/model/SystemsPeer.php
+++ b/rbac/engine/classes/model/SystemsPeer.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * SystemsPeer.php
+ * @package  rbac-classes-model
  *  
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,7 +24,9 @@
  * 
  */
 
-  // include base peer class
+  /**
+  * @access public
+  */
   require_once 'classes/model/om/BaseSystemsPeer.php';
 
   // include object class
diff --git a/rbac/engine/classes/model/UsersRoles.php b/rbac/engine/classes/model/UsersRoles.php
index bad5fafac..1de8acd48 100644
--- a/rbac/engine/classes/model/UsersRoles.php
+++ b/rbac/engine/classes/model/UsersRoles.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * UsersRoles.php
+ * @package  rbac-classes-model
  *  
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -23,6 +24,9 @@
  * 
  */
 
+  /**
+  * @access public
+  */
 require_once 'classes/model/om/BaseUsersRoles.php';
 
 
@@ -39,6 +43,10 @@ require_once 'classes/model/om/BaseUsersRoles.php';
  */
 class UsersRoles extends BaseUsersRoles {
 
+   /**
+   * Function getRolesBySystem
+   * access public
+   */
   function getRolesBySystem ( $SysUid, $UsrUid ) {
     $con = Propel::getConnection(UsersRolesPeer::DATABASE_NAME);
     try {
diff --git a/rbac/engine/classes/model/UsersRolesPeer.php b/rbac/engine/classes/model/UsersRolesPeer.php
index 576c17d6c..50086ae93 100644
--- a/rbac/engine/classes/model/UsersRolesPeer.php
+++ b/rbac/engine/classes/model/UsersRolesPeer.php
@@ -1,9 +1,10 @@
 <?php
 /**
  * UsersRolesPeer.php
- *  
+ * @package  rbac-classes-model
+ * 
  * ProcessMaker Open Source Edition
- * Copyright (C) 2004 - 2008 Colosa Inc.23
+ * Copyright (C) 2004 - 2011 Colosa Inc.
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,7 +23,9 @@
  * Coral Gables, FL, 33134, USA, or email info@colosa.com.
  * 
  */
-
+  /**
+  * @access public
+  */
   // include base peer class
   require_once 'classes/model/om/BaseUsersRolesPeer.php';