Documentation

GroupMembership
in package
implements ActionInterface uses ActionTrait

Allows a user to choose, or at least request, group memberships.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$change_type  : string
$obj  : static

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
execute()  : void
Dispatcher to whichever method is necessary.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
load()  : static
Static wrapper for constructor.
save()  : void
Saves the changes.
show()  : void
Shows the UI.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().
canEditPrimary()  : bool
Figures out whether the current user can change the primary membergroup of the member whose profile is being viewed.
loadCurrentAndAssignableGroups()  : void
Loads an array of information about groups the user is in and any they can join
sendJoinRequest()  : void
Handles submitting a user's request to join a group

Properties

$change_type

public string $change_type

The type of change that was made when saving.

$obj

protected static static $obj

An instance of this class. This is used by the load() method to prevent multiple instantiations.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

execute()

Dispatcher to whichever method is necessary.

public execute() : void

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed

canEditPrimary()

Figures out whether the current user can change the primary membergroup of the member whose profile is being viewed.

protected canEditPrimary([int|null $new_group_id = null ]) : bool
Parameters
$new_group_id : int|null = null
Return values
bool

loadCurrentAndAssignableGroups()

Loads an array of information about groups the user is in and any they can join

protected loadCurrentAndAssignableGroups() : void

sendJoinRequest()

Handles submitting a user's request to join a group

protected sendJoinRequest(int $new_group_id) : void
Parameters
$new_group_id : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results