Web
[ class tree: Web ] [ index: Web ] [ all elements ]
Packages:
apnscp_esprit
Admin
Aliases
Auth
Backup
Bandwidth
Billing
Common
CRM
Crontab
Demo
DNS
Email
File
Logs
Majordomo
Miscellaneous
Monitor
One-Click
Oneclick
Site
SQL
Statistics
Urchin
User
Version
Web


Files:
web.php

Classes:
Web_Module

Class: Web_Module

Source Location: /web.php

Class Overview

Module_Skeleton
   |
   --Web_Module

Variables

Methods

Class Details

[line 9]


[ Top ]

Class Variables

$mysql =

[line 10]



Tags:

access:  public

Type:   mixed


[ Top ]

$mysql_rpms = array('MySQL-client-community', 'MySQL-devel-community')

[line 15]



Tags:

access:  protected

Type:   mixed


[ Top ]

$one_click_drivers =

[line 12]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pgsql =

[line 11]



Tags:

access:  public

Type:   mixed


[ Top ]

$postgresql_rpms = array('postgresql-libs', 'postgresql-devel')

[line 16]



Tags:

access:  protected

Type:   mixed


[ Top ]

$ruby_rpms = array('ruby', 'ruby-libs', 'ruby-ri', 'ruby-devel', 'ruby-irb', 'ruby-rdoc')

[line 14]



Tags:

access:  protected

Type:   mixed


[ Top ]

$service_cache =

[line 13]



Tags:

access:  protected

Type:   mixed


[ Top ]

$user_srvc_cache =

[line 17]



Tags:

access:  protected

Type:   mixed


[ Top ]


Class Methods

method add_subdomain [line 536]

void add_subdomain( $mHostname, $mDocumentRoot)



Tags:

access:  public


Parameters:

   $mHostname  
   $mDocumentRoot  

[ Top ]

method bind_dav [line 712]

void bind_dav( $mLocation, [ $mProvider = 'dav'])



Tags:

access:  public


Parameters:

   $mLocation  
   $mProvider  

[ Top ]

method bind_dav_backend [line 716]

void bind_dav_backend( $mLocation, $mProvider)



Tags:

access:  public


Parameters:

   $mLocation  
   $mProvider  

[ Top ]

method disable_ruby_on_rails [line 198]

void disable_ruby_on_rails( )

bool disable_ruby_on_rails (void)

Removes Ruby on Rails and Ruby from a site




Tags:

access:  public


[ Top ]

method disable_ruby_on_rails_backend [line 207]

void disable_ruby_on_rails_backend( )

bool disable_ruby_on_rails_backend()

disable_ruby_on_rails




Tags:

access:  public


[ Top ]

method enable_ruby_on_rails [line 102]

void enable_ruby_on_rails( )

bool enable_ruby_on_rails (void)

Installs Ruby, RoR, rake, and rubygems




Tags:

access:  public


[ Top ]

method enable_ruby_on_rails_backend [line 114]

void enable_ruby_on_rails_backend( )

*

bool enable_ruby_on_rails_backend (void) enable_ruby_on_rails




Tags:

access:  public


[ Top ]

method gem_exists [line 273]

bool gem_exists( )

bool gem_exists (void)

Checks to see if /usr/bin/gem exists for use with Ruby




Tags:

access:  public


[ Top ]

method get_frontpage_status [line 651]

bool get_frontpage_status( )

bool get_frontpage_status()



Tags:

access:  public


[ Top ]

method get_gem_description [line 360]

string get_gem_description( string $mGemName)

string get_gem_description (string)

Fetches the description for a gem




Tags:

return:  description of the gem
access:  public


Parameters:

string   $mGemName   gem name

[ Top ]

method get_pear_description [line 512]

string get_pear_description( string $mModule)

string get_pear_description (string)

Fetches the description for a PEAR package




Tags:

return:  description of the package
access:  public


Parameters:

string   $mModule   package name

[ Top ]

method install_cpan_package [line 704]

void install_cpan_package( $mModule)



Tags:

access:  public


Parameters:

   $mModule  

[ Top ]

method install_cpan_package_backend [line 708]

void install_cpan_package_backend( $mModule)



Tags:

access:  public


Parameters:

   $mModule  

[ Top ]

method install_gem [line 331]

string install_gem( string $mGemName)

string install_gem (string)



Tags:

return:  command output
access:  public


Parameters:

string   $mGemName   gem name to install

[ Top ]

method install_gem_backend [line 339]

void install_gem_backend( $mGemName)

string install_gem_backend (string)

install_gem




Tags:

access:  public


Parameters:

   $mGemName  

[ Top ]

method install_pear_package [line 414]

string install_pear_package( string $mModule)

string install_pear_packages (string)



Tags:

return:  command output
access:  public


Parameters:

string   $mModule  

[ Top ]

method install_pear_package_backend [line 422]

void install_pear_package_backend( $mModule)

string install_pear_package_backend (string)

install_pear_package




