[geeklog-cvs] Auth_Enterprise/Common AEGroup.class.php,1.1.1.1,1.2
tony at geeklog.net
tony at geeklog.net
Tue Oct 28 20:22:03 EST 2003
Update of /usr/cvs/geeklog/Auth_Enterprise/Common
In directory geeklog_prod:/tmp/cvs-serv2829
Modified Files:
AEGroup.class.php
Log Message:
Added phpdoc comments and set initial values of class properties to null
Index: AEGroup.class.php
===================================================================
RCS file: /usr/cvs/geeklog/Auth_Enterprise/Common/AEGroup.class.php,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** AEGroup.class.php 23 Oct 2003 14:17:34 -0000 1.1.1.1
--- AEGroup.class.php 29 Oct 2003 01:22:00 -0000 1.2
***************
*** 1,161 ****
<?php
!
! /**
! * Auth_Enterprise
! *
! * This source file is subject to version 2.02 of the PHP license,
! * that is bundled with this package in the file LICENSE, and is
! * available at through the world-wide-web at
! * http://www.php.net/license/2_02.txt.
! * If you did not receive a copy of the PHP license and are unable to
! * obtain it through the world-wide-web, please send a note to
! * license at php.net so we can mail you a copy immediately.
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @copyright 2003
! * @version $Id$
! *
! */
!
! /**
! * Generic group class used to pass group data between
! * the A&A Server and A&A client(s)
! *
! * @author Tony Bibbs <tony at tonybibbs.com>
! * @package net.geeklog.auth_enterprise.common
! *
*/
! class AEGroup {
! /**
! * @access private
! */
! var $_groupId = '';
!
! /**
! * @access private
! */
! var $_groupLogicalName = '';
!
! /**
! * @access private
! */
! var $_groupDisplayName = '';
!
! /**
! * @access private
! */
! var $_groupDesc = '';
!
! /**
! * @access private
! */
! var $_privileges = '';
!
! /**
! * Sets the group ID
! *
! * @access public
! * @param integer $id ID for group
! *
! */
! function setGroupId($id)
! {
! $this->_groupId = $id;
! }
!
! /**
! * Retrieves the group ID
! *
! * @access public
! * @return integer ID for group
! *
! */
! function getGroupId()
! {
! return $this->_groupId;
! }
!
! /**
! * Sets the group ID
! *
! * @access public
! * @param string $name ID for group
! *
! */
! function setGroupLogicalName($name)
! {
! $this->_groupLogicalName = $name;
}
!
! /**
! * Retrieves the group's logical name (used mainly in code)
! *
! * @access public
! * @return string logical name for group
! *
! */
! function getGroupLogicalName()
! {
! return $this->_groupLogicalName;
}
!
! /**
! * Sets the group ID
! *
! * @access public
! * @param string $name ID for group
! *
! */
! function setGroupDisplayName($name)
! {
! $this->_groupDisplayName = $name;
}
!
! /**
! * Retrieves the group's Display name (used mainly in code)
! *
! * @access public
! * @return string Display name for group
! *
! */
! function getGroupDisplayName()
! {
! return $this->_groupDisplayName;
}
!
! /**
! * Sets the group description
! *
! * @access public
! * @param string $desc Description for group
! *
! */
! function setGroupDesc($desc)
! {
! $this->_groupDesc = $desc;
}
!
! /**
! * Retrieves the group code
! *
! * @access public
! * @return string Description for group
! *
! */
! function getGroupDesc()
! {
! return $this->_groupDesc;
}
!
! function setGroupPrivileges($privArray)
! {
! $this->_privileges = $privArray;
}
!
! function getGroupPrivileges()
! {
! return $this->_privileges;
}
}
-
?>
--- 1,178 ----
<?php
! /**
! * Auth_Enterprise
! *
! * This source file is subject to version 2.02 of the PHP license,
! * that is bundled with this package in the file LICENSE, and is
! * available at through the world-wide-web at
! * http://www.php.net/license/2_02.txt.
! * If you did not receive a copy of the PHP license and are unable to
! * obtain it through the world-wide-web, please send a note to
! * license at php.net so we can mail you a copy immediately.
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @copyright 2003
! * @version $Id$
! *
*/
! /**
! * Generic group class used to pass group data between
! * the A&A Server and A&A client(s)
! *
! * @author Tony Bibbs <tony at tonybibbs.com>
! * @package net.geeklog.auth_enterprise.common
! *
! */
! class AEGroup {
! /**
! * Group ID
! * @access private
! * @var int
! */
! var $_groupId = null;
! /**
! * Name used to refer to group in code
! * @access private
! * @var string
! */
! var $_groupLogicalName = null;
! /**
! * Name used in displaying the group to the user
! * @access private
* @var string
! */
! var $_groupDisplayName = null;
! /**
! * Description for the group
! * @access private
! * @var string
! */
! var $_groupDesc = null;
! /**
! * Array of privileges group has
! * @access private
! * @var array
! */
! var $_privileges = null;
! /**
! * Sets the group ID
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @param integer $id ID for group
! *
! */
! function setGroupId($id)
! {
! $this->_groupId = $id;
! }
!
! /**
! * Retrieves the group ID
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @return integer ID for group
! *
! */
! function getGroupId()
! {
! return $this->_groupId;
}
! /**
! * Sets the group ID
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @param string $name ID for group
! *
! */
! function setGroupLogicalName($name)
! {
! $this->_groupLogicalName = $name;
}
! /**
! * Retrieves the group's logical name (used mainly in code)
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @return string logical name for group
! *
! */
! function getGroupLogicalName()
! {
! return $this->_groupLogicalName;
}
! /**
! * Sets the group ID
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @param string $name ID for group
! *
! */
! function setGroupDisplayName($name)
! {
! $this->_groupDisplayName = $name;
}
! /**
! * Retrieves the group's Display name (used mainly in code)
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @return string Display name for group
! *
! */
! function getGroupDisplayName()
! {
! return $this->_groupDisplayName;
}
! /**
! * Sets the group description
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @param string $desc Description for group
! *
! */
! function setGroupDesc($desc)
! {
! $this->_groupDesc = $desc;
}
! /**
! * Retrieves the group code
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @return string Description for group
! *
! */
! function getGroupDesc()
! {
! return $this->_groupDesc;
}
! /**
! * Sets the privileges for the group
! *
! * @author Tony Bibbs <tony at geeklog.net>
! * @access public
! * @param array $privArray Array of group privileges
! *
! */
! function setGroupPrivileges($privArray)
! {
! $this->_privileges = $privArray;
}
+ /**
+ * Gets the group privileges
+ *
+ * @author Tony Bibbs <tony at geeklog.net>
+ * @access public
+ * @return array Array of privileges
+ *
+ */
+ function getGroupPrivileges()
+ {
+ return $this->_privileges;
+ }
}
?>
More information about the geeklog-cvs
mailing list