InfoCard/Claims.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_InfoCard
version: $Id: Claims.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_InfoCard_Claims

Description

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.

Zend_InfoCard_Claims
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_InfoCard
Constants: RESULT_SUCCESS; RESULT_PROCESSING_FAILURE; RESULT_VALIDATION_FAILURE
Properties: $_defaultNamespace; $_isValid; $_error; $_claims; $_code
Methods: forceValid; getCardID; getDefaultNamespace; setDefaultNamespace; isValid; setError; getErrorMsg; setClaims; setCode; getCode; getClaim; claimExists; __unset; __isset; __get; __set

Description

Result value of the InfoCard component, contains any error messages and claims from the processing of an information card.

Constants

RESULT_SUCCESS
jump to class

 RESULT_SUCCESS = '1'

Successful validation and extraion of claims

Details

value: 1

RESULT_PROCESSING_FAILURE
jump to class

 RESULT_PROCESSING_FAILURE = '2'

Indicates there was an error processing the XML document

Details

value: 2

RESULT_VALIDATION_FAILURE
jump to class

 RESULT_VALIDATION_FAILURE = '3'

Indicates that the signature values within the XML document failed verification

Details

value: 3

Properties

$_claims
jump to class

array $_claims = ''

An array of claims taken from the information card

Details

$_claims: array
visibility: protected
default
final: false
static: false

$_code
jump to class

integer $_code = ''

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

Details

$_code: integer
visibility: protected
default
final: false
static: false

$_defaultNamespace
jump to class

string $_defaultNamespace = 'null'

The default namespace to assume in these claims

Details

$_defaultNamespace: string
visibility: protected
default: null
final: false
static: false

$_error
jump to class

string $_error = ''

The error message if any

Details

$_error: string
visibility: protected
default
final: false
static: false

$_isValid
jump to class

bool $_isValid = 'true'

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

Details

$_isValid: bool
visibility: protected
default: true
final: false
static: false

Methods

__get
jump to class

Magic helper function

Arguments

$k

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
           $k
          )
        
        :

Magic helper function

Arguments

$k

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
           $k,  $v
          )
        
        :

Magic helper function

Arguments

$k
$v

Details

visibility: public
final: false
static: false
throws

__unset
jump to class

__unset(
           $k
          )
        
        :

Magic helper function

Arguments

$k

Details

visibility: public
final: false
static: false
throws

claimExists
jump to class

claimExists(
          string $claimURI
          )
        
        :
        bool

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

Arguments

$claimURI: string
The complete claim URI to check

Output

bool: true if the claim exists, false if not found

Details

visibility: public
final: false
static: false

forceValid
jump to class

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

Output

Zend_InfoCard_Claims

Details

visibility: public
final: false
static: false

getCardID
jump to class

getCardID(
          
          )
        
        :
        string

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

Output

string: the private personal identifier

Details

visibility: public
final: false
static: false

getClaim
jump to class

getClaim(
          string $claimURI
          )
        
        :
        mixed

Get a claim by providing its complete claim URI

Arguments

$claimURI: string
The complete claim URI to retrieve

Output

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

Details

visibility: public
final: false
static: false

getCode
jump to class

getCode(
          
          )
        
        :
        integer

Gets the result code of the claims object

Output

integer: The result code

Details

visibility: public
final: false
static: false

getDefaultNamespace
jump to class

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

Output

string: The default namespace

Details

visibility: public
final: false
static: false
throws

getErrorMsg
jump to class

getErrorMsg(
          
          )
        
        :
        string

Retrieve the error message contained within the claims object

Output

string: The error message

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          
          )
        
        :
        bool

Indicates if this claim object contains validated claims or not

Output

bool

Details

visibility: public
final: false
static: false

setClaims
jump to class

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.

Arguments

$claims: array

Output

Zend_InfoCard_Claims

Details

visibility: public
final: false
static: false
throws

setCode
jump to class

setCode(
          int $code
          )
        
        :
        Zend_InfoCard_Claims

Set the result code of the claims object.

Arguments

$code: int
The result code

Output

Zend_InfoCard_Claims

Details

visibility: public
final: false
static: false
throws

setDefaultNamespace
jump to class

setDefaultNamespace(
          string $namespace
          )
        
        :
        Zend_InfoCard_Claims

Set the default namespace, overriding any existing default

Arguments

$namespace: string
The default namespace to use

Output

Zend_InfoCard_Claims

Details

visibility: public
final: false
static: false
throws

setError
jump to class

setError(
          string $error
          )
        
        :
        Zend_InfoCard_Claims

Set the error message contained within the claims object

Arguments

$error: string
The error message

Output

Zend_InfoCard_Claims

Details

visibility: public
final: false
static: false

API Documentation

InfoCard/Claims.php

Description

Zend_InfoCard_Claimsjump to top

Description

Constants

RESULT_SUCCESSjump to class

Details

RESULT_PROCESSING_FAILUREjump to class

Details

RESULT_VALIDATION_FAILUREjump to class

Details

Properties

$_claimsjump to class

Details

$_codejump to class

Details

$_defaultNamespacejump to class

Details

$_errorjump to class

Details

$_isValidjump to class

Details

Methods

__getjump to class

Arguments

Details

__issetjump to class

Arguments

Details

__setjump to class

Arguments

Details

__unsetjump to class

Arguments

Details

claimExistsjump to class

Arguments

Output

Details

forceValidjump to class

Output

Details

getCardIDjump to class

Output

Details

getClaimjump to class

Arguments

Output

Details

getCodejump to class

Output

Details

getDefaultNamespacejump to class

Output

Details

getErrorMsgjump to class

Output

Details

isValidjump to class

Output

Details

setClaimsjump to class

Arguments

Output

Details

setCodejump to class

Arguments

Output

Details

setDefaultNamespacejump to class

Arguments

Output

Details

setErrorjump to class

Arguments

Output

Details

Zend_InfoCard_Claims
jump to top

RESULT_SUCCESS
jump to class

RESULT_PROCESSING_FAILURE
jump to class

RESULT_VALIDATION_FAILURE
jump to class

$_claims
jump to class

$_code
jump to class

$_defaultNamespace
jump to class

$_error
jump to class

$_isValid
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__unset
jump to class

claimExists
jump to class

forceValid
jump to class

getCardID
jump to class

getClaim
jump to class

getCode
jump to class

getDefaultNamespace
jump to class

getErrorMsg
jump to class

isValid
jump to class

setClaims
jump to class

setCode
jump to class

setDefaultNamespace
jump to class

setError
jump to class