„LnxUser::modifyGroup” változatai közötti eltérés

Innen: IT documentation
 
9. sor: 9. sor:
== Parameters ==
== Parameters ==


; <code>group</code>
; group
: Associative array what contains the group's parameters what needs to be modified.   
: Associative array what contains the group's parameters what needs to be modified.   
: The structure of the array:
: The structure of the array:
: [
: [
:;<code>'name'</code> => string
:;'name' => string
:: Mantandory! Name of linux group.
:: Mantandory! Name of linux group.
:;<code>'rename'</code> => string
:;'rename' => string
:: Optional. New name of the linux group.
:: Optional. New name of the linux group.
:;<code>'gid'</code> => int
:;'gid' => int
:: Optional. Group ID of linux group. The ID must not exist!
:: Optional. Group ID of linux group. The ID must not exist!
:;<code>'nonunique'</code> => bool
:;'nonunique' => bool
:: Optional. If '''<code>true</code>''' allow to create groups with duplicate (non-unique) Group ID  
:: Optional. If '''true''' allow to create groups with duplicate (non-unique) Group ID  
:: ]
: ]


== Return Values ==
== Return Values ==

A lap jelenlegi, 2021. szeptember 19., 16:05-kori változata

Description

Object-oriented style

public lnxUser::modifyGroup ( array $group ): bool

Procedural style

lnxModifyGroup ( array $group ): bool

Modify a linux group with group parameters

Parameters

group
Associative array what contains the group's parameters what needs to be modified.
The structure of the array:
[
'name' => string
Mantandory! Name of linux group.
'rename' => string
Optional. New name of the linux group.
'gid' => int
Optional. Group ID of linux group. The ID must not exist!
'nonunique' => bool
Optional. If true allow to create groups with duplicate (non-unique) Group ID
]

Return Values

Returns true if group is modified, false otherwise.

Changelog

Version
(lnxUser)
Description
1.00 available

Examples

$group	= 'testGroup';

# Modify linux group

if ( ! lnxModifyGroup ( [

	'name'			=> $group,				// Mantandory! Name of linux group.
	//'rename'		=> 'RenamedTestGroup',	// Optional. New name of the linux group.
	'gid'			=> 1200,				// Optional. Group ID of linux group. The ID must not exist!
	//'nonunique'	=> true,				// Optional. If true allow to create groups with duplicate (non-unique) Group ID
	
	] ) )
	
	print( "Something went wrong during Modify group!" . PHP_EOL );

else
	
	print( "'$group' group is modified." . PHP_EOL );