Documentation

GroupMembership
in package
implements ActionInterface Uses BackwardCompatibility

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  : object
$backcompat  : array<string|int, mixed>

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
execute()  : void
Dispatcher to whichever method is necessary.
exportStatic()  : void
Provides a way to export a class's public static properties and methods to global namespace.
groupMembership2()  : string
Backward compatibility wrapper for the save method.
load()  : object
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
sendJoinRequest()  : void

Properties

$change_type

public string $change_type

The type of change that was made when saving.

$obj

protected static object $obj

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

$backcompat

private static array<string|int, mixed> $backcompat = ['func_names' => ['call' => 'groupMembership', 'groupMembership2' => 'groupMembership2']]

BackwardCompatibility settings for this class.

Methods

call()

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

public static call() : void

execute()

Dispatcher to whichever method is necessary.

public execute() : void

exportStatic()

Provides a way to export a class's public static properties and methods to global namespace.

public static exportStatic() : void

To do so:

  1. Use this trait in the class.
  2. At the END of the class's file, call its exportStatic() method.

Although it might not seem that way at first glance, this approach conforms to section 2.3 of PSR 1, since executing this method is simply a dynamic means of declaring functions when the file is included; it has no other side effects.

Regarding the $backcompat items:

A class's static properties are not exported to global variables unless explicitly included in $backcompat['prop_names']. Likewise, a class's static methods are not exported as global functions unless explicitly included in $backcompat['func_names'].

$backcompat['prop_names'] is a simple array where the keys are the names of one or more of a class's static properties, and the values are the names of global variables. In each case, the global variable will be set to a reference to the static property. Static properties that are not named in this array will not be exported.

$backcompat['func_names'] is a simple array where the keys are the names of one or more of a class's static methods, and the values are the names that should be used for global functions that will encapsulate those methods. Methods that are not named in this array will not be exported.

Adding non-static properties or methods to the $backcompat arrays will produce runtime errors. It is the responsibility of the developer to make sure not to do this.

groupMembership2()

Backward compatibility wrapper for the save method.

public static groupMembership2(int $memID) : string
Parameters
$memID : int

The ID of the user.

Return values
string —

The type of change that was made.

load()

Static wrapper for constructor.

public static load() : object
Return values
object —

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()

protected loadCurrentAndAssignableGroups() : void

sendJoinRequest()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results