new

On argument is required and it is a Toader object.

    my $foo = Toader::Entry::Helper->new( $toader );
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

entryDirectory

This requires setDir to be called previously.

If setDir has been successfully called, this will not error.

    my $entryDirectory=$foo->entryDirectory;
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

entryExists

One argument is accepted and it is

This requires setDir to be called previously.

    my $retruned=$foo->entryExists($entry);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }
    if($returned){
        print "It exists.\n";
    }

generateEntryName

    my $entryName=$foo->generateEntryName;

setDir

One argument is required. It is the directory to use.

    $foo->setDir($directory);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

summary

returned hash

The key values are the entry IDs. Each subhash then contains the following keys.

    from
    renderer
    title
    summary

validEntryName

One arguemnet is taken and that is the name of the entry name to check.

This will not error. If the name is not defined, false, '0', will be returned as undefined is not a valid name.

    my $valid=$foo->validEntryName($name);
    if($valid){
        print '"'.$name.'" is a valid name.';
    }

validEntryNameRegex

This method does not call errorBlank for ease simplicity. This means a error check should not be done on this message as if any error was set previously then one will still be set.

    my $regex=$foo->validEntryNameRegex($name);

1, notAtoaderDir

2, noDirSpecified

3, noEntrySpecified

4, noDirSet

5, invalidEntryName

6, entryManageErrored

7, listEntriesErrored

8, readEntryErrored

9, noToaderObj

10, notAtoaderObj