{
    "mode": "perldoc",
    "parameter": "User::Identity::Collection::Users",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/User%3A%3AIdentity%3A%3ACollection%3A%3AUsers/json",
    "generated": "2026-06-13T07:17:27Z",
    "synopsis": "",
    "sections": {
        "NAME": {
            "content": "User::Identity::Collection::Users - a collection of users\n",
            "subsections": []
        },
        "INHERITANCE": {
            "content": "User::Identity::Collection::Users\nis a User::Identity::Collection\nis a User::Identity::Item\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "The User::Identity::Collection::Users object maintains a set User::Identity objects, each\ndescribing a user.\n\nExtends \"DESCRIPTION\" in User::Identity::Collection.\n",
            "subsections": []
        },
        "OVERLOADED": {
            "content": "Extends \"OVERLOADED\" in User::Identity::Collection.\n\noverload: @{}\nInherited, see \"OVERLOADED\" in User::Identity::Collection\n\noverload: stringification\nInherited, see \"OVERLOADED\" in User::Identity::Collection\n",
            "subsections": []
        },
        "METHODS": {
            "content": "Extends \"METHODS\" in User::Identity::Collection.\n",
            "subsections": [
                {
                    "name": "Constructors",
                    "content": "Extends \"Constructors\" in User::Identity::Collection.\n\nUser::Identity::Collection::Users->new( [$name], %options )\n-Option     --Defined in                --Default\ndescription  User::Identity::Item        undef\nitemtype    User::Identity::Collection  User::Identity\nname         User::Identity::Item        'people'\nparent       User::Identity::Item        undef\nroles        User::Identity::Collection  undef\n\ndescription => STRING\nitemtype => CLASS\nname => STRING\nparent => OBJECT\nroles => ROLE|ARRAY\n"
                },
                {
                    "name": "Attributes",
                    "content": "Extends \"Attributes\" in User::Identity::Collection.\n\n$obj->description()\nInherited, see \"Attributes\" in User::Identity::Item\n\n$obj->itemType()\nInherited, see \"Attributes\" in User::Identity::Collection\n\n$obj->name( [$newname] )\nInherited, see \"Attributes\" in User::Identity::Item\n\n$obj->roles()\nInherited, see \"Attributes\" in User::Identity::Collection\n"
                },
                {
                    "name": "Collections",
                    "content": "Extends \"Collections\" in User::Identity::Collection.\n\n$obj->add($collection, $role)\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->addCollection( $object | <[$type], %options> )\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->collection($name)\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->parent( [$parent] )\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->removeCollection($object|$name)\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->type()\nUser::Identity::Collection::Users->type()\nInherited, see \"Collections\" in User::Identity::Item\n\n$obj->user()\nInherited, see \"Collections\" in User::Identity::Item\n"
                },
                {
                    "name": "Maintaining roles",
                    "content": "Extends \"Maintaining roles\" in User::Identity::Collection.\n\n$obj->addRole($role| <[$name],%options> | ARRAY)\nInherited, see \"Maintaining roles\" in User::Identity::Collection\n\n$obj->removeRole($role|$name)\nInherited, see \"Maintaining roles\" in User::Identity::Collection\n\n$obj->renameRole( <$role|$oldname>, $newname )\nInherited, see \"Maintaining roles\" in User::Identity::Collection\n\n$obj->sorted()\nInherited, see \"Maintaining roles\" in User::Identity::Collection\n"
                },
                {
                    "name": "Searching",
                    "content": "Extends \"Searching\" in User::Identity::Collection.\n\n$obj->find($name|CODE|undef)\nInherited, see \"Searching\" in User::Identity::Collection\n"
                }
            ]
        },
        "DIAGNOSTICS": {
            "content": "Error: $object is not a collection.\nThe first argument is an object, but not of a class which extends\nUser::Identity::Collection.\n\nError: Cannot create a $type to add this to my collection.\nSome options are specified to create a $type object, which is native to this collection.\nHowever, for some reason this failed.\n\nError: Cannot load collection module for $type ($class).\nEither the specified $type does not exist, or that module named $class returns compilation\nerrors. If the type as specified in the warning is not the name of a package, you specified\na nickname which was not defined. Maybe you forgot the 'require' the package which defines\nthe nickname.\n\nError: Cannot rename $name into $newname: already exists\nError: Cannot rename $name into $newname: doesn't exist\nError: Creation of a collection via $class failed.\nThe $class did compile, but it was not possible to create an object of that class using the\noptions you specified.\n\nError: Don't know what type of collection you want to add.\nIf you add a collection, it must either by a collection object or a list of options which\ncan be used to create a collection object. In the latter case, the type of collection must\nbe specified.\n\nWarning: No collection $name\nThe collection with $name does not exist and can not be created.\n\nError: Wrong type of role for $collection: requires a $expect but got a $type\nEach $collection groups sets of roles of one specific type ($expect). You cannot add objects\nof a different $type.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "This module is part of User-Identity distribution version 1.01, built on February 11, 2022.\nWebsite: http://perl.overmeer.net/CPAN/\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "Copyrights 2003-2022 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself. See http://dev.perl.org/licenses/\n",
            "subsections": []
        }
    },
    "summary": "User::Identity::Collection::Users - a collection of users",
    "flags": [],
    "examples": [],
    "see_also": []
}