Class BasicDigestCollection

A collection of Basic Digests

Chippyash\Authentication\Manager\Digest\AbstractDigestCollection implements Chippyash\Authentication\Manager\Digest\DigestCollectionInterface, Countable

Extended by

Chippyash\Authentication\Manager\Digest\BasicDigestCollection uses Chippyash\Authentication\Manager\Traits\RealmHandler

Namespace: Chippyash\Authentication\Manager\Digest
Located at Authentication/Manager/Digest/BasicDigestCollection.php

Methods summary
`public`	# `__construct( Chippyash\Authentication\Manager\Encoder\DigestEncoderInterface $encoder, Chippyash\Type\String\StringType $fileName, array $digests = [] )` Constructor Constructor Parameters `$encoder` `$fileName` `$digests` Digests to add to collection Overrides `Chippyash\Authentication\Manager\Digest\AbstractDigestCollection::__construct()`
`public Chippyash\Type\Number\IntType\|false`	# `findByUid( Chippyash\Type\String\StringType $uid )` Return index into collection for a digest given its uid Side effect: will rewind collection to start Return index into collection for a digest given its uid Side effect: will rewind collection to start Parameters `$uid` user id Returns `Chippyash\Type\Number\IntType\|false` IntType\|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 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\Authentication\Manager\Exceptions\AuthManagerException` AuthManagerException
`protected string`	# `raw( array $digest )` Convert internal representation to external representation Convert internal representation to external representation Parameters `$digest` Returns `string` string

Methods inherited from Chippyash\Authentication\Manager\Digest\AbstractDigestCollection
`count(), del(), get(), setEncoder(), setWriteOptions()`

Methods used from Chippyash\Authentication\Manager\Traits\RealmHandler
`(), ()`

Constants summary
`string`	`SEP_DIGEST`	#`':'`

Constants inherited from Chippyash\Authentication\Manager\Digest\AbstractDigestCollection
`ERR_NO_DIGEST_TPL`

Properties summary
`protected Chippyash\Authentication\Manager\Encoder\DigestEncoderInterface`	`$encoder` Digest encoder Digest encoder	#

Properties inherited from Chippyash\Authentication\Manager\Digest\AbstractDigestCollection
`$collection, $fileName, $writeOptions`

Properties used from Chippyash\Authentication\Manager\Traits\RealmHandler
`$realm`