InfoCard/Claims.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_InfoCard
- Version
- $Id: Claims.php 24593 2012-01-05 20:35:02Z matthew $
Package: Zend\InfoCardResult value of the InfoCard component, contains any error messages and claims
from the processing of an information card.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties



string $_defaultNamespace = null
The default namespace to assume in these claims
Default valuenull
Details- Type
- string



bool $_isValid = true
A boolean indicating if the claims should be consider "valid" or not based on processing
Default valuetrue
Details- Type
- bool
Methods



claimExists(string $claimURI) : bool
Indicates if a specific claim URI exists or not within the object
ParametersName | Type | Description |
---|
$claimURI | string | The complete claim URI to check |
---|
ReturnsType | Description |
---|
bool | true if the claim exists, false if not found |



forceValid() : \Zend_InfoCard_Claims
Override for the safeguard which ensures that you don't use claims which failed validation.
Used in situations when there was a validation error you'd like to ignore
Returns


getCardID() : string
Retrieve the PPI (Private Personal Identifier) associated with the information card
ReturnsType | Description |
---|
string | the private personal identifier |



getClaim(string $claimURI) : mixed
Get a claim by providing its complete claim URI
ParametersName | Type | Description |
---|
$claimURI | string | The complete claim URI to retrieve |
---|
ReturnsType | Description |
---|
mixed | The claim matching that specific URI or null if not found |



getCode() : integer
Gets the result code of the claims object
ReturnsType | Description |
---|
integer | The result code |



getDefaultNamespace() : string
Retrieves the default namespace used in this information card.
If a default namespace was not
set, it figures out which one to consider 'default' by taking the first namespace sorted by use-count
in claims
ReturnsType | Description |
---|
string | The default namespace |
Throws


getErrorMsg() : string
Retrieve the error message contained within the claims object
ReturnsType | Description |
---|
string | The error message |



setClaims(array $claims) : \Zend_InfoCard_Claims
Set the claims for the claims object.
Can only be set once and is done
by the component itself. Internal use only.
ParametersName | Type | Description |
---|
$claims | array | |
---|
ReturnsThrows


setCode(int $code) : \Zend_InfoCard_Claims
Set the result code of the claims object.
ParametersName | Type | Description |
---|
$code | int | The result code |
---|
ReturnsThrows 


setDefaultNamespace(string $namespace) : \Zend_InfoCard_Claims
Set the default namespace, overriding any existing default
ParametersName | Type | Description |
---|
$namespace | string | The default namespace to use |
---|
ReturnsThrows 


setError(string $error) : \Zend_InfoCard_Claims
Set the error message contained within the claims object
ParametersName | Type | Description |
---|
$error | string | The error message |
---|
Returns