Sophie

Sophie

distrib > PLD > ac > amd64 > media > dist > by-pkgid > dd8ef74e7a184506d40e4328053fb785 > files > 3842

php-manual-ro-20051028-1.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>Hyperwave API Functions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Manual PHP"
HREF="index.html"><LINK
REL="UP"
TITLE="Documentaþia funcþiilor"
HREF="funcref.html"><LINK
REL="PREVIOUS"
TITLE="hw_Who"
HREF="function.hw-who.html"><LINK
REL="NEXT"
TITLE="hw_api_attribute->key"
HREF="function.hwapi-attribute-key.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-2"></HEAD
><BODY
CLASS="reference"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Manual PHP</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.hw-who.html"
ACCESSKEY="P"
>Înapoi</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.hwapi-attribute-key.html"
ACCESSKEY="N"
>Înainte</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="reference"
><A
NAME="ref.hwapi"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
>XL. Hyperwave API Functions</H1
><DIV
CLASS="PARTINTRO"
><A
NAME="AEN35722"
></A
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.intro"
>Introducere</A
></H1
><P
>&#13;     <SPAN
CLASS="productname"
>Hyperwave</SPAN
> has been developed at 
     <A
HREF="http://www.iicm.edu/"
TARGET="_top"
>IICM</A
> in Graz. It started with
     the name <ACRONYM
CLASS="acronym"
>Hyper-G</ACRONYM
> and changed to Hyperwave when
     it was commercialised (in 1996).
    </P
><P
>&#13;     Hyperwave is not free software. The current version, 5.5, is
     available at <A
HREF="http://www.hyperwave.com/"
TARGET="_top"
>http://www.hyperwave.com/</A
>.  
     A time limited version can be ordered for free (30 days).
    </P
><P
>&#13;     See also the <A
HREF="ref.hw.html"
>Hyperwave</A
> module.
    </P
><P
>&#13;     Hyperwave is an information system similar to a database
     (<ACRONYM
CLASS="acronym"
>HIS</ACRONYM
>, Hyperwave Information Server). Its focus
     is the storage and management of documents. A document can be any
     possible piece of data that may as well be stored in file. Each
     document is accompanied by its object record. The object record
     contains meta data for the document. The meta data is a list of
     attributes which can be extended by the user. Certain attributes
     are always set by the Hyperwave server, other may be modified by
     the user.
    </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.requirements"
>Necesitãþi</A
></H1
><P
>&#13;     Since 2001 there is a Hyperwave SDK available. It supports Java,
     JavaScript and C++. This PHP Extension is based on the C++ interface.
     In order to activate the hwapi support in PHP you will have to install
     the Hyperwave SDK first.
    </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.installation"
>Instalare</A
></H1
><P
>&#13;  After installing the Hyperwave SDK, configure PHP with
  <VAR
CLASS="option"
>--with-hwapi[=DIR]</VAR
>.
 </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.apache"
>Integration with Apache</A
></H1
><P
>&#13;     The integration with Apache and possible other servers is already
     described in the <A
HREF="ref.hw.html"
>Hyperwave module</A
>
     which has been the first extension to connect a Hyperwave Server.
    </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.configuration"
>Configurare la rulare</A
></H1
><P
>&#13;The behaviour of these functions is affected by settings in <TT
CLASS="filename"
>php.ini</TT
>.
</P
><P
>&#13; <DIV
CLASS="table"
><A
NAME="AEN35751"
></A
><P
><B
>Tabel 1. Hyperwave API configuration options</B
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><COL><THEAD
><TR
><TH
>Name</TH
><TH
>Default</TH
><TH
>Changeable</TH
></TR
></THEAD
><TBODY
><TR
><TD
>hwapi.allow_persistent</TD
><TD
>"0"</TD
><TD
>PHP_INI_SYSTEM</TD
></TR
></TBODY
></TABLE
></DIV
>
 For further details and definition of the PHP_INI_* constants see
 <A
HREF="function.ini-set.html"
><B
CLASS="function"
>ini_set()</B
></A
>.
 </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.resources"
