| Property | Type | Description | |
|---|---|---|---|
| $classmap | array | Default class map for wsdl=>php | |
| $endpoint | string | The endpoint of the service |
| Method | Description | |
|---|---|---|
| __construct ( string $wsdl, array $options, $user ) | Constructor using wsdl location and options array | |
| createUsers ( $users ) : the | Creates new {@link User} objects. | |
| getAllRoles ( ) : the | Returns the {@link Role} objects that are defined for the users of the network. | |
| getCurrentUser ( ) : the | Returns the current {@link User}. | |
| getUsersByStatement ( $filterStatement ) : the | Gets a {@link UserPage} of {@link User} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering: | |
| performUserAction ( $userAction, $filterStatement ) : the | Performs actions on {@link User} objects that match the given {@link Statement#query}. | |
| updateUsers ( $users ) : the | Updates the specified {@link User} objects. |
| public __construct ( string $wsdl, array $options, $user ) | ||
| $wsdl | string | WSDL location for this service |
| $options | array | Options for the SoapClient |
| public createUsers ( $users ) : the | ||
| return | the | created users with their IDs filled in |
| public getAllRoles ( ) : the | ||
| return | the | roles defined for the user's network |
| public getCurrentUser ( ) : the | ||
| return | the | current user |
| PQL Property | Object Property |
|---|---|
| {@code email} | {@link User#email} |
| {@code id} | {@link User#id} |
| {@code name} | {@link User#name} |
| {@code roleId} | {@link User#roleId} |
| {@code rolename} | {@link User#roleName} |
| {@code status} | {@code ACTIVE} if {@link User#isActive} is true; {@code INACTIVE} otherwise |
| public getUsersByStatement ( $filterStatement ) : the | ||
| return | the | users that match the given filter |
| public performUserAction ( $userAction, $filterStatement ) : the | ||
| return | the | result of the action performed |
| public updateUsers ( $users ) : the | ||
| return | the | updated users |
| public static array $classmap | ||
| return | array | |
| public static string $endpoint | ||
| return | string | |
