Changeset 160 for Doc/Backend


Ignore:
Timestamp:
11/18/11 14:02:38 (13 years ago)
Author:
jkraaijeveld
Message:

Updated documentation
Added PHPDoc

Location:
Doc/Backend
Files:
52 added
1 edited

Legend:

Unmodified
Added
Removed

  • Doc/Backend/DBInterface.tex

    r147 r160  
    88\usepackage{float}
    99\usepackage{multirow}
     10\usepackage[final]{pdfpages}
     11\usepackage{hyperref}
    1012\begin{document}
    1113
    … …  
    172174                        \multirow{6}{*}{Session}                & uid                                           & String                                        & \\
    173175                                                                                        & title                                         & String                                        & \\
     176                                                                                        & creator                                       & String                                        & UID of the User \\
    174177                                                                                        & datetime                                      & String                                        & Unix Timestamp. No way to search on intervals (yet). \\
    175178                                                                                        & applications                          & Array of Strings                      & UIDs of the Applications \\
    … …  
    186189                in the array.
    187190                       
    188 
    189 
    190 
    191 
    192191\section{Specification}\label{spec}
    193         //TODO: Generate HTML documentation
     192        \subsection{Models}
     193                The framework heavily relies on the Object Oriented Programming paradigm, and only allows you to create, edit
     194                and store data through instances of precreated classes. All these classes inherit from a global
     195                ResearchToolObject class. A UML class diagram of the model classes can be found in Appendix \ref{models}. 
     196        \subsection{Connectors}
     197                Although the front end developer only uses one general DatabaseInterface, the different files for the different
     198                datatypes are accessed by seperate connectors. A connector has to implement the IConnector interface, which
     199                mainly enforces the get() and set() methods to ensure a connector can perform as expected. In every connector,
     200                the get() and set() methods are different. A get() method builds the querystring based on the given arguments,
     201                then retrieves the data and performs other necessary queries (like retrieving a different object from another
     202                file) to ensure the PHP DataModel is comoplete. A set() method has to store the data accordingly.
     203        \subsection{PHPDoc}     
     204                PHPDoc for the database classes can be found at
     205                \href{http://svn.tbm.tudelft.nl/TBM-CPS/RESEARCHTOOL/Doc/Backend/PHPDoc}{SVN}.
     206
     207               
    194208
    195209\section{Future Work}\label{futurework}
    196210        //TODO
    197211
     212\appendix
     213\pagebreak
     214\section{Class diagram of the models}\label{models}
     215        \begin{figure}
     216                \includepdf[scale=1.22]{DBModels.pdf}
     217        \end{figure}   
    198218
    199219\end{document}
Note: See TracChangeset for help on using the changeset viewer.