>Tipuri de resurse</A
></H1
><P
>Aceastã extensie nu defineºte tipuri de resurse.</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.constants"
>Constante predefinite</A
></H1
><P
>Aceastã extensie nu defineºte constante.</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="hwapi.classes"
>Classes</A
></H1
><P
>&#13;     The API provided by the HW_API extension is fully object oriented.
     It is very similar to the C++ interface of the Hyperwave SDK.
     It consist of the following classes.
     <P
></P
><UL
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API</B
>
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API_Object</B
>
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API_Attribute</B
>
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API_Error</B
>
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API_Content</B
>
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>HW_API_Reason</B
>
          </P
></LI
></UL
>
     Some basic classes like <B
CLASS="classname"
>HW_API_String</B
>,
     <B
CLASS="classname"
>HW_API_String_Array</B
>, etc., which exist in the
     Hyperwave SDK have not been implemented since PHP has powerful
     replacements for them.
    </P
><P
>&#13;     Each class has certain method, whose names are identical to its
     counterparts in the Hyperwave SDK. Passing arguments to this function
     differs from all the other PHP extensions but is close to the C++ API of
     the HW SDK. Instead of passing several parameters they are all put into
     an associated array and passed as one parameter. The names of the keys
     are identical to those documented in the HW SDK. The common parameters
     are listed below. If other parameters are required they will be
     documented if needed.
     <P
></P
><UL
><LI
><P
>&#13;        <B
CLASS="classname"
>objectIdentifier</B
> The name or id of an object,
        e.g. "rootcollection", "0x873A8768 0x00000002".
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>parentIdentifier</B
> The name or id of an object
        which is considered to be a parent.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>object</B
> An instance of class HW_API_Object.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>parameters</B
> An instance of class HW_API_Object.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>version</B
> The version of an object.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>mode</B
> An integer value determine the way an
        operation is executed.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>attributeSelector</B
> Any array of strings, each
        containing a name of an attribute. This is used if you retrieve the
        object record and want to include certain attributes.
          </P
></LI
><LI
><P
>&#13;        <B
CLASS="classname"
>objectQuery</B
> A query to select certain object
        out of a list of objects. This is used to reduce the number of objects
        which was delivered by a function like
        <B
CLASS="function"
>hw_api-&#62;children()</B
> or <B
CLASS="function"
>hw_api-&#62;find()</B
>.
          </P
></LI
></UL
>
    </P
