path: root/doc/latex/classIsisMap.tex

\hypertarget{classIsisMap}{
\section{IsisMap Class Reference}
\label{classIsisMap}\index{IsisMap@{IsisMap}}
}
Inheritance diagram for IsisMap:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5.000000cm]{classIsisMap}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classIsisMap_af689f27e67b0b38a3e880ead17a487f5}{getMainItemName} (\$field)
\item 
\hyperlink{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4}{getSubfieldList} (\$field)
\item 
\hyperlink{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce}{getMap} (\$field, \$subfield=NULL)
\item 
\hyperlink{classIsisMap_a62b933be483fb6704e12e41f10286cd5}{getMapType} (\$field)
\item 
\hyperlink{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409}{fieldHasMap} (\$field)
\item 
\hyperlink{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9}{subfieldHasMap} (\$field, \$subfield)
\item 
\hyperlink{classIsisMap_ae5d904b8407b38751656715fb9efd7cf}{getSubfieldKey} (\$field, \$subfield)
\item 
\hyperlink{classIsisMap_a994934784caa4149737bda55160a459f}{getItemKey} (\$field, \$item)
\item 
\hyperlink{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81}{getFieldKey} (\$field)
\item 
\hyperlink{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{getFieldArray} (\$field\_\-key)
\item 
\hyperlink{classIsisMap_a58d739ea1f014befdafef7035d46c074}{getSubfieldName} (\$field, \$subfield\_\-key, \$by\_\-key=FALSE)
\item 
\hyperlink{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}{getSubfieldNames} (\$field\_\-key)
\item 
\hyperlink{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}{getFieldName} (\$field\_\-key)
\item 
\hyperlink{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}{getFieldNames} ()
\item 
\hyperlink{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{getFullMap} (\$field)
\item 
\hyperlink{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}{getAttributes} (\$field, \$subfield=null)
\item 
\hyperlink{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{getDeniedCombinations} (\$field)
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{classIsisMap_af80aedabfeca623a9022dfcbc95d591c}{methodName} (\$type)
\item 
static \hyperlink{classIsisMap_ae2abf0591a4862f537fa23537ffca705}{normalizeFieldName} (\$name)
\item 
static \hyperlink{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117}{mapName} (\$name)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Provides mappings and schema functionalities around \hyperlink{classCinisis}{Cinisis}. 

\subsection{Member Function Documentation}
\hypertarget{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409}{
\index{IsisMap@{IsisMap}!fieldHasMap@{fieldHasMap}}
\index{fieldHasMap@{fieldHasMap}!IsisMap@{IsisMap}}
\subsubsection[{fieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::fieldHasMap (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409}
Check on an ISIS schema whether a field has a map.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if field has a map, FALSE otherwise. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}{
\index{IsisMap@{IsisMap}!getAttributes@{getAttributes}}
\index{getAttributes@{getAttributes}!IsisMap@{IsisMap}}
\subsubsection[{getAttributes}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getAttributes (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ subfield = {\ttfamily null}}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}
Get attributes based on field and subfield.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data from ISIS database schema.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Attributes. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{
\index{IsisMap@{IsisMap}!getDeniedCombinations@{getDeniedCombinations}}
\index{getDeniedCombinations@{getDeniedCombinations}!IsisMap@{IsisMap}}
\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}
Defines the denied field combinations.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data from ISIS database schema.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Denied field combinations. 
\end{DoxyReturn}


Sample denied combination.

\$sample = array( 0 =$>$ array('a', 'b', 'c'), // a AND b AND c OR 1 =$>$ array('a', 'c', '!d'), // a AND b BUT WITHOUT d OR 2 =$>$ array('a', 'b', '$\ast$'), // a AND b AND any other item OR 3 =$>$ array('$\ast$2'), // ANY two items together OR 4 =$>$ array('main', '$\ast$'), // main AND ANY other item OR );

\hypertarget{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{
\index{IsisMap@{IsisMap}!getFieldArray@{getFieldArray}}
\index{getFieldArray@{getFieldArray}!IsisMap@{IsisMap}}
\subsubsection[{getFieldArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldArray (
\begin{DoxyParamCaption}
\item[{\$}]{ field\_\-key}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_aee1953b6e46b1612c725b2da82414d14}
Get the array which defines a field.


\begin{DoxyParams}{Parameters}
\item[{\em \$field\_\-key}]Field key.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Field array. 
\end{DoxyReturn}
\hypertarget{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81}{
\index{IsisMap@{IsisMap}!getFieldKey@{getFieldKey}}
\index{getFieldKey@{getFieldKey}!IsisMap@{IsisMap}}
\subsubsection[{getFieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldKey (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81}
Get the key of a field entry.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Field key. 
\end{DoxyReturn}
\hypertarget{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}{
\index{IsisMap@{IsisMap}!getFieldName@{getFieldName}}
\index{getFieldName@{getFieldName}!IsisMap@{IsisMap}}
\subsubsection[{getFieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldName (
\begin{DoxyParamCaption}
\item[{\$}]{ field\_\-key}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}
Get a field name.


\begin{DoxyParams}{Parameters}
\item[{\em \$field\_\-key}]Field key.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Field name. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}{
\index{IsisMap@{IsisMap}!getFieldNames@{getFieldNames}}
\index{getFieldNames@{getFieldNames}!IsisMap@{IsisMap}}
\subsubsection[{getFieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldNames (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}
Get all field names.

\begin{DoxyReturn}{Returns}
Array with field names. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{
\index{IsisMap@{IsisMap}!getFullMap@{getFullMap}}
\index{getFullMap@{getFullMap}!IsisMap@{IsisMap}}
\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}
Get the full map.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field key.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with full map or false if there is no map. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a994934784caa4149737bda55160a459f}{
\index{IsisMap@{IsisMap}!getItemKey@{getItemKey}}
\index{getItemKey@{getItemKey}!IsisMap@{IsisMap}}
\subsubsection[{getItemKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getItemKey (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ item}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a994934784caa4149737bda55160a459f}
Get the item key.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\item[{\em \$item}]Item name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Item key. 
\end{DoxyReturn}
\hypertarget{classIsisMap_af689f27e67b0b38a3e880ead17a487f5}{
\index{IsisMap@{IsisMap}!getMainItemName@{getMainItemName}}
\index{getMainItemName@{getMainItemName}!IsisMap@{IsisMap}}
\subsubsection[{getMainItemName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMainItemName (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_af689f27e67b0b38a3e880ead17a487f5}
Get the main field name.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field data from ISIS database schema.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Main field name. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce}{
\index{IsisMap@{IsisMap}!getMap@{getMap}}
\index{getMap@{getMap}!IsisMap@{IsisMap}}
\subsubsection[{getMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMap (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ subfield = {\ttfamily NULL}}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce}
Determine which model field an ISIS db field should be mapped to. When importing an ISIS database to another system, a mapping provided in the database schema can be used to put the originating entries (fields and subfields) in the right place at the destination database.

Map format:

map: type: relation

map: type: value field: dest subfields: a: dest b: dest

Examples:

map: type: Performer

map: type: value field: title subfields: a: subtitle


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A map destination to the field or subfield. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a62b933be483fb6704e12e41f10286cd5}{
\index{IsisMap@{IsisMap}!getMapType@{getMapType}}
\index{getMapType@{getMapType}!IsisMap@{IsisMap}}
\subsubsection[{getMapType}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMapType (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a62b933be483fb6704e12e41f10286cd5}
Get the mapping type of a given field.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The mapping type. 
\end{DoxyReturn}
\hypertarget{classIsisMap_ae5d904b8407b38751656715fb9efd7cf}{
\index{IsisMap@{IsisMap}!getSubfieldKey@{getSubfieldKey}}
\index{getSubfieldKey@{getSubfieldKey}!IsisMap@{IsisMap}}
\subsubsection[{getSubfieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldKey (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ subfield}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_ae5d904b8407b38751656715fb9efd7cf}
Get the key of a subfield entry.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Subfield key. 
\end{DoxyReturn}
\hypertarget{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4}{
\index{IsisMap@{IsisMap}!getSubfieldList@{getSubfieldList}}
\index{getSubfieldList@{getSubfieldList}!IsisMap@{IsisMap}}
\subsubsection[{getSubfieldList}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldList (
\begin{DoxyParamCaption}
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4}
Get the list of subfields from a given field.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array. \end{DoxyParams}
\hypertarget{classIsisMap_a58d739ea1f014befdafef7035d46c074}{
\index{IsisMap@{IsisMap}!getSubfieldName@{getSubfieldName}}
\index{getSubfieldName@{getSubfieldName}!IsisMap@{IsisMap}}
\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ subfield\_\-key, }
\item[{\$}]{ by\_\-key = {\ttfamily FALSE}}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a58d739ea1f014befdafef7035d46c074}
Get a subfield name.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field name or key.\item[{\em \$subfield\_\-key}]Subfield key.\item[{\em \$by\_\-key}]Set to true if you're passing the field key instead of it's name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Subfield name. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}{
\index{IsisMap@{IsisMap}!getSubfieldNames@{getSubfieldNames}}
\index{getSubfieldNames@{getSubfieldNames}!IsisMap@{IsisMap}}
\subsubsection[{getSubfieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldNames (
\begin{DoxyParamCaption}
\item[{\$}]{ field\_\-key}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}
Get all subfield names.


\begin{DoxyParams}{Parameters}
\item[{\em \$field\_\-key}]Field key.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Array with subfield names. 
\end{DoxyReturn}
\hypertarget{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117}{
\index{IsisMap@{IsisMap}!mapName@{mapName}}
\index{mapName@{mapName}!IsisMap@{IsisMap}}
\subsubsection[{mapName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::mapName (
\begin{DoxyParamCaption}
\item[{\$}]{ name}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117}
Build a map name.


\begin{DoxyParams}{Parameters}
\item[{\em \$name}]Field name\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Map name 
\end{DoxyReturn}
\hypertarget{classIsisMap_af80aedabfeca623a9022dfcbc95d591c}{
\index{IsisMap@{IsisMap}!methodName@{methodName}}
\index{methodName@{methodName}!IsisMap@{IsisMap}}
\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::methodName (
\begin{DoxyParamCaption}
\item[{\$}]{ type}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classIsisMap_af80aedabfeca623a9022dfcbc95d591c}
Guess a method name from a type.


\begin{DoxyParams}{Parameters}
\item[{\em \$type}]Mapping type.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Method name. 
\end{DoxyReturn}
\hypertarget{classIsisMap_ae2abf0591a4862f537fa23537ffca705}{
\index{IsisMap@{IsisMap}!normalizeFieldName@{normalizeFieldName}}
\index{normalizeFieldName@{normalizeFieldName}!IsisMap@{IsisMap}}
\subsubsection[{normalizeFieldName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::normalizeFieldName (
\begin{DoxyParamCaption}
\item[{\$}]{ name}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classIsisMap_ae2abf0591a4862f537fa23537ffca705}
Normalize field names.


\begin{DoxyParams}{Parameters}
\item[{\em \$name}]Field name\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Normalized field name 
\end{DoxyReturn}
\hypertarget{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9}{
\index{IsisMap@{IsisMap}!subfieldHasMap@{subfieldHasMap}}
\index{subfieldHasMap@{subfieldHasMap}!IsisMap@{IsisMap}}
\subsubsection[{subfieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::subfieldHasMap (
\begin{DoxyParamCaption}
\item[{\$}]{ field, }
\item[{\$}]{ subfield}
\end{DoxyParamCaption}
)}}
\label{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9}
Check on an ISIS schema whether a subfield has a map.


\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
TRUE if subfield has a map, FALSE otherwise. 
\end{DoxyReturn}


The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
classes/IsisMap.php\end{DoxyCompactItemize}