Interface Inx_Api_Webpage_Webpage

Description

An Inx_Api_Webpage_Webpage object can be used to access information about a web page.

An Inx_Api_Webpage_Webpage object can be used to access information about a web page. A web page can be a JSP or a FORM or of unknown type and is bound to a server URL. A Webpage object also has a sub type which defines the usage of the web page. A possible sub type is, for example, subscription. The following code snippet prints out the names of all available webpages:

 $oWebpageManager = $oSession->getWebpageManager();
 $oBOResultSet = $oWebpageManager->selectAll();

 for( $i = 0; $i < $oBOResultSet->size(); $i++ )
 {
 	$oWebpage = $oBOResultSet->get( $i );
 	echo 'Page name: ' . $oWebpage->getName() . '<br>';
 }

 $oBOResultSet->close();

  • author: chge, 06.03.2012
  • version: $Revision: 9482 $ $Date: 2007-12-18 16:42:11 +0200 (An, 18 Grd 2007) $ $Author: vladas $
  • see: Inx_Api_Webpage_WebpageManager
  • since: API 1.9.0

Located in /Api/Webpage/Webpage.php (line 30)

Inx_Api_BusinessObject
   |
   --Inx_Api_Webpage_Webpage
Class Constant Summary
Method Summary
string getCreationDate ()
string getName ()
string getServerUrl ()
string getSubType ()
int getType ()
Methods
getCreationDate (line 97)

Returns the creation date of this web page.

Returns the creation date of this web page. The date will be returned as ISO 8601 formatted datetime string.

  • return: the creation date.
  • access: public
string getCreationDate ()
getName (line 59)

Returns the name of this web page.

Returns the name of this web page.

  • return: the name.
  • access: public
string getName ()
getServerUrl (line 67)

Returns the server URL this web page is published at.

Returns the server URL this web page is published at.

  • return: the server URL.
  • access: public
string getServerUrl ()
getSubType (line 88)

Returns the sub type of this web page.

Returns the sub type of this web page. A possible value would be subscription.

  • return: the sub type.
  • access: public
string getSubType ()
getType (line 80)

Returns the type of this web page.

Returns the type of this web page. The possible types are:

  • TYPE_FORM: A form (HTML) web page
  • TYPE_JSP: A JSP web page
  • TYPE_UNKNOWN: A web page of unknown type

  • return: the type.
  • access: public
int getType ()

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
TYPE_FORM = 1 (line 44)

Type for form (HTML) webpages.

Type for form (HTML) webpages.

TYPE_JSP = 0 (line 37)

Type for JSP webpages.

Type for JSP webpages.

TYPE_UNKNOWN = 2 (line 51)

Type for webpages of unknown type.

Type for webpages of unknown type.

Documentation generated on Thu, 17 Sep 2015 14:27:34 +0200 by phpDocumentor 1.3.2