Place for common code for classes used in export_ui classes. More...

Inheritance diagram for MailinglistExportable:

Collaboration diagram for MailinglistExportable:

Public Member Functions
	get_setting ($name, $def=NULL)
	get_settings() More...

MailinglistPolymorphicExportableInterface
	created ()
	created() More...

	edited ($old)
	edited() More...

	changedType (MailinglistPolymorpicExportableInterface $old)
	changedType() More...

	delete ()
	delete() More...

	baseName ()
	baseName() More...

ctools_export_ui_interface
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form() called via mailinglist_export_ui Build an edit form for our object. More...

	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...

	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...

MailinglistPolymorphicExportableInterface

Data Fields
	$object_type
	The type of object we are. More...

	$settings
	Generic Array to hold misc settings so all can use same schema. More...

	$export_type
	Needed by CTools. More...

Logging
const	LOG_OFF = 0

const	LOG_SCREEN = 1

const	LOG_DB = 2

const	LOG_DB_SCREEN = 3

const	LOG_FILE = 4

const	LOG_FILE_SCREEN = 5

const	LOG_DEBUG = WATCHDOG_DEBUG

const	LOG_INFO = WATCHDOG_INFO

const	LOG_NOTICE = WATCHDOG_NOTICE

const	LOG_WARNING = WATCHDOG_WARNING

const	LOG_ERROR = WATCHDOG_ERROR

const	LOG_CRITICAL = WATCHDOG_CRITICAL

const	LOG_ALERT = WATCHDOG_ALERT

const	LOG_EMERGENCY = WATCHDOG_EMERGENCY

	$logging_screen = self::LOG_DEBUG

	$logging_db = self::LOG_INFO

	$logging_file = self::LOG_DEBUG

	log ($str, $level=self::LOG_NOTICE, $parms=array())
	log() More...

	log_screen ($str, $parms=array(), $level=self::LOG_NOTICE)
	log_screen() More...

	log_db ($str, $parms=array(), $level=self::LOG_ERROR)
	log_db(). More...

	log_file ($str, $parms=array(), $level=self::LOG_INFO)
	log_file(). More...

Detailed Description

Place for common code for classes used in export_ui classes.

Main purpose is to make sure all export_ui classes implement the hooks forwarded by the export_ui code

Definition at line 13 of file mailinglist_exportable.class.php.

Member Function Documentation

baseName ( )

baseName()

Returns: string, the base name for hooks, default is the database table name

Definition at line 78 of file mailinglist_exportable.class.php.

Referenced by changedType(), created(), delete(), and edited().

                       {
       return $this->table;
   }

Here is the caller graph for this function:

changedType ( MailinglistPolymorpicExportableInterface $old )

changedType()

hook called when an object has had its object_type changed in the database.

Implements MailinglistPolymorphicExportableInterface.

Definition at line 60 of file mailinglist_exportable.class.php.

References baseName().

                                                                       {
     $ret = module_invoke_all($this->baseName() . '_changed_type', $this, $old);
   }

Here is the call graph for this function:

created ( )

created()

hook called when a new object has been created in the database.

Implements MailinglistPolymorphicExportableInterface.

Definition at line 42 of file mailinglist_exportable.class.php.

References baseName().

                      {
     $ret = module_invoke_all($this->baseName() . '_created', $this);
   }

Here is the call graph for this function:

delete ( )

delete()

hook called when an object is about to be deleted from the database.

Implements MailinglistPolymorphicExportableInterface.

Definition at line 69 of file mailinglist_exportable.class.php.

References baseName().

                     {
     $ret = module_invoke_all($this->baseName() . '_delete', $this);
   }

Here is the call graph for this function:

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form() called via mailinglist_export_ui Build an edit form for our object.

Definition at line 95 of file mailinglist_exportable.class.php.

95 {

96 }

edit_form_submit	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_submit().

called via mailinglist_export_ui

