Overview

Namespaces

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

Classes

  • DigestManager

Interfaces

  • ManagerInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class DigestManager

Manage a Digest file

Chippyash\Authentication\Manager\DigestManager implements Chippyash\Authentication\Manager\ManagerInterface
Namespace: Chippyash\Authentication\Manager
Link: http://framework.zend.com/manual/current/en/modules/zend.authentication.adapter.digest.html
Link: http://en.wikipedia.org/wiki/Digest_access_authentication
Link: http://httpd.apache.org/docs/2.2/programs/htdigest.html
Located at Authentication/Manager/DigestManager.php
Methods summary
public
# __construct( Chippyash\Authentication\Manager\Digest\DigestCollectionInterface $collection )

Constructor

Constructor

Parameters

$collection
public Bool
# create( Chippyash\Type\String\StringType $uid, Chippyash\Type\String\StringType $pwd )

Add new entry to digest

Add new entry to digest

Parameters

$uid
$pwd

Returns

Bool
True on success else false

Throws

Chippyash\Authentication\Manager\Exceptions\AuthManagerException
Chippyash\Authentication\Manager\Exceptions\AuthManagerException

Implementation of

Chippyash\Authentication\Manager\ManagerInterface::create()
public String
# read( Chippyash\Type\String\StringType $uid )

Return raw record from target system

Return raw record from target system

Parameters

$uid

Returns

String
Digest line

Throws

Chippyash\Authentication\Manager\Exceptions\AuthManagerException
Chippyash\Authentication\Manager\Exceptions\AuthManagerException

Implementation of

Chippyash\Authentication\Manager\ManagerInterface::read()
public Bool
# update( Chippyash\Type\String\StringType $uid, Chippyash\Type\String\StringType $pwd )

Change password for user in digest

Change password for user in digest

Parameters

$uid
$pwd

Returns

Bool
Bool

Throws

Chippyash\Authentication\Manager\Exceptions\AuthManagerException
Chippyash\Authentication\Manager\Exceptions\AuthManagerException

Implementation of

Chippyash\Authentication\Manager\ManagerInterface::update()
public Bool
# delete( Chippyash\Type\String\StringType $uid )

Delete user from digest

Delete user from digest

Parameters

$uid

Returns

Bool
true on success else false

Throws

Chippyash\Authentication\Manager\Exceptions\AuthManagerException
Chippyash\Authentication\Manager\Exceptions\AuthManagerException

Implementation of

Chippyash\Authentication\Manager\ManagerInterface::delete()
public Bool
# has( Chippyash\Type\String\StringType $uid )

Does digest have identity specified by uid

Does digest have identity specified by uid

Parameters

$uid

Returns

Bool
True if entry exists else false

Implementation of

Chippyash\Authentication\Manager\ManagerInterface::has()
public Chippyash\Authentication\Manager\DigestManager
# init( )

Initialise the manager from source

Initialise the manager from source

Returns

Chippyash\Authentication\Manager\DigestManager
\Chippyash\Authentication\Manager\DigestManager
Constants summary
string ERR_UID_EXISTS_TPL
#'Uid: %s already exists'
string ERR_UID_NOTEXISTS_TPL
#'Uid: %s does not exist'
string ERR_CANNOT_DEL_DIGEST_TPL
#'Cannot delete digest identified by: %s'
Properties summary
protected Chippyash\Authentication\Manager\Digest\DigestCollectionInterface $collection

Digest collection

Digest collection

#
protected boolean $doDeleteWrite

Shall we write file after a delete? Set to false on an update()

Shall we write file after a delete? Set to false on an update()

#true
Chippyash Authentication Manager Library API API documentation generated by ApiGen 2.8.0