Skip to content

Library of Congress Cutter Number Generation Library

License

Notifications You must be signed in to change notification settings

gerardbalaoro/cuttergen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CutterGen

Library of Congress Cutter Number Generation Library.

PHP from Packagist GitHub Packagist Version CircleCI

This package follows the specifications presented on the Classification and Shelflisting Manual Instruction Sheet G63.

See demonstration on PHP Sandbox.

Installation

composer require gerardbalaoro/cuttergen

Basic Usage

/**
 * Initialize CutterGen instance, pass default expansion length (optional)
 *  - $length = 0 : no expansion
 *  - $length = -1 : expand all characters
 */
$cutter = new CutterGen\CutterGen(1);

/**
 * Can also set default expansion length using `setLength`
 */
$cutter->setLength(2);

/**
 * Generate cutter number (Prints: S658)
 */
echo $cutter->generate('Smith');

/**
 * Can also pass length (Prints: S65)
 */
echo $cutter->generate('Smith', 1);

Handling Qa - Qt Initials

For initials Qa-Qt, use numbers 2-29

By default, the package assigns values to a character by its order in the English alpabeth, starting at 2. To customize, simple pass a callable object to the setHandlder() method.

$cutter = new CutterGen\CutterGen();

$cutter->setHandler('qa-qt', function($char) {
    if ($char == 'a') {
        return '5';
    }
    ...
});

// Prints: Q55
echo $cutter->generate('Qaldor')

Reference

About

Library of Congress Cutter Number Generation Library

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages