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.
Result value of the InfoCard component, contains any error messages and claims from the processing of an information card.

integer
$_code= ''
The result code of processing the information card as defined by the constants of this class

string
$_defaultNamespace= 'null'
The default namespace to assume in these claims
null
Details
claimExists(
string $claimURI
)
:
bool
Indicates if a specific claim URI exists or not within the object
Name | Type | Description |
---|---|---|
$claimURI | string | The complete claim URI to check |
Type | 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
Type | Description |
---|---|
\Zend_InfoCard_Claims |

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

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

getCode(
)
:
integer
Gets the result code of the claims object
Type | 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
Type | Description |
---|---|
string | The default namespace |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |

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

isValid(
)
:
bool
Indicates if this claim object contains validated claims or not
Type | Description |
---|---|
bool |

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.
Name | Type | Description |
---|---|---|
$claims | array |
Type | Description |
---|---|
\Zend_InfoCard_Claims |
Exception | Description |
---|---|
\Zend_InfoCard_Exception |

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

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

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