Ferreteria/v0.5/@cls/cKiosk: Difference between revisions

Revision as of 17:12, 17 October 2022

class menu\cKiosk

access	function name	code (if short)	purpose
public	__construct(string $wp)	{ $this->SetPath($wp); }
protected	SetPath(string $wp)	{ $this->wp = ltrim($wp,'/'); }	make it a relative path
public	GetAbsolutePath($doEndSlash) : string
public	GetRelativePath(bool $doEndSlash) : string
public	MakeURLFromString(string $sPath) : string		RETURNS: The full URL for the given input string This format can be overridden if you want the string to be presented some other way, such as in a ?query
public	GetInputString(bool $doEndSlash) : string		RETURNS: The string from which all input arguments may be parsed This format can be overridden if you want to get the string from somewhere else, such as a ?query
public	DumpFull() : string

cDropIndex::RegisterMenuBits() (base/dropin.php) calls GetAbsolutePath(TRUE)
fcDisplayForm::ReadFromPath() (forms/display/display-form.php) calls GetInputObject()
- This is probably obsolete.
caPageContent::RedirectToDefaultPage() (layout/page/content.php) calls GetAbsolutePath(TRUE)
caWidget
- ::Input_PathRequest() calls GetInputObject()->Cell(self::ksACTION_KEY)
- ::RedirectAfterLogin() calls MakeURLFromString($uri)
- multiple calls to GetAbsolutePath(TRUE)
fcHeaderChoiceGroup::GetChoiceValue() calls GetInputObject()
- This is probably obsolete.
cPage::OnFigure() calls GetInputObject(), but then does nothing with it. ???
taForObject::LinkURL() calls GetAbsolutePath(TRUE)

These are global ways of accessing the active Kiosk object:

caAppUser::GetKioskObject() is supposed to be the canonical method to bring up a singleton object of the app-appropriate class.
caDynamicLink::GetAppKiosk() is an alias to F\caApp::Me()->GetKioskObject()

@@ Line 25: / Line 25: @@
 | public || DumpFull() : string
 |}
+==Usage==
+* {{l/ver/class|cDropIndex}}::RegisterMenuBits() ({{l/ferreteria/code|base/dropin.php}}) calls <code>GetAbsolutePath(TRUE)</code>
+* fcDisplayForm::ReadFromPath() ({{l/ferreteria/code|forms/display/display-form.php}}) calls <code>GetInputObject()</code>
+** This is probably obsolete.
+* {{l/ver/class|caPageContent}}::RedirectToDefaultPage() ({{l/ferreteria/code|layout/page/content.php}}) calls <code>GetAbsolutePath(TRUE)</code>
+* {{l/ver/class|caWidget}}
+** ::Input_PathRequest() calls <code>GetInputObject()->Cell(self::ksACTION_KEY)</code>
+** ::RedirectAfterLogin() calls <code>MakeURLFromString($uri)</code>
+** multiple calls to <code>GetAbsolutePath(TRUE)</code>
+* fcHeaderChoiceGroup::GetChoiceValue() calls <code>GetInputObject()</code>
+** This is probably obsolete.
+* {{l/ver/class|cPage}}::OnFigure() calls <code>GetInputObject()</code>, but then does nothing with it. ???
+* {{l/ver/class|taForObject}}::LinkURL() calls <code>GetAbsolutePath(TRUE)</code>
+===access methods===
+These are global ways of accessing the active Kiosk object:
+* {{l/ver/class|caAppUser}}::GetKioskObject() is supposed to be the canonical method to bring up a singleton object of the app-appropriate class.
+* {{l/ver/class|caDynamicLink}}::GetAppKiosk() is an alias to <code>F\caApp::Me()->GetKioskObject()</code>