File_MARC
[ class tree: File_MARC ] [ index: File_MARC ] [ all elements ]

Element index for package File_MARC

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ v ] [ w ] [ x ] [ _ ]

_

__construct
in file Lint.php, method File_MARC_Lint::__construct()
    Start function
__construct
in file CodeData.php, method File_MARC_Lint_CodeData::__construct()
    Start function
__construct
in file MARC.php, method File_MARC::__construct()
    Read in MARC records
__construct
in file MARCBASE.php, method File_MARCBASE::__construct()
    Read in MARCXML records
__construct
in file Record.php, method File_MARC_Record::__construct()
    Start function
__construct
in file MARCXML.php, method File_MARCXML::__construct()
    Read in MARCXML records
__construct
in file Subfield.php, method File_MARC_Subfield::__construct()
    File_MARC_Subfield constructor
__construct
in file Field.php, method File_MARC_Field::__construct()
    File_MARC_Field constructor
__construct
in file Control_Field.php, method File_MARC_Control_Field::__construct()
    Field init function
__construct
in file Data_Field.php, method File_MARC_Data_Field::__construct()
    File_MARC_Data_Field constructor
__destruct
in file Subfield.php, method File_MARC_Subfield::__destruct()
    Destroys the subfield
__destruct
in file Control_Field.php, method File_MARC_Control_Field::__destruct()
    Destroys the control field
__destruct
in file Data_Field.php, method File_MARC_Data_Field::__destruct()
    Destroys the data field
__destruct
in file Field.php, method File_MARC_Field::__destruct()
    Destroys the data field
__destruct
in file Record.php, method File_MARC_Record::__destruct()
    Destroys the data field
__toString
in file Subfield.php, method File_MARC_Subfield::__toString()
    Return string representation of subfield
__toString
in file Field.php, method File_MARC_Field::__toString()
    Return Field formatted
__toString
in file Control_Field.php, method File_MARC_Control_Field::__toString()
    Return as a formatted string
__toString
in file Data_Field.php, method File_MARC_Data_Field::__toString()
    Return Field formatted
__toString
in file Record.php, method File_MARC_Record::__toString()
    Return the MARC record in a pretty printed string
top

a

addSubfields
in file Data_Field.php, method File_MARC_Data_Field::addSubfields()
    Adds an array of subfields to a File_MARC_Data_Field object
addWarning
in file Record.php, method File_MARC_Record::addWarning()
    Add a warning to the MARC record that something non-fatal occurred during parsing.
appendField
in file Record.php, method File_MARC_Record::appendField()
    Appends field to MARC record
appendNode
in file List.php, method File_MARC_List::appendNode()
    Adds a node onto the linked list.
appendSubfield
in file Data_Field.php, method File_MARC_Data_Field::appendSubfield()
    Appends subfield to subfield list
top

c

$code
in file Subfield.php, variable File_MARC_Subfield::$code
    Subfield code, e.g. _a, _b
$counter
in file MARCXML.php, variable File_MARCXML::$counter
    Counter for MARCXML records in a collection
$countryCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$countryCodes
    Valid Country Codes
check020
in file Lint.php, method File_MARC_Lint::check020()
    Looks at 020$a and reports errors if the check digit is wrong.
check041
in file Lint.php, method File_MARC_Lint::check041()
    Warns if subfields are not evenly divisible by 3 unless second indicator is 7
