| 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 | |
| createLabels ( $labels ) : the | Creates new {@link Label} objects. | |
| get ( $serviceSelector ) : The | This field is required and should not be {@code null}. | |
| getLabelsByStatement ( $filterStatement ) : the | Gets a {@link LabelPage} of {@link Label} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering: | |
| mutate ( $operations ) : The | This field must not contain {@code null} elements. Elements in this field must have distinct IDs for following {@link Operator}s : ADD, SET, REMOVE. This field must contain at least one element. This field is required and should not be {@code null}. The following {@link Operator}s are supported: ADD, SET, REMOVE. | |
| performLabelAction ( $labelAction, $filterStatement ) : the | Performs actions on {@link Label} objects that match the given {@link Statement#query}. | |
| query ( $query ) | This field is required and should not be {@code null}. | |
| updateLabels ( $labels ) : the | Updates the specified {@link Label} objects. |
| public __construct ( string $wsdl, array $options, $user ) | ||
| $wsdl | string | WSDL location for this service |
| $options | array | Options for the SoapClient |
| public createLabels ( $labels ) : the | ||
| return | the | created labels with their IDs filled in |
| public get ( $serviceSelector ) : The | ||
| return | The | page containing the {@link Label}s which meet the criteria specified by the selector. |
| PQL Property | Object Property |
|---|---|
| {@code id} | {@link Label#id} |
| {@code type} | {@link Label#type} |
| {@code name} | {@link Label#name} |
| {@code description} | {@link Label#description} |
| {@code isActive} | {@link Label#isActive} |
| public getLabelsByStatement ( $filterStatement ) : the | ||
| return | the | labels that match the given filter |
| public mutate ( $operations ) : The | ||
| return | The | applied {@link Label}s. |
| public performLabelAction ( $labelAction, $filterStatement ) : the | ||
| return | the | result of the action performed |
| public query ( $query ) |
| public updateLabels ( $labels ) : the | ||
| return | the | updated labels |
| public static array $classmap | ||
| return | array | |
| public static string $endpoint | ||
| return | string | |