Wiki source code of APIGuide
Version 4.1 by Silvia Macovei on 2010/02/25
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = XWiki API Guide = | ||
| 2 | |||
| 3 | This guide covers the main XWiki APIs. It's not meant to be comprehensive. For that you'll need to check the [[XWiki Reference API page>>API]]. | ||
| 4 | |||
| 5 | {{toc start="" depth="" numbered=""/}} | ||
| 6 | |||
| 7 | == Querying documents == | ||
| 8 | |||
| 9 | See the [[HQL Velocity Examples page>>velocityHqlExamples]]. | ||
| 10 | |||
| 11 | == Getting external content == | ||
| 12 | |||
| 13 | You can use the following APIs to get content located at external URLs: | ||
| 14 | |||
| 15 | {{code language="none"}} | ||
| 16 | public String getURLContent(String surl, String username, String password) throws IOException | ||
| 17 | public String getURLContent(String surl) throws IOException | ||
| 18 | public String getURLContent(String surl, String username, String password, int timeout) throws IOException | ||
| 19 | public String getURLContent(String surl, int timeout) throws IOException | ||
| 20 | public byte[] getURLContentAsBytes(String surl, String username, String password) | ||
| 21 | public byte[] getURLContentAsBytes(String surl) throws IOException | ||
| 22 | {{/code}} | ||
| 23 | |||
| 24 | For example: | ||
| 25 | |||
| 26 | {{code language="none"}}$xwiki.getURLContent("http://google.com"){{/code}} | ||
| 27 | |||
| 28 | == Add objects to a page == | ||
| 29 | |||
| 30 | Here a piece of code to show how is possible to store a new object in one page: | ||
| 31 | |||
| 32 | {{code}} | ||
| 33 | ## Create an object | ||
| 34 | #set($obj = $doc.newObject("XWiki.SomeClass")) | ||
| 35 | $obj.set("field1",$value1) | ||
| 36 | $obj.set("field2",$value2) | ||
| 37 | |||
| 38 | ## Save the object in the page | ||
| 39 | $doc.save() | ||
| 40 | {{/code}} | ||
| 41 | |||
| 42 | The "XWiki.SomeClass" class has to be created (through the class editor): field1 and field2 are property of the class. At the moment, this code works fine only if the user currently logged in has editing rights on the page, otherwise the Document.save() will not work. | ||
| 43 | |||
| 44 | == Access objects in a page == | ||
| 45 | |||
| 46 | Here is a piece of code to show how it is possible to access an object attached to the page, and read its fields : | ||
| 47 | |||
| 48 | {{code}} | ||
| 49 | ## Retrieve the first object (index [0]) among all objects attached to this page and of a certain class | ||
| 50 | #set($obj = $doc.getObject("SomeSpace.SomeClass")) | ||
| 51 | |||
| 52 | ## Retrieve the value of the propertty "field1" for this object, provided a property called "field1" is actually defined in the class of this object | ||
| 53 | #set($field1 = $obj.get("field1")) | ||
| 54 | SomeSpace.SomeClass[0] : field1 = "$field1" | ||
| 55 | {{/code}} | ||
| 56 | |||
| 57 | You can also go through all properties of an object, without knowing their name respective names. That's how the default Class Sheet works, when you create a class using the Class Wizard. | ||
| 58 | |||
| 59 | {{code}} | ||
| 60 | #set($class = $obj.xWikiClass) ## access the class object representing SomeSpace.SomeClass | ||
| 61 | #foreach($prop in $class.properties) ## go through all properties | ||
| 62 | <dt> *${prop.prettyName}* </dt> | ||
| 63 | <dd>$doc.display($prop.getName())</dd> | ||
| 64 | #end | ||
| 65 | {{/code}} | ||
| 66 | |||
| 67 | Actually the line | ||
| 68 | |||
| 69 | {{code}}$doc.display(propertyName){{/code}} can either display the property value, or generate an input field in the page, mapped to the property whose name is passed as argument (when you edit the page in inline mode). If you have a Velocity script you want to include somewhere else, and uses the {{html clean="false" wiki="true"}}<code>display(propertyName)</code> method to access properties of an object attached to the including page, you have to use the <code>includeForm()</code>{{/html}} Velocity macro in the including script : | ||
| 70 | |||
| 71 | {{code}}#includeForm("spacename.docname"){{/code}} | ||
| 72 | |||
| 73 | See [[the reference for the <code>includeForm()</code> macro>>code:Macros.IncludeFormMacro]]. | ||
| 74 | |||
| 75 | == Include a Velocity page into another Velocity page == | ||
| 76 | |||
| 77 | See [[DevGuide.IncludeInVelocity]]. | ||
| 78 | |||
| 79 | == Redirecting to another page == | ||
| 80 | |||
| 81 | It's possible to redirect the user to another page. This is useful for example when a page has been removed and you have given the URL to someone so you want the old page to redirect to the new page. | ||
| 82 | |||
| 83 | Example: | ||
| 84 | |||
| 85 | {{code}}$response.sendRedirect($xwiki.getURL("Space.Page")){{/code}} |
