InfoCard/Claims.php

Show:

inherited

Classes
- \Zend_InfoCard_Claims

Table of Contents

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 $

\Zend_InfoCard_Claims
jump to top

Package: Zend\InfoCard

Result 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

 
                RESULT_SUCCESS
                = 1

Successful validation and extraion of claims

 
                RESULT_PROCESSING_FAILURE
                = 2

Indicates there was an error processing the XML document

 
                RESULT_VALIDATION_FAILURE
                = 3

Indicates that the signature values within the XML document failed verification

Properties

array $_claims

An array of claims taken from the information card

Details

Type: array

integer $_code

The result code of processing the information card as defined by the constants of this class

Details

Type: integer

string $_defaultNamespace = null

The default namespace to assume in these claims

Default valuenullDetails

Type: string

string $_error = ""

The error message if any

Default value""Details

Type: string

bool $_isValid = true

A boolean indicating if the claims should be consider "valid" or not based on processing

Default valuetrueDetails

Type: bool

Methods

__get( $k) : void

Magic helper function

Parameters

Name	Type	Description
$k

__isset( $k) : void

Magic helper function

Parameters

Name	Type	Description
$k

__set( $k, $v) : void

Magic helper function

Parameters

Name	Type	Description
$k
$v

Throws

Exception	Description
\Zend_InfoCard_Exception

__unset( $k) : void

Magic helper function

Parameters

Name	Type	Description
$k

Throws

Exception	Description
\Zend_InfoCard_Exception

claimExists(string $claimURI) : bool

Indicates if a specific claim URI exists or not within the object

Parameters

Name	Type	Description
$claimURI	string	The complete claim URI to check

Returns

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

Returns

Type	Description
\Zend_InfoCard_Claims

getCardID() : string

Retrieve the PPI (Private Personal Identifier) associated with the information card

Returns

Type	Description
string	the private personal identifier

getClaim(string $claimURI) : mixed

Get a claim by providing its complete claim URI

Parameters

Name	Type	Description
$claimURI	string	The complete claim URI to retrieve

Returns

Type	Description
mixed	The claim matching that specific URI or null if not found

getCode() : integer

Gets the result code of the claims object

Returns

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

Returns

Type	Description
string	The default namespace

Throws

Exception	Description
\Zend_InfoCard_Exception

getErrorMsg() : string

Retrieve the error message contained within the claims object

Returns

Type	Description
string	The error message

isValid() : bool

Indicates if this claim object contains validated claims or not

Returns

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.

Parameters

Name	Type	Description
$claims	array

Returns

Type	Description
\Zend_InfoCard_Claims

Throws

Exception	Description
\Zend_InfoCard_Exception

setCode(int $code) : \Zend_InfoCard_Claims

Set the result code of the claims object.

Parameters

Name	Type	Description
$code	int	The result code

Returns

Type	Description
\Zend_InfoCard_Claims

Throws

Exception	Description
\Zend_InfoCard_Exception

setDefaultNamespace(string $namespace) : \Zend_InfoCard_Claims

Set the default namespace, overriding any existing default

Parameters

Name	Type	Description
$namespace	string	The default namespace to use

Returns

Type	Description
\Zend_InfoCard_Claims

Throws

Exception	Description
\Zend_InfoCard_Exception

setError(string $error) : \Zend_InfoCard_Claims

Set the error message contained within the claims object

Parameters

Name	Type	Description
$error	string	The error message

Returns

Type	Description
\Zend_InfoCard_Claims

InfoCard/Claims.php

\Zend_InfoCard_Claimsjump to top

Constants

Properties

Methods

\Zend_InfoCard_Claims
jump to top