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

Latest revision as of 00:05, 18 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)
caPageContent::RedirectToDefaultPage() (layout/page/content.php) calls GetAbsolutePath(TRUE)
caWidget
- ::RedirectAfterLogin() calls MakeURLFromString($uri)
- multiple calls to GetAbsolutePath(TRUE)
- Also calls one method that's only in cKiosk_admin.
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 28: / Line 28: @@
 ==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>
+** Also calls one method that's only in {{l/ver/class|cKiosk_admin}}.
-** 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>