Tags:

access:  public


Parameters:

   $mModule  

[ Top ]

method list_dav_locations [line 771]

void list_dav_locations( )



Tags:

access:  public


[ Top ]

method list_installed_gems [line 282]

array list_installed_gems( )

array list_installed_gems (void)

Returns a list of installed gems for the account




Tags:

return:  name, version
access:  public


[ Top ]

method list_installed_gems_backend [line 289]

void list_installed_gems_backend( )

array list_installed_gems_backend (void)

list_installed_gems




Tags:

access:  public


[ Top ]

method list_installed_pear_packages [line 441]

array list_installed_pear_packages( )

array list_installed_pear_packages (void)



Tags:

return:  hash with values is_local (bool), version (double)
access:  public


[ Top ]

method list_installed_pear_packages_backend [line 449]

void list_installed_pear_packages_backend( )

array list_installed_pear_packages (void)

list_installed_pear_packages




Tags:

access:  public


[ Top ]

method list_remote_gems [line 307]

array list_remote_gems( )

array list_remote_gems (void)

Lists potential installable gems from RubyForge; holds cache for 24 hours




Tags:

return:  key: name, value: array -- versions, description
access:  public


[ Top ]

method list_remote_pear_packages [line 485]

array list_remote_pear_packages( )

array list_remote_pear_packages (void) Queries PEAR for all available PEAR packages, analogous to running pear list-all from the command line.



Tags:

return:  Listing of PEAR modules with the following indexes: versions, description. :KLUDGE: versions only contains one version number, the most current on PEAR at this time. This index is kept for consistency with the "Package Manager" component of the control panel
access:  public


[ Top ]

method list_subdomains [line 524]

array list_subdomains( )

array list_subdomains ()



Tags:

return:  all subdomains for a domain, index is subdomain, value is path relative to chroot'd domain
access:  public


[ Top ]

method reload [line 700]

void reload( )



Tags:

access:  public


[ Top ]

method remove_subdomain [line 625]

void remove_subdomain( $mHostname)



Tags:

access:  public


Parameters:

   $mHostname  

[ Top ]

method rename_subdomain [line 632]

void rename_subdomain( $mSrc, $mDest, $mDestFS)



Tags:

access:  public


Parameters:

   $mSrc  
   $mDest  
   $mDestFS  

[ Top ]

method ruby_exists [line 264]

bool ruby_exists( )

bool ruby_exists (void)

Checks to see if /usr/bin/ruby exists for a given domain




Tags:

access:  public


[ Top ]

method ruby_on_rails_enabled [line 89]

bool ruby_on_rails_enabled( )

bool ruby_on_rails_enabled (void)

Checks to see if Ruby on Rails support is enabled for a domain




Tags:

access:  public


[ Top ]

method set_php5_behavior [line 377]

bool set_php5_behavior( string $mMode, [array $mSubdomains = NULL])

bool set_php5_behavior (string[, array]) Sets the PHP5 behavior on scripts for a site. This is merely a frontend for the .htaccess trick (http://apisnetworks.com/resources.php?cid=5&id=11.



Tags:

access:  public


Parameters:

string   $mMode   mode to set where mode is one of the following: all, main, subdomain, ext
array   $mSubdomains   subdomains to which the subdomain option applies

[ Top ]

method set_php5_behavior_backend [line 388]

void set_php5_behavior_backend( $mMode, $mSubdomains)

bool set_php5_behavior_backend (string, array)

set_php5_behavior




Tags:

access:  public


Parameters:

   $mMode  
   $mSubdomains  

[ Top ]

method toggle_frontpage [line 659]

bool toggle_frontpage( )

bool toggle_frontpage



Tags:

access:  public


[ Top ]

method toggle_frontpage_backend [line 668]

bool toggle_frontpage_backend( $mState, [ $mPath = NULL])

bool toggle_frontpage_backend (int)



Tags:

todo:  avoid Ensimized EditVirtDomain call
access:  public


Parameters:

   $mState  
   $mPath  

[ Top ]

method unbind_dav [line 745]

void unbind_dav( $mLocation)



Tags:

access:  public


Parameters:

   $mLocation  

[ Top ]

method unbind_dav_backend [line 749]

void unbind_dav_backend( $mLocation)



Tags:

access:  public


Parameters:

   $mLocation  

[ Top ]

method user_service_enabled [line 216]

void user_service_enabled( string $mUser, string $mSrvc)

bool user_service_enabled(string, string)



Tags:

access:  public


Parameters:

string   $mUser   user
string   $mSrvc   service name possible values subdomain, cgi

[ Top ]

method user_service_enabled_backend [line 227]

void user_service_enabled_backend( $mUser, $mSrvc)

bool user_service_enabled_backend (string, string)

user_service_enabled




Tags:

access:  public


Parameters:

   $mUser  
   $mSrvc  

[ Top ]

Documentation generated on Sat, 05 Jul 2008 04:00:49 -0400 by phpDocumentor 1.4.0