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

From Woozle Writes Code
< Ferreteria‎ | v0.5‎ | @cls
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{fmt/title|class <code>menu\cKiosk</code>}}
{{fmt/title|class <code>menu\cKiosk</code>}}
* '''namespace''': {{l/same|menu}}
* '''namespace''': {{l/same|menu}}
* '''source''': {{l/ferreteria/code|menu/kiosk.php}}
==Methods==
==Methods==
{| class="wikitable sortable"
{| class="wikitable sortable"

Revision as of 21:32, 17 October 2022

class menu\cKiosk

Methods

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

Usage

  • 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)

access methods

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()