Interface Inx_Api_Webpage_WebpageManager

Description

An Inx_Api_Webpage_WebpageManager object can be used to retrieve Inx_Api_Webpage_Webpage objects.

An Inx_Api_Webpage_WebpageManager object can be used to retrieve Inx_Api_Webpage_Webpage objects. The web pages can be retrieved by their id, by their type (i.e. JSP, Form), by their sub type (e.g. "subscription") or a combination of type and sub type. The following code snippet prints out the names of all available web pages (JSPs and forms):

 $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();

For more information on web pages, see the Inx_Api_Webpage_Webpage documentation.

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


	
			
Method Summary
Methods
get (line 39)

Returns the web page with the given id.

Returns the web page with the given id.

  • return: The web page specified by the given id.
  • throws: Inx_Api_DataException if the web page has been deleted.
  • access: public
Inx_Api_Webpage_Webpage get (int $iId)
  • int $iId: the id of the web page to be retrieved.
selectAll (line 47)

Returns a BOResultSet containing all webpages.

Returns a BOResultSet containing all webpages.

  • return: a result set containing all webpages.
  • access: public
Inx_Api_BOResultSet selectAll ()
selectAllForms (line 72)

Returns a BOResultSet containing all form (HTML) webpages.

Returns a BOResultSet containing all form (HTML) webpages.

  • return: a result set containing all form (HTML) webpages.
  • access: public
Inx_Api_BOResultSet selectAllForms ()
selectAllJsps (line 64)

Returns a BOResultSet containing all JSP webpages.

Returns a BOResultSet containing all JSP webpages.

  • return: a result set containing all JSP webpages.
  • access: public
Inx_Api_BOResultSet selectAllJsps ()
selectBySubType (line 56)

Returns a BOResultSet containing all webpages with the given sub type.

Returns a BOResultSet containing all webpages with the given sub type.

  • return: a result set containing all webpages with the given sub type.
  • access: public
Inx_Api_BOResultSet selectBySubType (string $sSubType)
  • string $sSubType: the sub type of the web pages to retrieve (e.g. 'subscription').
selectFormsBySubType (line 90)

Returns a BOResultSet containing all form (HTML) webpages with the given sub type.

Returns a BOResultSet containing all form (HTML) webpages with the given sub type.

  • return: a result set containing all form (HTML) webpages with the given sub type.
  • access: public
Inx_Api_BOResultSet selectFormsBySubType (string $sSubType)
  • string $sSubType: the sub type of the web pages to retrieve (e.g. 'subscription').
selectJspsBySubType (line 81)

Returns a BOResultSet containing all JSP webpages with the given sub type.

Returns a BOResultSet containing all JSP webpages with the given sub type.

  • return: a result set containing all JSP webpages with the given sub type.
  • access: public
Inx_Api_BOResultSet selectJspsBySubType (string $sSubType)
  • string $sSubType: the sub type of the web pages to retrieve (e.g. 'subscription').

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