PHP Class SignaturesPlugin, addons

Inheritance: extends Gdn_Plugin

Mostra file Open project: vanilla/addons

Public Properties

Property	Type	Description
$Disabled

Public Methods

Method	Description
assetModel_styleCss_handler ( $Sender )
base_afterCommentBody_handler ( $Sender )	Deprecated in 2.1.
base_render_before ( Gdn_Control $sender, array $args )	Add a custom signature style tag to enforce image height.
checkNumberOfImages ( $Values, &$Sender )	Checks number of images in signature against Plugins.Signatures.MaxNumberImages
checkSignatureLength ( $Values, &$Sender )	Checks signature length against Plugins.Signatures.MaxLength
controller_Modify ( $Sender )	* API METHODS
controller_index ( $Sender )
crossCheckSignature ( $Values, &$Sender )	Checks signature against constraints set in config settings, and executes the external ValidateSignature function, if it exists.
discussionController_afterDiscussionBody_handler ( $Sender )	New call for 2.1.
profileController_afterAddSideMenu_handler ( $Sender )	Add "Signature Settings" to profile edit mode side menu.
profileController_beforeProfileOptions_handler ( $Sender, $Args )	Add "Signature Settings" to Profile Edit button group.
profileController_signature_create ( ProfileController $Sender )	Profile settings
setConfigSettingsToDefault ( string $basename, array $settings )	Why do we need this? (i.e., Mantra for the function) We retrieve the signature restraints from the config settings.
setSignatureRules ( $Sender )
settingsController_signatures_create ( $Sender )
setup ( )
simpleApiPlugin_mapper_handler ( SimpleApiPlugin $Sender )	Add mapper methods
stripFormatting ( )
stripLineBreaks ( string &$Text, string $Delimiter = ' ' )	Strips all line breaks from text
structure ( )

Protected Methods

Method	Description
_stripOnly ( $str, $tags, $stripContent = false )
drawSignature ( $Sender )
hide ( )
signatures ( $Sender, $RequestUserID = NULL, $Default = NULL )
userPreferences ( $SigKey = NULL, $Default = NULL )

Method Details

_stripOnly() protected method

protected _stripOnly ( $str, $tags, $stripContent = false )

assetModel_styleCss_handler() public method

public assetModel_styleCss_handler ( $Sender )

base_afterCommentBody_handler() public method

Deprecated in 2.1.

public base_afterCommentBody_handler ( $Sender )

base_render_before() public method

Add a custom signature style tag to enforce image height.

public base_render_before ( Gdn_Control $sender, array $args )
$sender	Gdn_Control
$args	array

checkNumberOfImages() public method

Checks number of images in signature against Plugins.Signatures.MaxNumberImages

public checkNumberOfImages ( $Values, &$Sender )
$Values		Signature settings form values
$Sender		Controller

checkSignatureLength() public method

Checks signature length against Plugins.Signatures.MaxLength

public checkSignatureLength ( $Values, &$Sender )
$Values		Signature settings form values
$Sender		Controller

controller_Modify() public method

* API METHODS

public controller_Modify ( $Sender )

controller_index() public method

public controller_index ( $Sender )

crossCheckSignature() public method

Checks signature against constraints set in config settings, and executes the external ValidateSignature function, if it exists.

public crossCheckSignature ( $Values, &$Sender )
$Values		Signature settings form values
$Sender		Controller

discussionController_afterDiscussionBody_handler() public method

New call for 2.1.

public discussionController_afterDiscussionBody_handler ( $Sender )

drawSignature() protected method

protected drawSignature ( $Sender )

hide() protected method

protected hide ( )

profileController_afterAddSideMenu_handler() public method

Add "Signature Settings" to profile edit mode side menu.

public profileController_afterAddSideMenu_handler ( $Sender )
$Sender

profileController_beforeProfileOptions_handler() public method

Only do this if they cannot edit profiles because otherwise they can't navigate there.

public profileController_beforeProfileOptions_handler ( $Sender, $Args )
$Sender

profileController_signature_create() public method

Profile settings

public profileController_signature_create ( ProfileController $Sender )
$Sender	ProfileController

setConfigSettingsToDefault() public method

These are sometimes overridden by plugins (i.e., Ranks) If we load the dashboard signature settings form from the config file, we will get whatever session config settings are present, not the default. As such, we've created default config variables that populate the form, but we've got to transfer them over to the config settings in use. Sets config settings to the default settings.

public setConfigSettingsToDefault ( string $basename, array $settings )
$basename	string
$settings	array

setSignatureRules() public method

public setSignatureRules ( $Sender )

settingsController_signatures_create() public method

public settingsController_signatures_create ( $Sender )

setup() public method

public setup ( )

signatures() protected method

protected signatures ( $Sender, $RequestUserID = NULL, $Default = NULL )

simpleApiPlugin_mapper_handler() public method

Add mapper methods

public simpleApiPlugin_mapper_handler ( SimpleApiPlugin $Sender )
$Sender	SimpleApiPlugin

stripFormatting() public method

public stripFormatting ( )

stripLineBreaks() public method

Strips all line breaks from text

public stripLineBreaks ( string &$Text, string $Delimiter = ' ' )
$Text	string
$Delimiter	string

structure() public method

public structure ( )

userPreferences() protected method

protected userPreferences ( $SigKey = NULL, $Default = NULL )

Property Details

$Disabled public_oe property

public $Disabled