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

Innen: IT documentation
Nincs szerkesztési összefoglaló
9. sor: 9. sor:
== Parameters ==
== Parameters ==


; <code>group</code>
; group
: Associative array what contains the new group's parameters.  Structure of the array: [
: Associative array what contains the new group's parameters.  Structure of the array: [
:; <code>'name'</code> => string
:; 'name' => string
:: Mantandory! Name of linux group.
:: Mantandory! Name of 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>'system'</code> => bool
:; 'system' => bool
:: Optional. If '''<code>true</code>''' create a system group. Group ID will be under 1000. If 'gid' is present this parameter will be ineffective.
:: Optional. If '''true''' create a system group. Group ID will be under 1000. If 'gid' is present this parameter will be ineffective.
:; <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 2021. szeptember 19., 15:53-kori változata

Description

Object-oriented style

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

Procedural style

lnxAddGroup ( array $group ): bool

Create a linux group with group parameters

Parameters

group
Associative array what contains the new group's parameters. Structure of the array: [
'name' => string
Mantandory! Name of linux group.
'gid' => int
Optional. Group ID of linux group. The ID must not exist!
'system' => bool
Optional. If true create a system group. Group ID will be under 1000. If 'gid' is present this parameter will be ineffective.
'nonunique' => bool
Optional. If true allow to create groups with duplicate (non-unique) Group ID ]

Return Values

Returns true if group is created, false otherwise.

Changelog

Version
(lnxUser)
Description
1.00 available

Examples

$group	= 'testGroup';

# Add linux group

if ( ! lnxAddGroup( [
	
	'name'			=> $group,		// Mantandory! Name of linux group.
	//'gid'			=> 1011,		// Optional. Group ID of linux group. The ID must not exist!
	//'system'		=> true,		// Optional. If true create a system group. Group ID will be under 1000. If 'gid' is present this parameter will be ineffective.
	//'nonunique'	=> true,		// Optional. If true allow to create groups with duplicate (non-unique) Group ID

	] ) )
	
	print( "Something went wrong during Add group!" . PHP_EOL );

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