CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($webmailadvertisingObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getSessionObj ()
  getWebmailAdvertisingObj ()
  inherit ($varName)
  isInherited ($varName)
  save ()

Member Function Documentation

WebmailAdvertising::__get ( varName  ) 

Get member.

member

description

enableTopBanner

enabled/disabled top Webmail banner

enableRightBanner

enabled/disabled right Webmail banner

enableBottomBanner

enabled/disabled bottom Webmail banner

topBannerContent

the content of the top banner

rightBannerContent

the content of the right banner

bottomBannerContent

the content of the bottom banner

WebmailAdvertising::__set ( varName,
varValue  
)

Set member.

member

description

enableTopBanner

enabled/disabled top Webmail banner

enableRightBanner

enabled/disabled right Webmail banner

enableBottomBanner

enabled/disabled bottom Webmail banner

topBannerContent

the content of the top banner

rightBannerContent

the content of the right banner

bottomBannerContent

the content of the bottom banner

WebmailAdvertising::inherit ( varName  ) 

sets the variable to inherit from the selected source

Returns:
bool
Parameters:
$varName  string the variable
WebmailAdvertising::isInherited ( varName  ) 

Check if the variable is inherited

Returns:
int (1 if the value is inherited, 0 if not, or -1 if this does not apply to the current quota object)
Parameters:
$varName  string the variable
WebmailAdvertising::save (  ) 

this method must be called if one of the members has been changed

Returns:
bool