1;
__END__
-=head2 EXAMPLES
+=head1 EXAMPLES
-our %patron_example = (
+ our %patron_example = (
djfiander => {
name => "David J. Fiander",
id => 'djfiander',
},
);
-From borrowers table:
-+---------------------+--------------+------+-----+
-| Field | Type | Null | Key |
-+---------------------+--------------+------+-----+
-| borrowernumber | int(11) | NO | PRI |
-| cardnumber | varchar(16) | YES | UNI |
-| surname | mediumtext | NO | |
-| firstname | text | YES | |
-| title | mediumtext | YES | |
-| othernames | mediumtext | YES | |
-| initials | text | YES | |
-| streetnumber | varchar(10) | YES | |
-| streettype | varchar(50) | YES | |
-| address | mediumtext | NO | |
-| address2 | text | YES | |
-| city | mediumtext | NO | |
-| zipcode | varchar(25) | YES | |
-| country | text | YES | |
-| email | mediumtext | YES | |
-| phone | text | YES | |
-| mobile | varchar(50) | YES | |
-| fax | mediumtext | YES | |
-| emailpro | text | YES | |
-| phonepro | text | YES | |
-| B_streetnumber | varchar(10) | YES | |
-| B_streettype | varchar(50) | YES | |
-| B_address | varchar(100) | YES | |
-| B_address2 | text | YES | |
-| B_city | mediumtext | YES | |
-| B_zipcode | varchar(25) | YES | |
-| B_country | text | YES | |
-| B_email | text | YES | |
-| B_phone | mediumtext | YES | |
-| dateofbirth | date | YES | |
-| branchcode | varchar(10) | NO | MUL |
-| categorycode | varchar(10) | NO | MUL |
-| dateenrolled | date | YES | |
-| dateexpiry | date | YES | |
-| gonenoaddress | tinyint(1) | YES | |
-| lost | tinyint(1) | YES | |
-| debarred | tinyint(1) | YES | |
-| contactname | mediumtext | YES | |
-| contactfirstname | text | YES | |
-| contacttitle | text | YES | |
-| guarantorid | int(11) | YES | |
-| borrowernotes | mediumtext | YES | |
-| relationship | varchar(100) | YES | |
-| ethnicity | varchar(50) | YES | |
-| ethnotes | varchar(255) | YES | |
-| sex | varchar(1) | YES | |
-| password | varchar(30) | YES | |
-| flags | int(11) | YES | |
-| userid | varchar(30) | YES | MUL |
-| opacnote | mediumtext | YES | |
-| contactnote | varchar(255) | YES | |
-| sort1 | varchar(80) | YES | |
-| sort2 | varchar(80) | YES | |
-| altcontactfirstname | varchar(255) | YES | |
-| altcontactsurname | varchar(255) | YES | |
-| altcontactaddress1 | varchar(255) | YES | |
-| altcontactaddress2 | varchar(255) | YES | |
-| altcontactaddress3 | varchar(255) | YES | |
-| altcontactzipcode | varchar(50) | YES | |
-| altcontactcountry | text | YES | |
-| altcontactphone | varchar(50) | YES | |
-| smsalertnumber | varchar(50) | YES | |
-+---------------------+--------------+------+-----+
-
-From C4::Members
-
-$flags->{KEY}
-{CHARGES}
+ From borrowers table:
+ +---------------------+--------------+------+-----+
+ | Field | Type | Null | Key |
+ +---------------------+--------------+------+-----+
+ | borrowernumber | int(11) | NO | PRI |
+ | cardnumber | varchar(16) | YES | UNI |
+ | surname | mediumtext | NO | |
+ | firstname | text | YES | |
+ | title | mediumtext | YES | |
+ | othernames | mediumtext | YES | |
+ | initials | text | YES | |
+ | streetnumber | varchar(10) | YES | |
+ | streettype | varchar(50) | YES | |
+ | address | mediumtext | NO | |
+ | address2 | text | YES | |
+ | city | mediumtext | NO | |
+ | zipcode | varchar(25) | YES | |
+ | country | text | YES | |
+ | email | mediumtext | YES | |
+ | phone | text | YES | |
+ | mobile | varchar(50) | YES | |
+ | fax | mediumtext | YES | |
+ | emailpro | text | YES | |
+ | phonepro | text | YES | |
+ | B_streetnumber | varchar(10) | YES | |
+ | B_streettype | varchar(50) | YES | |
+ | B_address | varchar(100) | YES | |
+ | B_address2 | text | YES | |
+ | B_city | mediumtext | YES | |
+ | B_zipcode | varchar(25) | YES | |
+ | B_country | text | YES | |
+ | B_email | text | YES | |
+ | B_phone | mediumtext | YES | |
+ | dateofbirth | date | YES | |
+ | branchcode | varchar(10) | NO | MUL |
+ | categorycode | varchar(10) | NO | MUL |
+ | dateenrolled | date | YES | |
+ | dateexpiry | date | YES | |
+ | gonenoaddress | tinyint(1) | YES | |
+ | lost | tinyint(1) | YES | |
+ | debarred | tinyint(1) | YES | |
+ | contactname | mediumtext | YES | |
+ | contactfirstname | text | YES | |
+ | contacttitle | text | YES | |
+ | guarantorid | int(11) | YES | |
+ | borrowernotes | mediumtext | YES | |
+ | relationship | varchar(100) | YES | |
+ | ethnicity | varchar(50) | YES | |
+ | ethnotes | varchar(255) | YES | |
+ | sex | varchar(1) | YES | |
+ | password | varchar(30) | YES | |
+ | flags | int(11) | YES | |
+ | userid | varchar(30) | YES | MUL |
+ | opacnote | mediumtext | YES | |
+ | contactnote | varchar(255) | YES | |
+ | sort1 | varchar(80) | YES | |
+ | sort2 | varchar(80) | YES | |
+ | altcontactfirstname | varchar(255) | YES | |
+ | altcontactsurname | varchar(255) | YES | |
+ | altcontactaddress1 | varchar(255) | YES | |
+ | altcontactaddress2 | varchar(255) | YES | |
+ | altcontactaddress3 | varchar(255) | YES | |
+ | altcontactzipcode | varchar(50) | YES | |
+ | altcontactcountry | text | YES | |
+ | altcontactphone | varchar(50) | YES | |
+ | smsalertnumber | varchar(50) | YES | |
+ +---------------------+--------------+------+-----+
+
+ From C4::Members
+
+ $flags->{KEY}
+ {CHARGES}
{message} Message showing patron's credit or debt
{noissues} Set if patron owes >$5.00
-{GNA} Set if patron gone w/o address
+ {GNA} Set if patron gone w/o address
{message} "Borrower has no valid address"
{noissues} Set.
-{LOST} Set if patron's card reported lost
+ {LOST} Set if patron's card reported lost
{message} Message to this effect
{noissues} Set.
-{DBARRED} Set if patron is debarred
+ {DBARRED} Set if patron is debarred
{message} Message to this effect
{noissues} Set.
-{NOTES} Set if patron has notes
+ {NOTES} Set if patron has notes
{message} Notes about patron
-{ODUES} Set if patron has overdue books
+ {ODUES} Set if patron has overdue books
{message} "Yes"
{itemlist} ref-to-array: list of overdue books
{itemlisttext} Text list of overdue items
-{WAITING} Set if there are items available that the patron reserved
+ {WAITING} Set if there are items available that the patron reserved
{message} Message to this effect
{itemlist} ref-to-array: list of available items
projects / koha.git / blobdiff