admin_core_applications_hooks Class Reference

Inheritance diagram for admin_core_applications_hooks:

Public Member Functions
	_hooksOverview ()
	_updateAvailable ($url, $version)
	checkHookRequirements ($hook)
	doExecute (ipsRegistry $registry)
	installAppHooks ($app)
	installHook ($content, $addMessage=FALSE, $allowSkinRecache=TRUE, $enabled=1)
	rebuildHooksCache ()
Protected Member Functions
	_checkRequirements ()
	_cleanSource ($source)
	_disableAllHooks ()
	_disableHook ()
	_doExportHook ()
	_enableHook ()
	_exportHook ()
	_fixPositions ()
	_hookForm ($type='add')
	_hookSave ($type='add')
	_installHook ()
	_reenableAllHooks ()
	_reorder ()
	_uninstallHook ()
	_viewDetails ()
	reimportAppHooks ()
	removeDeadCaches ()
Protected Attributes
	$cachedVersions = array()
	$hooks
	$hooksFunctions
	$html

---

Member Function Documentation

_checkRequirements

(

)

[protected]

Check if you meet hook requirements

Returns:

void [Outputs to screen]

_cleanSource

(

$

source

)

[protected]

Clean source code for export..

Parameters:

string

Hook source code

Returns:

string "Cleaned" source code

_disableAllHooks

(

)

[protected]

Disables all hook

Returns:

void [Outputs to screen]

_disableHook

(

)

[protected]

Disables a hook

Returns:

void [Outputs to screen]

_doExportHook

(

)

[protected]

Actually export the damn hook already Sorry, it has been a long day...

Returns:

void

_enableHook

(

)

[protected]

Enables a hook

Returns:

void [Outputs to screen]

_exportHook

(

)

[protected]

Show the form to export a hook

Returns:

void

_fixPositions

(

)

[protected]

Fix hook positions

Returns:

void

_hookForm

(

$

type = 'add'

)

[protected]

Hook add/edit form This dynamic form allows users to associate multiple files with a single hook.

Parameters:

string

[add|edit]

Returns:

void [Outputs to screen]

_hookSave

(

$

type = 'add'

)

[protected]

Hook add/edit save Save the new (or updated) hook record

Parameters:

string

[add|edit]

Returns:

void [Outputs to screen]

See Also:

http://community.invisionpower.com/tracker/issue-22084-hook-edit-does-not-preserve-correct-name/ We don't want to reset the stored name if you are not in developer mode

_hooksOverview

(

)

Hooks overview

Returns:

void [Outputs to screen]

_installHook

(

)

[protected]

Install a new hook

Returns:

void

_reenableAllHooks

(

)

[protected]

Re-enable all hook

Returns:

void [Outputs to screen]

_reorder

(

)

[protected]

Reorder hooks

Returns:

void [Outputs to screen]

_uninstallHook

(

)

[protected]

Uninstall a hook

Returns:

void [Outputs to screen]

_updateAvailable	(	$	url,
		$	version
	)

Check if there is an update for a hook

Parameters:

string	URL to check
string	Long version number

Returns:

bool

_viewDetails

(

)

[protected]

View details about a hook

Returns:

void [Outputs to screen]

checkHookRequirements

(

$

hook

)

Check if the hook meets all the requirements

Parameters:

mixed

$hook

Can be an hook ID or an array of the hook data

Returns:

array Errors found

doExecute

(

ipsRegistry $

registry

)

Main class entry point

Parameters:

object

ipsRegistry reference

Returns:

void [Outputs to screen]

Reimplemented from ipsCommand.

installAppHooks

(

$

app

)

Function mostly used in installer/upgrader Inserts new hooks

Parameters:

string

Application to install hooks for

installHook	(	$	content,
		$	addMessage = FALSE,
		$	allowSkinRecache = TRUE,
		$	enabled = 1
	)

Public install hook so we can use it in the installer and elsewhere

Parameters:

string	XML data
boolean	Add message to output->global_message
boolean	Allow skins to recache
int	Install enabled

Returns:

void

rebuildHooksCache

(

)

Rebuild hooks cache

Returns:

void

reimportAppHooks

(

)

[protected]

Reimport all hooks for all installed applications

Returns:

void

removeDeadCaches

(

)

[protected]

Rebuild skins following hook import that included a template

Returns:

void

---

Field Documentation

$cachedVersions = array() [protected]

Array of all the cache versions for the required applications

---

The documentation for this class was generated from the following file:

• admin/applications/core/modules_admin/applications/hooks.php