Definition at line 109 of file mailinglist_exportable.class.php.

109 {

110 }

edit_form_validate	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_validate().

called via mailinglist_export_ui

Definition at line 102 of file mailinglist_exportable.class.php.

102 {

103 }

edited ( $old )

edited()

hook called when an object has been updated in the database.

Implements MailinglistPolymorphicExportableInterface.

Definition at line 51 of file mailinglist_exportable.class.php.

References baseName().

                           {
     $ret = module_invoke_all($this->baseName() . '_edited', $this, $old);
   }

Here is the call graph for this function:

get_setting	(	$name,
		$def = `NULL`
	)

get_settings()

Get a settings from the object.

Parameters

$name	The name of the setting.
$def	Default value to return if setting is not present.

Definition at line 26 of file mailinglist_exportable.class.php.

Referenced by MailinglistPhpImapRetrieve\edit_form(), Mailman21List\edit_form(), MailinglistPop3Retrieve\edit_form(), MailinglistMailboxRetrieve\edit_form(), MailinglistRetrieve\edit_form(), MailinglistList\edit_form(), MailinglistList\genericListMatch(), Mailman21List\getMemberInfo(), Mailman21List\getMemberPage(), and Mailman21List\getWebPage().

                                                 {
     if (isset($this->settings[$name])) return $this->settings[$name];
     return $def;
   }

Here is the caller graph for this function:

log	(	$str,
		$level = `self::LOG_NOTICE`,
		$parms = `array()`
	)

log()

Definition at line 144 of file mailinglist_exportable.class.php.

References log_db(), log_file(), and log_screen().

Referenced by MailinglistPop3Retrieve\connect(), MailinglistPop3Retrieve\disconnect(), Mailman21List\getMemberPage(), MailinglistPhpImapRetrieve\purge_message(), MailinglistPop3Retrieve\recv_string(), MailinglistPop3Retrieve\send(), and MailinglistPop3Retrieve\send_cmd().

                                                                        {
     // Note, Value for levels are highest, for lowest priority events
     if ($level <= $this->logging_db) {
       $this->log_db($str, $parms, $level);
     }
     if ($level <= $this->logging_file) {
       $this->log_file($str, $parms, $level);
     }
     if ($level <= $this->logging_screen) {
       $this->log_screen($str, $parms, $level);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

log_db	(	$str,
		$parms = `array()`,
		$level = `self::LOG_ERROR`
	)

log_db().

Log a message to the watchdog Database logs.

Definition at line 189 of file mailinglist_exportable.class.php.

References $object_type.

Referenced by log().

                                                                            {
     $key = $this->object_type;
     if(property_exists($this, 'admin_name')){
       $key .= ' ' . $this->admin_name;
     }
     watchdog($this->object_type, $str, $parms, $level);
   }

Here is the caller graph for this function:

log_file	(	$str,
		$parms = `array()`,
		$level = `self::LOG_INFO`
	)

log_file().

Log a message to a logfile.

Todo:

Definition at line 203 of file mailinglist_exportable.class.php.

Referenced by log().

203 {

204 }

Here is the caller graph for this function:

log_screen	(	$str,
		$parms = `array()`,
		$level = `self::LOG_NOTICE`
	)

log_screen()

log a message to the screen

Todo:: Need to do substitution into $str

Definition at line 167 of file mailinglist_exportable.class.php.

Referenced by log().

                                                                               {
     // This array needs a member for each logging level
     static $levels = array(
       self::LOG_DEBUG => 'status',
       self::LOG_INFO => 'status',
       self::LOG_NOTICE => 'status',
       self::LOG_WARNING => 'warning',
       self::LOG_ERROR => 'error',
       self::LOG_CRITICAL => 'error',
       self::LOG_ALERT => 'error',
       self::LOG_EMERGENCY => 'error',
       );
     dpm(t($str, $parms), $this->object_type, $levels[$level]);
   }