></DIV
></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Cuprins</B
></DT
><DT
><A
HREF="function.hwapi-attribute-key.html"
>hw_api_attribute-&#62;key</A
>&nbsp;--&nbsp;Returns key of the attribute</DT
><DT
><A
HREF="function.hwapi-attribute-langdepvalue.html"
>hw_api_attribute-&#62;langdepvalue</A
>&nbsp;--&nbsp;Returns value for a given language</DT
><DT
><A
HREF="function.hwapi-attribute-value.html"
>hw_api_attribute-&#62;value</A
>&nbsp;--&nbsp;Returns value of the attribute</DT
><DT
><A
HREF="function.hwapi-attribute-values.html"
>hw_api_attribute-&#62;values</A
>&nbsp;--&nbsp;Returns all values of the attribute</DT
><DT
><A
HREF="function.hwapi-attribute.html"
>hw_api_attribute</A
>&nbsp;--&nbsp;Creates instance of class hw_api_attribute</DT
><DT
><A
HREF="function.hwapi-checkin.html"
>hw_api-&#62;checkin</A
>&nbsp;--&nbsp;Checks in an object</DT
><DT
><A
HREF="function.hwapi-checkout.html"
>hw_api-&#62;checkout</A
>&nbsp;--&nbsp;Checks out an object</DT
><DT
><A
HREF="function.hwapi-children.html"
>hw_api-&#62;children</A
>&nbsp;--&nbsp;Returns children of an object</DT
><DT
><A
HREF="function.hwapi-content-mimetype.html"
>hw_api_content-&#62;mimetype</A
>&nbsp;--&nbsp;Returns mimetype</DT
><DT
><A
HREF="function.hwapi-content-read.html"
>hw_api_content-&#62;read</A
>&nbsp;--&nbsp;Read content</DT
><DT
><A
HREF="function.hwapi-content.html"
>hw_api-&#62;content</A
>&nbsp;--&nbsp;Returns content of an object</DT
><DT
><A
HREF="function.hwapi-copy.html"
>hw_api-&#62;copy</A
>&nbsp;--&nbsp;Copies physically</DT
><DT
><A
HREF="function.hwapi-dbstat.html"
>hw_api-&#62;dbstat</A
>&nbsp;--&nbsp;Returns statistics about database server</DT
><DT
><A
HREF="function.hwapi-dcstat.html"
>hw_api-&#62;dcstat</A
>&nbsp;--&nbsp;Returns statistics about document cache server</DT
><DT
><A
HREF="function.hwapi-dstanchors.html"
>hw_api-&#62;dstanchors</A
>&nbsp;--&nbsp;Returns a list of all destination anchors</DT
><DT
><A
HREF="function.hwapi-dstofsrcanchors.html"
>hw_api-&#62;dstofsrcanchors</A
>&nbsp;--&nbsp;Returns destination of a source anchor</DT
><DT
><A
HREF="function.hwapi-error-count.html"
>hw_api_error-&#62;count</A
>&nbsp;--&nbsp;Returns number of reasons</DT
><DT
><A
HREF="function.hwapi-error-reason.html"
>hw_api_error-&#62;reason</A
>&nbsp;--&nbsp;Returns reason of error</DT
><DT
><A
HREF="function.hwapi-find.html"
>hw_api-&#62;find</A
>&nbsp;--&nbsp;Search for objects</DT
><DT
><A
HREF="function.hwapi-ftstat.html"
>hw_api-&#62;ftstat</A
>&nbsp;--&nbsp;Returns statistics about fulltext server</DT
><DT
><A
HREF="function.hwapi-hgcsp.html"
>hwapi_hgcsp</A
>&nbsp;--&nbsp;Returns object of class hw_api</DT
><DT
><A
HREF="function.hwapi-hwstat.html"
>hw_api-&#62;hwstat</A
>&nbsp;--&nbsp;Returns statistics about Hyperwave server</DT
><DT
><A
HREF="function.hwapi-identify.html"
>hw_api-&#62;identify</A
>&nbsp;--&nbsp;Log into Hyperwave Server</DT
><DT
><A
HREF="function.hwapi-info.html"
>hw_api-&#62;info</A
>&nbsp;--&nbsp;Returns information about server configuration</DT
><DT
><A
HREF="function.hwapi-insert.html"
>hw_api-&#62;insert</A
>&nbsp;--&nbsp;Inserts a new object</DT
><DT
><A
HREF="function.hwapi-insertanchor.html"
>hw_api-&#62;insertanchor</A
>&nbsp;--&nbsp;Inserts a new object of type anchor</DT
><DT
><A
HREF="function.hwapi-insertcollection.html"
>hw_api-&#62;insertcollection</A
>&nbsp;--&nbsp;Inserts a new object of type collection</DT
><DT
><A
HREF="function.hwapi-insertdocument.html"
>hw_api-&#62;insertdocument</A
>&nbsp;--&nbsp;Inserts a new object of type document</DT
><DT
><A
HREF="function.hwapi-link.html"
>hw_api-&#62;link</A
>&nbsp;--&nbsp;Creates a link to an object</DT
><DT
><A
HREF="function.hwapi-lock.html"
>hw_api-&#62;lock</A
>&nbsp;--&nbsp;Locks an object</DT
><DT
><A
HREF="function.hwapi-move.html"
>hw_api-&#62;move</A
>&nbsp;--&nbsp;Moves object between collections</DT
><DT
><A
HREF="function.hwapi-new-content.html"
>hw_api_content</A
>&nbsp;--&nbsp;Create new instance of class hw_api_content</DT
><DT
><A
HREF="function.hwapi-object-assign.html"
>hw_api_object-&#62;assign</A
>&nbsp;--&nbsp;Clones object</DT
><DT
><A
HREF="function.hwapi-object-attreditable.html"
>hw_api_object-&#62;attreditable</A
>&nbsp;--&nbsp;Checks whether an attribute is editable</DT
><DT
><A
HREF="function.hwapi-object-count.html"
>hw_api_object-&#62;count</A
>&nbsp;--&nbsp;Returns number of attributes</DT
><DT
><A
HREF="function.hwapi-object-insert.html"
>hw_api_object-&#62;insert</A
>&nbsp;--&nbsp;Inserts new attribute</DT
><DT
><A
HREF="function.hwapi-object-new.html"
>hw_api_object</A
>&nbsp;--&nbsp;Creates a new instance of class hw_api_object</DT
><DT
><A
HREF="function.hwapi-object-remove.html"
>hw_api_object-&#62;remove</A
>&nbsp;--&nbsp;Removes attribute</DT
><DT
><A
HREF="function.hwapi-object-title.html"
>hw_api_object-&#62;title</A
>&nbsp;--&nbsp;Returns the title attribute</DT
><DT
><A
HREF="function.hwapi-object-value.html"
>hw_api_object-&#62;value</A
>&nbsp;--&nbsp;Returns value of attribute</DT
><DT
><A
HREF="function.hwapi-object.html"
>hw_api-&#62;object</A
>&nbsp;--&nbsp;Retrieve attribute information</DT
><DT
><A
HREF="function.hwapi-objectbyanchor.html"
>hw_api-&#62;objectbyanchor</A
>&nbsp;--&nbsp;Returns the object an anchor belongs to</DT
><DT
><A
HREF="function.hwapi-parents.html"
>hw_api-&#62;parents</A
>&nbsp;--&nbsp;Returns parents of an object</DT
><DT
><A
HREF="function.hwapi-reason-description.html"
>hw_api_reason-&#62;description</A
>&nbsp;--&nbsp;Returns description of reason</DT
><DT
><A
HREF="function.hwapi-reason-type.html"
>hw_api_reason-&#62;type</A
>&nbsp;--&nbsp;Returns type of reason</DT
><DT
><A
HREF="function.hwapi-remove.html"
>hw_api-&#62;remove</A
>&nbsp;--&nbsp;Delete an object</DT
><DT
><A
HREF="function.hwapi-replace.html"
>hw_api-&#62;replace</A
>&nbsp;--&nbsp;Replaces an object</DT
><DT
><A
HREF="function.hwapi-setcommitedversion.html"
>hw_api-&#62;setcommitedversion</A
>&nbsp;--&nbsp;Commits version other than last version</DT
><DT
><A
HREF="function.hwapi-srcanchors.html"
>hw_api-&#62;srcanchors</A
>&nbsp;--&nbsp;Returns a list of all source anchors</DT
><DT
><A
HREF="function.hwapi-srcsofdst.html"
>hw_api-&#62;srcsofdst</A
>&nbsp;--&nbsp;Returns source of a destination object</DT
><DT
><A
HREF="function.hwapi-unlock.html"
>hw_api-&#62;unlock</A
>&nbsp;--&nbsp;Unlocks a locked object</DT
><DT
><A
HREF="function.hwapi-user.html"
>hw_api-&#62;user</A
>&nbsp;--&nbsp;Returns the own user object</DT
><DT
><A
HREF="function.hwapi-userlist.html"
>hw_api-&#62;userlist</A
>&nbsp;--&nbsp;Returns a list of all logged in users</DT
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.hw-who.html"
ACCESSKEY="P"
>Înapoi</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Acas&#227;</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.hwapi-attribute-key.html"
ACCESSKEY="N"
>Înainte</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>hw_Who</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="funcref.html"
ACCESSKEY="U"
>Sus</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>hw_api_attribute-&#62;key</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>