phpcr/src/PHPCR/SimpleCredentials.php
inherited
Classes
Copyright 2008-2011 Karsten Dambekalns karsten@typo3.org
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\PHPCR\SimpleCredentials
- Implements
- \PHPCR\CredentialsInterface
- Api
- Author
- Karsten Dambekalns
Properties
array $attributes = array()array()Details- Type
- array
string $password- Type
- string
string $userID- Type
- string
Methods
__construct(string $userID, string $password) : voidThe constructor creates a new SimpleCredentials object, given a user ID and password.
| Name | Type | Description |
|---|---|---|
| $userID | string | the user ID |
| $password | string | the user's password |
- Api
getAttribute(string $name) : mixedReturns the value of the named attribute, or null if no attribute of the given name exists.
| Name | Type | Description |
|---|---|---|
| $name | string | the name of the attribute |
| Type | Description |
|---|---|
| mixed | the value of the attribute, or null if the attribute does not exist |
- Api
getAttributeNames() : arrayReturns the names of the attributes available to this credentials instance.
This method returns an empty array if the credentials instance has no attributes available to it.
| Type | Description |
|---|---|
| array | a string array containing the names of the stored attributes |
- Api
getPassword() : stringReturns the user password.
| Type | Description |
|---|---|
| string | the password |
- Api
getUserID() : stringReturns the user ID.
| Type | Description |
|---|---|
| string | the user ID. |
- Api
removeAttribute(string $name) : voidRemoves an attribute from this credentials instance.
| Name | Type | Description |
|---|---|---|
| $name | string | the name of the attribute to remove |
- Api
setAttribute(string $name, mixed $value) : voidStores an attribute in this credentials instance.
Note: If no value is passed, the attribute will be removed.
| Name | Type | Description |
|---|---|---|
| $name | string | the name of the attribute |
| $value | mixed | the value to be stored |
- Api