README

Installation

• Clone the repository git clone https://github.com/isaeken/password-generator.git
• Install packages using composer composer install

Using with CLI

• Activate interface php bin/cli.php --interface=1
• Usage php bin/cli.php [arguments]

Using in your code

Add to your project using composer

composer require isaeken/password-generator

Initialize password generator

use IsaEken\PasswordGenerator\PasswordGenerator;
$passwordGenerator = new PasswordGenerator;

Generate password with default options

$password = $passwordGenerator->generate();

Generate password with custom length

$password = $passwordGenerator->generate(16);

Generate password with custom options

using arguments

$password = $passwordGenerator->generate([
	'length' => 16,
	'numbers' => false,
]);

or variables

$passwordGenerator->length = 16;
$passwordGenerator->numbers = false;
$password = $passwordGenerator->generate();

or chain functions

$password = $passwordGenerator->setLength(16)->setNumbers(false)->generate();

Generate a character

$character = $passwordGenerator->character();

Generate password between lengths

$password = $passwordGenerator->generateBetween(3, 6);

Variables and functions

// variables
$passwordGenerator->length : int;
$passwordGenerator->symbols: bool;
$passwordGenerator->numbers: bool;
$passwordGenerator->lowercase : bool;
$passwordGenerator->uppercase: bool;
$passwordGenerator->similar: bool;
$passwordGenerator->ambiguous: bool;
$passwordGenerator->variables: IsaEken\PasswordGenerator\Variables;

// functions
$passwordGenerator->__construct(?array $options = null);
$passwordGenerator->setLength(int $length = 16) : PasswordGenerator;
$passwordGenerator->setSymbols(bool $symbols = true) : PasswordGenerator;
$passwordGenerator->setNumbers(bool $numbers = true) : PasswordGenerator;
$passwordGenerator->setLowercase(bool $lowercase = true) : PasswordGenerator;
$passwordGenerator->setUppercase(bool $uppercase = true) : PasswordGenerator;
$passwordGenerator->setSimilar(bool $similar = false) : PasswordGenerator;
$passwordGenerator->setAmbiguous(bool $ambiguous = false) : PasswordGenerator;
$passwordGenerator->character() : string;
$passwordGenerator->generate(?int $length = null) : string;
$passwordGenerator->generateBetween(int $min, int $max) : string;

Converters

Password to rememberable string converter

use IsaEken\PasswordGenerator\Converters\PasswordToRememberable;
$passwordToRememberable = new PasswordToRememberable;
$passwordToRememberable->setLanguage('tr');
$passwordToRememberable->password = 'pa5swOrd';
$rememberableString = $passwordToRememberable->convert();

Rememberable string to password converter

use IsaEken\PasswordGenerator\Converters\RememberableToPassword;
$rememberableToPassword = new RememberableToPassword;
$rememberableToPassword->rememberable = ' pano  açıklama  5  selanik  w  OKYANUS  rüzgar  devrim ';
$password = $rememberableToPassword->convert();