File_Passwd_Unix::useMap

File_Passwd_Unix::useMap() – Whether to use the 'name map'

Synopsis

boolean File_Passwd_Unix::useMap ( boolean $bool = null )

Description

Whether to use the 'name map' of the extra properties or not.

Default Unix passwd files look like:
user:password:user_id:group_id:gecos:home_dir:shell

The default 'name map' for properties except user and password looks like:

  • uid
  • gid
  • gecos
  • home
  • shell

If you want to change the naming of the standard map use File_Passwd_Unix::setMap().

Parameter

boolean $bool

whether to use the 'name map' or not

Return value

Returns boolean TRUE if you set a value, or the actual value if called without param.

Note

This function can not be called statically.