Overview

Namespaces

  • Chippyash
    • Authentication
      • Manager
        • Digest
        • Encoder
        • Exceptions
        • Traits

Classes

  • AbstractDigestCollection
  • BasicDigestCollection

Interfaces

  • DigestCollectionInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Interface DigestCollectionInterface

Interface for a Digest Collection

Direct known implementers

Chippyash\Authentication\Manager\Digest\AbstractDigestCollection

Indirect known implementers

Chippyash\Authentication\Manager\Digest\BasicDigestCollection
Namespace: Chippyash\Authentication\Manager\Digest
Located at Authentication/Manager/Digest/DigestCollectionInterface.php
Methods summary
public Chippyash\Type\Number\IntType|BoolType=false
# findByUid( Chippyash\Type\String\StringType $uid )

Return index into collection for a digest given its uid

Return index into collection for a digest given its uid

Parameters

$uid
user id

Returns

Chippyash\Type\Number\IntType|BoolType=false
IntType|BoolType=false
public Chippyash\Type\BoolType
# read( )

Read the digest into the collection from file

Read the digest into the collection from file

Returns

Chippyash\Type\BoolType
true on success else false
public Chippyash\Type\BoolType
# write( )

Write the collection to file

Write the collection to file

Returns

Chippyash\Type\BoolType
true on success else false
public Chippyash\Type\BoolType
# add( Chippyash\Type\String\StringType $uid, Chippyash\Type\String\StringType $pwd )

Add a digest line to the collection

Add a digest line to the collection

Parameters

$uid
user id
$pwd
password

Returns

Chippyash\Type\BoolType
true on success else false
public array
# get( Chippyash\Type\Number\IntType $index )

Get digest item

Get digest item

Parameters

$index

Returns

array
Digest item
public Chippyash\Type\BoolType
# del( Chippyash\Type\Number\IntType $index )

Delete digest item

Delete digest item

Parameters

$index

Returns

Chippyash\Type\BoolType
true on success else false
public Chippyash\Type\String\StringType
# asString( Chippyash\Type\Number\IntType $index )

Return the collection item as a raw digest string

Return the collection item as a raw digest string

Parameters

$index
Index into collection

Returns

Chippyash\Type\String\StringType
StringType

Throws

chippyash\Authezntication\Manager\Exceptions\AuthManagerException
chippyash\Authezntication\Manager\Exceptions\AuthManagerException
Chippyash Authentication Manager Library API API documentation generated by ApiGen 2.8.0