AdminGroup Class Reference

Admin_Group Module group library. More...

Public Member Functions
	__construct ($name='', $parent=null)
	get ()
	initialise ()
	get_fromDatabase ()
	save ()
	delete_fromDatabase ()
	get_usersFromDatabase ()
	update_usersToDatabase ()
	install ()
	is_installed ()
	get_fromHeader ($prefix='')
	get_fromArray ($data)
	check_data ()
	exists_group ($name)
	is_userInGroup ($user)
	get_objectList ()
	static_getNameList ()
	static_getAdminList ()

Public Attributes
	$name
	Group symbolic name. More...
	$title
	Group title. More...
	$description
	Group description. More...
	$is_new
	Is group new. More...
	$users
	Group users as list. More...
	$users_
	Group users as string. More...
	$_libError = ''
	Object last error. More...
	$_libDesc = 'Module: Admin_Group Lib: AdminGroup'
	Object description. More...
	$_libIsInstalled = null
	Is group object installed. More...

Private Member Functions
	create_toDatabase ()
	update_toDatabase ()

Private Attributes
	$_libParent = null
	Link to parent module. More...

Detailed Description

Admin_Group Module group library.

Plugin / Module Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1.1

Date

Creation: Mar 2007

Modification: Feb 2021

Copyright

2007 - 2021 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Remarks

Contains 2 default groups : all / none

Constructor & Destructor Documentation

__construct()

AdminGroup::__construct	(		$name = '',
			$parent = null
	)

Class constructor.

Parameters

string	$name
Object	$parent

Returns

void

Member Function Documentation

get()

AdminGroup::get

(

)

Load object.

Returns

boolean success

initialise()

AdminGroup::initialise

(

)

Initialise new object.

Returns

boolean success

get_fromDatabase()

AdminGroup::get_fromDatabase

(

)

Load object from database

Returns

boolean success

save()

AdminGroup::save

(

)

Save object

Returns

boolean success

create_toDatabase()

AdminGroup::create_toDatabase ( )

private

Create new object to database

Returns

boolean success

update_toDatabase()

AdminGroup::update_toDatabase ( )

private

Update object to database

Returns

boolean success

delete_fromDatabase()

AdminGroup::delete_fromDatabase

(

)

Delete object from database

Returns

boolean success

get_usersFromDatabase()

AdminGroup::get_usersFromDatabase

(

)

Load user list from database.

Returns

boolean success

update_usersToDatabase()

AdminGroup::update_usersToDatabase

(

)

Update user list to database.

Returns

boolean success

install()

AdminGroup::install

(

)

Install admingroup table in database

Returns

boolean success

is_installed()

AdminGroup::is_installed

(

)

Check is object is installed.

Returns

boolean success

get_fromHeader()

AdminGroup::get_fromHeader

(

$prefix = ''

)

Load object data from header.

Parameters

string

$prefix

Returns

void

get_fromArray()

AdminGroup::get_fromArray

(

$data

)

Load object data from array

Parameters

array

$data

check_data()

AdminGroup::check_data

(

)

Check object data.

Returns

boolean result

exists_group()

AdminGroup::exists_group

(

$name

)

Check if object name already exists.

Parameters

string

$name

Returns

boolean result

is_userInGroup()

AdminGroup::is_userInGroup

(

$user

)

Check if user is in object.

Parameters

string

$user

Returns

boolean result

get_objectList()

AdminGroup::get_objectList

(

)

Return object list.

Returns

array

static_getNameList()

AdminGroup::static_getNameList

(

)

Return object name list

Returns

$array

static_getAdminList()

AdminGroup::static_getAdminList

(

)

Return object list in admin mode

Returns

$array

Member Data Documentation

$name

AdminGroup::$name

Group symbolic name.

var string $name

$title

AdminGroup::$title

Group title.

var string $title

$description

AdminGroup::$description

Group description.

var string $description

$is_new

AdminGroup::$is_new

Is group new.

var boolean $is_new

$users

AdminGroup::$users

Group users as list.

var array $users

$users_

AdminGroup::$users_

Group users as string.

var string $users_

$_libError

AdminGroup::$_libError = ''

Object last error.

var string $_libError

$_libDesc

AdminGroup::$_libDesc = 'Module: Admin_Group Lib: AdminGroup'

Object description.

var string $_libDesc

$_libIsInstalled

AdminGroup::$_libIsInstalled = null

Is group object installed.

var boolean $_libIsInstalled

$_libParent

AdminGroup::$_libParent = null

private

Link to parent module.

var Object $_libParent

---

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

• CaMykS/plugin/module/Admin_Group/lib/AdminGroup.php.inc