[livesupport-dev] storage PHP API documentation
  • Vote Up0Vote Down importimport
    Posts: 0Member
    I'm wondering how it the storage PHP API documented? when I run make doc
    in the main LS directory, I don't get any PHP API documentation generated.

    the reason I'm asking is that I just had a chat with the new young guys
    who are rewaming the Tilos Radio web site, and we were considering using
    our storage system as a back-end. Tilos currently has about 150+ GB of
    online downloadable music, and we've just applied to some funds for a
    RAID array of about 1TB. our searchable metadata-enabled storage system
    could come quite handy here.

    as the rest of the site is also written in PHP, I figured that the best
    way to interface to our storage would be directly through PHP, as our
    HTML UI does as well. but for that, we'd need documentation..
  • 4 Comments sorted by
  • Vote Up0Vote Down importimport
    Posts: 0Member
    It works for me: after running make doxygen, the docs show up both at
    /doc/xml-rpc_doc/html/classes.html and /doc/doxygen/html/classes.html.
    The relevant class is XR_LocStor (and possibly XR_Archive).

    Ferenc


    Ákos Maróy wrote:
    > I'm wondering how it the storage PHP API documented? when I run make doc
    > in the main LS directory, I don't get any PHP API documentation generated.
    >
    > the reason I'm asking is that I just had a chat with the new young guys
    > who are rewaming the Tilos Radio web site, and we were considering using
    > our storage system as a back-end. Tilos currently has about 150+ GB of
    > online downloadable music, and we've just applied to some funds for a
    > RAID array of about 1TB. our searchable metadata-enabled storage system
    > could come quite handy here.
    >
    > as the rest of the site is also written in PHP, I figured that the best
    > way to interface to our storage would be directly through PHP, as our
    > HTML UI does as well. but for that, we'd need documentation..
    >
  • Vote Up0Vote Down importimport
    Posts: 0Member
    Ferenc Gerlits wrote:
    > It works for me: after running make doxygen, the docs show up both at
    > /doc/xml-rpc_doc/html/classes.html and /doc/doxygen/html/classes.html.
    > The relevant class is XR_LocStor (and possibly XR_Archive).

    yes, but that's the XML-RPC API for the PHP code, not the 'native' PHP
    API, that is used by the HTML UI, for example...


    Akos
  • Vote Up0Vote Down importimport
    Posts: 0Member
    The XR_LocStor class is storageServer's XML-RPC API.
    PHP API is here is in GreenBox class, documented here:
    /doc/doxygen/html/classGreenBox.html

    Tomas Hlava
    th@red2head.com

    On Sun, 04 Sep 2005 23:29:55 +0200 Ferenc Gerlits wrote:
    > It works for me: after running make doxygen, the docs show up both at
    > /doc/xml-rpc_doc/html/classes.html and /doc/doxygen/html/classes.html.
    > The relevant class is XR_LocStor (and possibly XR_Archive).
    >
    > Ferenc
    >
    >
    >
  • Vote Up0Vote Down importimport
    Posts: 0Member
    Tomas Hlava wrote:
    > The XR_LocStor class is storageServer's XML-RPC API.
    > PHP API is here is in GreenBox class, documented here:
    > /doc/doxygen/html/classGreenBox.html

    aah, excellent!

    now we just have to make sure that the generated docs is back online..
Add a Comment