Template:Hook:ClientAreaPageActions - Revision history

Andrew at 15:07, 23 July 2015

2015-07-23T15:07:30Z

Andrew at 12:07, 7 July 2015

2015-07-07T12:07:59Z

Andrew at 11:32, 7 July 2015

2015-07-07T11:32:12Z

Andrew at 11:31, 7 July 2015

2015-07-07T11:31:15Z

Andrew: /* {{{hookName|}}} */

2015-07-07T11:30:08Z

‎{{{hookName|}}}

Andrew: /* Example */

2015-07-07T11:14:25Z

‎Example

Andrew: Protected "Template:Hook:ClientAreaPageActions": Page Template ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2015-07-07T11:05:25Z

Protected "Template:Hook:ClientAreaPageActions": Page Template ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Andrew at 11:04, 7 July 2015

2015-07-07T11:04:13Z

Andrew: Created page with "=={{{hookName|}}}== ===Description=== {{Hook_Categories_Vertical| type = Clients}}{{{description|}}} ===Hook Type=== Standard (Glossary#Standard_Hook|What does this mean?..."

2015-07-07T11:02:06Z

Created page with "=={{{hookName|}}}== ===Description=== {{Hook_Categories_Vertical| type = Clients}}{{{description|}}} ===Hook Type=== Standard (Glossary#Standard_Hook|What does this mean?..."

New page

=={{{hookName|}}}==

===Description===
{{Hook_Categories_Vertical| type = Clients}}{{{description|}}}