check043
in file Lint.php, method File_MARC_Lint::check043()
    Warns if each subfield a is not exactly 7 characters. Validates each code against the MARC code list for Geographic Areas (<http://www.loc.gov/marc/>).
check245
in file Lint.php, method File_MARC_Lint::check245()
    -Makes sure $a exists (and is first subfield).
checkArticle
in file Lint.php, method File_MARC_Lint::checkArticle()
    Check of articles is based on code from Ian Hamilton. This version is more
checkDuplicate1xx
in file Lint.php, method File_MARC_Lint::checkDuplicate1xx()
    Check for multiple 1xx fields.
checkIndicators
in file Lint.php, method File_MARC_Lint::checkIndicators()
    Check the indicators for the provided field.
checkMissing245
in file Lint.php, method File_MARC_Lint::checkMissing245()
    Check for missing 245 field.
checkRecord
in file Lint.php, method File_MARC_Lint::checkRecord()
    Check the provided MARC record and return an array of warning messages.
checkSubfields
in file Lint.php, method File_MARC_Lint::checkSubfields()
    Check the subfields for the provided field.
Control_Field.php
procedural page Control_Field.php
CodeData.php
procedural page CodeData.php
top

d

$data
in file Subfield.php, variable File_MARC_Subfield::$data
    Data contained by the subfield
$data
in file Control_Field.php, variable File_MARC_Control_Field::$data
    Value of field, if field is a Control field
$data
in file Lint.php, variable File_MARC_Lint::$data
    A File_MARC_Lint_CodeData object for validating codes
delete
in file Data_Field.php, method File_MARC_Data_Field::delete()
    Destroys the data field
delete
in file Control_Field.php, method File_MARC_Control_Field::delete()
    Destroys the control field
delete
in file Subfield.php, method File_MARC_Subfield::delete()
    Destroys the subfield
deleteFields
in file Record.php, method File_MARC_Record::deleteFields()
    Delete all occurrences of a field matching a tag name from the record.
deleteNode
in file List.php, method File_MARC_List::deleteNode()
    Deletes a node from the linked list.
deleteSubfield
in file Data_Field.php, method File_MARC_Data_Field::deleteSubfield()
    Delete a subfield from the field.
DIRECTORY_ENTRY_LEN
in file MARC.php, class constant File_MARC::DIRECTORY_ENTRY_LEN
    Length of the Directory
Data_Field.php
procedural page Data_Field.php
top

e

END_OF_FIELD
in file MARC.php, class constant File_MARC::END_OF_FIELD
    Hexadecimal value for End of Field
END_OF_RECORD
in file MARC.php, class constant File_MARC::END_OF_RECORD
    Hexadecimal value for End of Record
ERROR_EMPTY_SUBFIELD
in file Exception.php, class constant File_MARC_Exception::ERROR_EMPTY_SUBFIELD
    A subfield is defined, but has no data
ERROR_FIELD_EOF
in file Exception.php, class constant File_MARC_Exception::ERROR_FIELD_EOF
    A field does not end with the expected end-of-field character
ERROR_INCORRECT_LENGTH
in file Exception.php, class constant File_MARC_Exception::ERROR_INCORRECT_LENGTH
    The length in the MARC leader does not match the actual record length
ERROR_INSERTFIELD_MODE
in file Exception.php, class constant File_MARC_Exception::ERROR_INSERTFIELD_MODE
    An invalid mode for adding a field was specified
ERROR_INSERTSUBFIELD_MODE
in file Exception.php, class constant File_MARC_Exception::ERROR_INSERTSUBFIELD_MODE
    An invalid mode for adding a subfield was specified
ERROR_INVALID_DIRECTORY
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_DIRECTORY
    An entry in the MARC directory runs past the end of the record
ERROR_INVALID_DIRECTORY_LENGTH
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_DIRECTORY_LENGTH
    An entry in the MARC directory was not 12 bytes
ERROR_INVALID_DIRECTORY_OFFSET
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_DIRECTORY_OFFSET
    An entry in the MARC directory specified an invalid field offset
ERROR_INVALID_DIRECTORY_TAG
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_DIRECTORY_TAG
    An entry in the MARC directory specified an invalid tag
ERROR_INVALID_DIRECTORY_TAG_LENGTH
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_DIRECTORY_TAG_LENGTH
    An entry in the MARC directory specified an invalid tag length
ERROR_INVALID_FIELD
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_FIELD
    An invalid object was passed instead of a File_MARC_Field object
ERROR_INVALID_FILE
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_FILE
    File could not be opened
ERROR_INVALID_INDICATOR
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_INDICATOR
    A field has invalid indicators
ERROR_INVALID_INDICATORS
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_INDICATORS
    A field has invalid indicators
ERROR_INVALID_INDICATOR_REQUEST
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_INDICATOR_REQUEST
    An indicator other than 1 or 2 was requested
ERROR_INVALID_SOURCE
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_SOURCE
    User passed an unknown SOURCE_ constant
ERROR_INVALID_SUBFIELD
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_SUBFIELD
    An invalid object was passed instead of a File_MARC_Subfield object
ERROR_INVALID_TAG
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_TAG
    Tag does not adhere to MARC standards
ERROR_INVALID_TERMINATOR
in file Exception.php, class constant File_MARC_Exception::ERROR_INVALID_TERMINATOR
    MARC record ended with an invalid terminator
ERROR_MISSING_LENGTH
in file Exception.php, class constant File_MARC_Exception::ERROR_MISSING_LENGTH
    The length field in the leader was less than five characters long
ERROR_NONNUMERIC_LENGTH
in file Exception.php, class constant File_MARC_Exception::ERROR_NONNUMERIC_LENGTH
    A five-digit length could not be found in the MARC leader
ERROR_NO_DIRECTORY
in file Exception.php, class constant File_MARC_Exception::ERROR_NO_DIRECTORY
    No directory was found for the MARC record
Exception.php
procedural page Exception.php
top

f

$fields
in file Record.php, variable File_MARC_Record::$fields
    Contains a linked list of File_MARC_Data_Field objects for
File_MARC
in file MARC.php, class File_MARC
    The main File_MARC class enables you to return File_MARC_Record objects from a stream or string.
Field.php
procedural page Field.php
File_MARCBASE
in file MARCBASE.php, class File_MARCBASE
    The main File_MARCBASE class provides common methods for File_MARC and File_MARCXML - primarily for generating MARCXML output.
File_MARCXML
in file MARCXML.php, class File_MARCXML
    The main File_MARCXML class enables you to return File_MARC_Record objects from an XML stream or string.
File_MARC_Control_Field
in file Control_Field.php, class File_MARC_Control_Field
    The File_MARC_Control_Field class represents a single control field in a MARC record.
File_MARC_Data_Field
in file Data_Field.php, class File_MARC_Data_Field
    The File_MARC_Data_Field class represents a single field in a MARC record.
File_MARC_Exception
in file Exception.php, class File_MARC_Exception
    The File_MARC_Exception class enables error-handling for the File_MARC package.
File_MARC_Field
in file Field.php, class File_MARC_Field
    The File_MARC_Field class is expected to be extended to reflect the requirements of control and data fields.
File_MARC_Lint
in file Lint.php, class File_MARC_Lint
    Class for testing validity of MARC records against MARC21 standard.
File_MARC_Lint_CodeData
in file CodeData.php, class File_MARC_Lint_CodeData
    Contains codes from the MARC code lists for Geographic Areas, Languages, and Countries.
File_MARC_List
in file List.php, class File_MARC_List
    The File_MARC_List class extends the SplDoublyLinkedList class to override the key() method in a meaningful way for foreach() iterators.
File_MARC_Record
in file Record.php, class File_MARC_Record
    Represents a single MARC record
File_MARC_Subfield
in file Subfield.php, class File_MARC_Subfield
    The File_MARC_Subfield class represents a single subfield in a MARC record field.
formatError
in file Exception.php, method File_MARC_Exception::formatError()
    Replaces placeholder tokens in an error message with actual values.
formatField
in file Field.php, method File_MARC_Field::formatField()
    Pretty print a MARC_Field object without tags, indicators, etc.
top

g

$geogAreaCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$geogAreaCodes
    Valid Geographic Area Codes
getCode
in file Subfield.php, method File_MARC_Subfield::getCode()
    Return code of the subfield
getContents
in file Data_Field.php, method File_MARC_Data_Field::getContents()
    Return fields data content as joined string
getData
in file Subfield.php, method File_MARC_Subfield::getData()
    Return data of the subfield
getData
in file Control_Field.php, method File_MARC_Control_Field::getData()
    Get control field data
getField
in file Record.php, method File_MARC_Record::getField()
    Return the first File_MARC_Data_Field or File_MARC_Control_Field object that matches the specified tag name. Returns false if no match is found.
getFields
in file Record.php, method File_MARC_Record::getFields()
    Return an array or File_MARC_List containing all File_MARC_Data_Field or File_MARC_Control_Field objects that match the specified tag name. If the tag name is omitted all fields are returned.
getHumanReadableIndicatorValues
in file Lint.php, method File_MARC_Lint::getHumanReadableIndicatorValues()
    Turn a set of indicator rules into a human-readable list.
getIndicator
in file Data_Field.php, method File_MARC_Data_Field::getIndicator()
    Get the value of an indicator
getLeader
in file Record.php, method File_MARC_Record::getLeader()
    Get MARC leader
getPosition
in file List.php, method File_MARC_List::getPosition()
    Return position of the subfield
getPosition
in file Subfield.php, method File_MARC_Subfield::getPosition()
    Return position of the subfield
getRawRules
in file Lint.php, method File_MARC_Lint::getRawRules()
    Support method for parseRules() -- get the raw rules from MARC::Lint.
getSubfield
in file Data_Field.php, method File_MARC_Data_Field::getSubfield()
    Returns the first subfield that matches a requested code.
getSubfields
in file Data_Field.php, method File_MARC_Data_Field::getSubfields()
    Returns an array of subfields that match a requested code, or a File_MARC_List that contains all of the subfields if the requested code is null.
getTag
in file Field.php, method File_MARC_Field::getTag()
    Returns the tag for this File_MARC_Field object
getWarnings
in file Record.php, method File_MARC_Record::getWarnings()
    Return the array of warnings from the MARC record.
getXMLWriter
in file MARCBASE.php, method File_MARCBASE::getXMLWriter()
    Returns the XMLWriter object
top

i

$ind1
in file Data_Field.php, variable File_MARC_Data_Field::$ind1
    Value of the first indicator
$ind2
in file Data_Field.php, variable File_MARC_Data_Field::$ind2
    Value of the second indicator
insertField
in file Record.php, method File_MARC_Record::insertField()
    Inserts a field in the MARC record relative to an existing field
insertNode
in file List.php, method File_MARC_List::insertNode()
    Inserts a node into the linked list, based on a reference node that already exists in the list.
insertSubfield
in file Data_Field.php, method File_MARC_Data_Field::insertSubfield()
    Inserts a field in the MARC record relative to an existing field
isControlField
in file Field.php, method File_MARC_Field::isControlField()
    Is control field
isDataField
in file Field.php, method File_MARC_Field::isDataField()
    Is data field
isEmpty
in file Subfield.php, method File_MARC_Subfield::isEmpty()
    Checks whether the subfield is empty or not
isEmpty
in file Data_Field.php, method File_MARC_Data_Field::isEmpty()
    Checks if the field is empty.
isEmpty
in file Control_Field.php, method File_MARC_Control_Field::isEmpty()
    Is empty
isEmpty
in file Field.php, method File_MARC_Field::isEmpty()
    Is empty
top

k

key
in file List.php, method File_MARC_List::key()
    Returns the tag for a File_MARC_Field object, or the code for a File_MARC_Subfield object.
top

l

$languageCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$languageCodes
    Valid Language Codes
$leader
in file Record.php, variable File_MARC_Record::$leader
    Record leader
Lint.php
procedural page Lint.php
List.php
procedural page List.php
LEADER_LEN
in file MARC.php, class constant File_MARC::LEADER_LEN
    Length of the Leader
top

m

$marc
in file Record.php, variable File_MARC_Record::$marc
    MARC instance for access to the XML header/footer methods We need this so that we can properly wrap a collection of MARC records.
$marcxml
in file Record.php, variable File_MARC_Record::$marcxml
    XMLWriter for writing collections
$messages
in file Exception.php, variable File_MARC_Exception::$messages
marc_yaz.php
procedural page marc_yaz.php
MARC.php
procedural page MARC.php
MARCBASE.php
procedural page MARCBASE.php
MARCXML.php
procedural page MARCXML.php
MAX_RECORD_LENGTH
in file MARC.php, class constant File_MARC::MAX_RECORD_LENGTH
    Maximum record length
top

n

next
in file MARC.php, method File_MARC::next()
    Return next File_MARC_Record object
next
in file MARCXML.php, method File_MARCXML::next()
    Return next File_MARC_Record object
nextRaw
in file MARC.php, method File_MARC::nextRaw()
    Return the next raw MARC record
top

o

$obsoleteCountryCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$obsoleteCountryCodes
    Obsolete Country Codes
$obsoleteGeogAreaCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$obsoleteGeogAreaCodes
    Obsolete Geographic Area Codes
$obsoleteLanguageCodes
in file CodeData.php, variable File_MARC_Lint_CodeData::$obsoleteLanguageCodes
    Obsolete Language Codes
$obsoleteSources600_651
in file CodeData.php, variable File_MARC_Lint_CodeData::$obsoleteSources600_651
    Obsolete sources for fields 600-651
$obsoleteSources655
in file CodeData.php, variable File_MARC_Lint_CodeData::$obsoleteSources655
    Obsolete sources for field 655
top

p

$position
in file Subfield.php, variable File_MARC_Subfield::$position
    Position of the subfield
$position
in file List.php, variable File_MARC_List::$position
    Position of the subfield
parseRules
in file Lint.php, method File_MARC_Lint::parseRules()
    Support method for constructor to load MARC rules.
prependField
in file Record.php, method File_MARC_Record::prependField()
    Prepends field to MARC record
prependNode
in file List.php, method File_MARC_List::prependNode()
    Adds a node to the start of the linked list.
prependSubfield
in file Data_Field.php, method File_MARC_Data_Field::prependSubfield()
    Prepends subfield to subfield list
processRuleGroup
in file Lint.php, method File_MARC_Lint::processRuleGroup()
    Support method for parseRules() -- process one group of lines representing a single tag.
top

r

$record_class
in file MARCBASE.php, variable File_MARCBASE::$record_class
    Record class
$rules
in file Lint.php, variable File_MARC_Lint::$rules
    Rules used for testing records
read.php
procedural page read.php
Record.php
procedural page Record.php
top

s

$source
in file MARC.php, variable File_MARC::$source
    Source containing raw records
$source
in file MARCXML.php, variable File_MARCXML::$source
    Source containing raw records
$sources600_651
in file CodeData.php, variable File_MARC_Lint_CodeData::$sources600_651
    Valid sources for fields 600-651
$sources655
in file CodeData.php, variable File_MARC_Lint_CodeData::$sources655
    Valid sources for field 655
$subfields
in file Data_Field.php, variable File_MARC_Data_Field::$subfields
    Linked list of subfields
subfields.php
procedural page subfields.php
Subfield.php
procedural page Subfield.php
setCode
in file Subfield.php, method File_MARC_Subfield::setCode()
    Sets code of the subfield
setData
in file Subfield.php, method File_MARC_Subfield::setData()
    Sets data of the subfield
setData
in file Control_Field.php, method File_MARC_Control_Field::setData()
    Set control field data
setIndicator
in file Data_Field.php, method File_MARC_Data_Field::setIndicator()
    Set the value of an indicator
setLeader
in file Record.php, method File_MARC_Record::setLeader()
    Set MARC record leader
setLeaderLengths
in file Record.php, method File_MARC_Record::setLeaderLengths()
    Set MARC record leader lengths
setPosition
in file List.php, method File_MARC_List::setPosition()
    Sets position of the subfield
setPosition
in file Subfield.php, method File_MARC_Subfield::setPosition()
    Sets position of the subfield
setTag
in file Field.php, method File_MARC_Field::setTag()
    Sets the tag for this File_MARC_Field object
SOURCE_FILE
in file MARC.php, class constant File_MARC::SOURCE_FILE
    MARC records retrieved from a file
SOURCE_FILE
in file MARCXML.php, class constant File_MARCXML::SOURCE_FILE
    MARC records retrieved from a file
SOURCE_SIMPLEXMLELEMENT
in file MARCXML.php, class constant File_MARCXML::SOURCE_SIMPLEXMLELEMENT
    MARC records retrieved from a SimpleXMLElement object
SOURCE_STRING
in file MARC.php, class constant File_MARC::SOURCE_STRING
    MARC records retrieved from a binary string
SOURCE_STRING
in file MARCXML.php, class constant File_MARCXML::SOURCE_STRING
    MARC records retrieved from a binary string
standardFieldChecks
in file Lint.php, method File_MARC_Lint::standardFieldChecks()
    Check all fields against the standard rules encoded in the class.
SUBFIELD_INDICATOR
in file MARC.php, class constant File_MARC::SUBFIELD_INDICATOR
    Hexadecimal value for Subfield indicator
top

t

$tag
in file Field.php, variable File_MARC_Field::$tag
    The tag name of the Field
$type
in file MARC.php, variable File_MARC::$type
    Source type (SOURCE_FILE or SOURCE_STRING)
$type
in file MARCXML.php, variable File_MARCXML::$type
    Source type (SOURCE_FILE or SOURCE_STRING)
toJSON
in file Record.php, method File_MARC_Record::toJSON()
    Return the MARC record in JSON format
toJSONHash
in file Record.php, method File_MARC_Record::toJSONHash()
    Return the MARC record in Bill Dueber's MARC-HASH JSON format
toRaw
in file Record.php, method File_MARC_Record::toRaw()
    Return the record in raw MARC format.
toRaw
in file Subfield.php, method File_MARC_Subfield::toRaw()
    Return the USMARC representation of the subfield
toRaw
in file Field.php, method File_MARC_Field::toRaw()
    Return field in raw MARC format (stub)
toRaw
in file Control_Field.php, method File_MARC_Control_Field::toRaw()
    Return as raw MARC
toRaw
in file Data_Field.php, method File_MARC_Data_Field::toRaw()
    Return Field in Raw MARC
toXML
in file Record.php, method File_MARC_Record::toXML()
    Return the MARC record in MARCXML format
toXMLFooter
in file MARCBASE.php, method File_MARCBASE::toXMLFooter()
    Returns the MARCXML collection footer
toXMLHeader
in file MARCBASE.php, method File_MARCBASE::toXMLHeader()
    Initializes the MARCXML output of a record or collection of records
top

v

$validateIspn
in file Lint.php, variable File_MARC_Lint::$validateIspn
    A Validate_ISPN object for validating ISBN numbers
top

w

$warnings
in file Lint.php, variable File_MARC_Lint::$warnings
    Warnings generated during analysis
$warnings
in file Record.php, variable File_MARC_Record::$warnings
    Non-fatal warnings generated during parsing
warn
in file Lint.php, method File_MARC_Lint::warn()
    Add a warning.
top

x

$xmlwriter
in file MARCXML.php, variable File_MARCXML::$xmlwriter
    XMLWriter for writing collections
$xmlwriter
in file MARCBASE.php, variable File_MARCBASE::$xmlwriter
    XMLWriter for writing collections
$xmlwriter
in file MARC.php, variable File_MARC::$xmlwriter
    XMLWriter for writing collections
top

Documentation generated on Wed, 13 Nov 2019 12:37:07 -0500 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.