Urchin
[ class tree: Urchin ] [ index: Urchin ] [ 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:
urchin.php

Classes:
Urchin_Module

Class: Urchin_Module

Source Location: /urchin.php

Class Overview

Module_Skeleton
   |
   --Urchin_Module

Variables

Constants

Methods

Class Details

[line 7]


[ Top ]

Class Variables

$mysql =

[line 8]



Tags:

access:  public

Type:   mixed


[ Top ]

$pgsql =

[line 9]



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

method affiliation_exists [line 81]

void affiliation_exists( )



Tags:

access:  public


[ Top ]

method change_password [line 341]

void change_password( $mValue, [ $mUser = NULL])



Tags:

access:  public


Parameters:

   $mValue  
   $mUser  

[ Top ]

method create_profile [line 107]

void create_profile( $mLog, [ $mDomain = NULL])

create_profile first checks for the affiliation necessary during

the initial profile setup for an account. Following the affiliation check a user check is performed on the primary username. If the user is not found, then the user is created with the default password of "urchin". To avoid the default password, either call create_user prior to invoking create_profile or call change_password following create_profile




Tags:

access:  public


Parameters:

   $mLog  
   $mDomain  

[ Top ]

method create_profile_backend [line 208]

void create_profile_backend( $mProfile, $mLogs)



Tags:

access:  public


Parameters:

   $mProfile  
   $mLogs  

[ Top ]

method create_user [line 51]

void create_user( $mUser, [ $mPassword = "urchin"])



Tags:

access:  public


Parameters:

   $mUser  
   $mPassword  

[ Top ]

method get_max_allowed_profiles [line 89]

void get_max_allowed_profiles( )



Tags:

access:  public


[ Top ]

method get_profiles [line 319]

void get_profiles( )



Tags:

access:  public


[ Top ]

method get_profiles_backend [line 323]

void get_profiles_backend( )



Tags:

access:  public


[ Top ]

method get_profile_count [line 221]

void get_profile_count( )



Tags:

access:  public


[ Top ]

method get_profile_username [line 284]

void get_profile_username( )



Tags:

access:  public


[ Top ]

method get_prune_period [line 294]

int get_prune_period( )

int get_prune_period()

Returns the time, in months, to retain urchin logs




Tags:

access:  public


[ Top ]

method get_urchin_disk_usage [line 258]

int get_urchin_disk_usage( )

int get_urchin_disk_usage() This method counts only those profiles whose gid equals that of the site and thus counted under the quota.



Tags:

return:  total size of all urchin profiles in KB
access:  public


[ Top ]

method get_urchin_disk_usage_backend [line 262]

void get_urchin_disk_usage_backend( )



Tags:

access:  public


[ Top ]

method locate_profile [line 247]

void locate_profile( )



Tags:

access:  public


[ Top ]

method locate_profile_backend [line 236]

mixed locate_profile_backend( )

mixed locate_urchin_profile (void)

Determines the corresponding Urchin URL for the primary profile




Tags:

return:  string if just one path, array if more than one location
access:  public


[ Top ]

method profile_exists [line 198]

void profile_exists( $mProfile)



Tags:

access:  public


Parameters:

   $mProfile  

[ Top ]

method set_prune_period [line 306]

bool set_prune_period( $mPeriod $mPeriod)

bool set_prune_period(int)

Set the time, in months, to retain Urchin profiles Profiles exceeding the threshold will be removed by a cronjob that runs once a month on the beginning of the month




Tags:

return:  action succeeded
access:  public


Parameters:

$mPeriod   $mPeriod   int time to retain, in months (default: 3)

[ Top ]

method set_prune_period_backend [line 312]

void set_prune_period_backend( $mPeriod)



Tags:

access:  public


Parameters:

   $mPeriod  

[ Top ]

method user_is_affiliated [line 70]

void user_is_affiliated( $mUser)



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

Class Constants

MAX_FREE_PROFILES =  2

[line 11]


[ Top ]

URCHIN_BASE =  '/usr/local/'

[line 13]


[ Top ]


Documentation generated on Sat, 11 Oct 2008 04:00:48 -0400 by phpDocumentor 1.4.0