===Hook Type===
Standard ([[Glossary#Standard_Hook|What does this mean?]])

===Input Parameters===

{| class="wikitable" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;"
|+All the currently defined smarty variables are passed to this hook. Each page has different variables assigned. The below are '''some''' of the fields. This list is not exhaustive.
!style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;"| Variable
!style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;"| Type
!style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;"| Notes
|-
|style="border:1px #AAA solid;padding:0.2em;"|SCRIPT_NAME
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"|The name of the script being loaded
|-
|style="border:1px #AAA solid;padding:0.2em;"|template
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The template name
|-
|style="border:1px #AAA solid;padding:0.2em;"|language
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The language being used.
|-
|style="border:1px #AAA solid;padding:0.2em;"|companyname
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The Company of the installation.
|-
|style="border:1px #AAA solid;padding:0.2em;"|logo
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The logo defined in General Settings
|-
|style="border:1px #AAA solid;padding:0.2em;"|charset
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The system Charset
|-
|style="border:1px #AAA solid;padding:0.2em;"|pagetitle
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The title of the page.
|-
|style="border:1px #AAA solid;padding:0.2em;"|pageicon
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The icon image defined for the page
|-
|style="border:1px #AAA solid;padding:0.2em;"|filename
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The current filename
|-
|style="border:1px #AAA solid;padding:0.2em;"|breadcrumb
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Array|Array]]
|style="border:1px #AAA solid;padding:0.2em;"| An array of breadcrumb information
|-
|style="border:1px #AAA solid;padding:0.2em;"|breadcrumbnav
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The breadcrumb navigation as output
|-
|style="border:1px #AAA solid;padding:0.2em;"|todaysdate
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| Todays date as a string
|-
|style="border:1px #AAA solid;padding:0.2em;"|date_day
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Integer|Integer]]
|style="border:1px #AAA solid;padding:0.2em;"| 2 digit day of the month with leading 0 where appropriate
|-
|style="border:1px #AAA solid;padding:0.2em;"|date_month
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Integer|Integer]]
|style="border:1px #AAA solid;padding:0.2em;"| 2 digit month of the year with leading 0 where appropriate
|-
|style="border:1px #AAA solid;padding:0.2em;"|date_year
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Integer|Integer]]
|style="border:1px #AAA solid;padding:0.2em;"| 4 digit year
|-
|style="border:1px #AAA solid;padding:0.2em;"|systemurl
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The System URL
|-
|style="border:1px #AAA solid;padding:0.2em;"|langchange
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Boolean|Boolean]]
|style="border:1px #AAA solid;padding:0.2em;"| Is language changing enabled?
|-
|style="border:1px #AAA solid;padding:0.2em;"|setlanguage
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| Only if langchange == true. The HTML output of the language dropdown
|-
|style="border:1px #AAA solid;padding:0.2em;"|currencies
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Array|Array]]
|style="border:1px #AAA solid;padding:0.2em;"| An array of defined currencies ordered by "code".
|-
|style="border:1px #AAA solid;padding:0.2em;text-align: left" colspan="3"|start of currencies array
|-
|style="border:1px #AAA solid;padding:0.2em;"|id
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Integer|Integer]]
|style="border:1px #AAA solid;padding:0.2em;"| The currency ID. tblcurrencies.id
|-
|style="border:1px #AAA solid;padding:0.2em;"|code
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| The three character currency code.
|-
|style="border:1px #AAA solid;padding:0.2em;"|default
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#Integer|Integer]]
|style="border:1px #AAA solid;padding:0.2em;"| 1 for yes, 0 for no
|-
|style="border:1px #AAA solid;padding:0.2em;text-align: left" colspan="3"|end of currencies array
|-
|style="border:1px #AAA solid;padding:0.2em;"|twitterusername
|style="border:1px #AAA solid;padding:0.2em;"|[[Glossary#String|String]]
|style="border:1px #AAA solid;padding:0.2em;"| If enabled, the twitter username entered.
|}

===Return Type===
None required.
An array of field => value combinations can be returned if required.

===Example===

<source lang="php">
add_hook('ClientAreaPageAddContact', 1,
function($vars)
{
$return = array("field1" => "value1", "field2" => "value2");
return $return;
}
);
</source>

===Changelog===
{{{history|}}}

__NOTOC__

← Older revision		Revision as of 11:32, 7 July 2015
Line 137:		Line 137:

	__NOTOC__		__NOTOC__
−	~~{{BASEPAGENAME}}~~

← Older revision		Revision as of 11:31, 7 July 2015
Line 137:		Line 137:

	__NOTOC__		__NOTOC__
		+	{{BASEPAGENAME}}

@@ Line 126: / Line 126: @@
      function($vars)
+     {
-         return = array(
+         return array(
              "field1" => "value1",
              "field2" => "value2"

@@ Line 1: / Line 1: @@
 =={{{hookName|}}}==
+__NOEDITSECTION__
 ===Description===
 {{Hook_Categories_Vertical| type = ClientAreaPage}}{{{description|}}}
 ===Hook Type===
 Standard ([[Glossary#Standard_Hook|What does this mean?]])
 ===Input Parameters===
+__NOEDITSECTION__
 {| class="wikitable" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:65%;"
 |+All the currently defined smarty variables are passed to this hook. Each page has different variables assigned. The below are '''some''' of the fields. This list is not exhaustive.
@@ Line 114: / Line 116: @@
 ===Return Type===
 None required.
 An array of field => value combinations can be returned if required.
 ===Example===
+__NOEDITSECTION__
 <source lang="php">
 add_hook('ClientAreaPageAddContact', 1,
@@ Line 130: / Line 133: @@
 ===Changelog===
 {{{history|}}}
 __NOTOC__

← Older revision		Revision as of 11:14, 7 July 2015
Line 121:		Line 121:
	<source lang="php">		<source lang="php">
	add_hook('ClientAreaPageAddContact', 1,		add_hook('ClientAreaPageAddContact', 1,
−	function($vars)	+	function($vars)
−	{	+	{
−	$return = array("field1" => "value1", "field2" => "value2");	+	$return = array("field1" => "value1", "field2" => "value2");
−	return $return;	+	return $return;
−	}	+	}
	);		);
	</source>		</source>

← Older revision	Revision as of 11:05, 7 July 2015
(No difference)