Niouzes

< Août 2018 >
Lu Ma Me Je Ve Sa Di
    1 2 3 4 5
6 7 8 9 10 11 12
13 14 15 16 17 18 19
20 21 22 23 24 25 26
27 28 29 30 31    

Citation

Attention

The documentation is incomplete. The Vae Soli! team works hard to make it as exhaustive as possible with tons of useful examples and easy to understand explanations.

On top of that, we have decided to use our own tool to generate the documentation you read. This also takes time to fine-tune. Our goal is have better documentation, easier to read, easier to use, completely integrated with our site.

Even though NOT finalized, you can now link back to our documentation pages as we have decided once and for all about the structure of our documents and where they all reside on our server.

Thank you very much
The Vae Soli! team.

2018-08-20 à 07:03:02

Table Of Contents

  1. FOUNDATION (functions) (01/04/2015)
  2. LSAction (class) (01/04/2015)
  3. LSAddress (class) (01/04/2015)
  4. LSAdministrativeArea (class) (01/04/2015)
  5. LSApplication (class) (14/10/2013)
  6. LSArray (class) (14/10/2013)
  7. LSArticle (class) (18/02/2014)
  8. LSAssertion (class) (14/10/2013)
  9. LSAudience (class) (18/02/2014)
  10. AUTOLOAD (function) (21/04/2014)
  11. LSAutoReference (class) (14/10/2013)
  12. LSBag (class) (14/10/2013)
  13. LSBBCodes (class) (10/06/2014)
  14. LSBrowser (class) (14/10/2013)
  15. LSCache (class) (14/10/2013)
  16. LSCalculator (class) (14/10/2013)
  17. LSCalendar (class) (14/10/2013)
  18. LSCameraSnapshot (class) (14/10/2013)
  19. LSCitation (class) (14/10/2013)
  20. LSClass (class) (14/10/2013)
  21. LSCode (class) ()
  22. Colors (functions) (20/08/2018)
  23. LSContactForm (class) (14/10/2013)
  24. LSContainer (class) (14/10/2013)
  25. LSContents (class) (14/10/2013)
  26. LSContentsAccounts (class) (14/10/2013)
  27. LSContentsArticles (class) (14/10/2013)
  28. LSContentsAtomicClock (class) (14/10/2013)
  29. LSContentsBusinessCoordinates (class) (14/10/2013)
  30. LSContentsBusinessOff (class) (14/10/2013)
  31. LSContentsBusinessOpeningHours (class) (14/10/2013)
  32. LSContentsBreadcrumb (class) (14/10/2013)
  33. LSContentsCalendar (class) (14/10/2013)
  34. LSContentsCatalogue (class) (14/10/2013)
  35. LSContentsCharter (class) (18/02/2014)
  36. LSContentsCitation (class) (14/10/2013)
  37. LSContentsClock (class) (14/10/2013)
  38. LSContentsComments (class) (14/10/2013)
  39. LSContentsCookieUsage (class) (14/10/2013)
  40. LSContentsCountdown (class) (14/10/2013)
  41. LSContentsDatetime (class) (14/10/2013)
  42. LSContentsHeartbeat (class) (14/10/2013)
  43. LSContentsIFrame (class) (14/10/2013)
  44. LSContentsImageGallery (class) (14/10/2013)
  45. LSContentsLanguageSwitchers (class) (14/10/2013)
  46. LSContentsLegal (class) (18/02/2014)
  47. LSContentsMicronews (class) (14/10/2013)
  48. LSContentsMyAccount (class) (14/10/2013)
  49. LSContentsPaymentOptions (class) (14/10/2013)
  50. LSContentsPinboard (class) (14/10/2013)
  51. LSContentsRememberPassword (class) (14/10/2013)
  52. LSContentsRSS (class) (14/10/2013)
  53. LSContentsSiteManager (class) (14/10/2013)
  54. LSContentsSitemap (class) (14/10/2013)
  55. LSContentsShare (class) (14/10/2013)
  56. LSContentsStopwatch (class) (14/10/2013)
  57. LSContentsTagCloud (class) (14/10/2013)
  58. LSContentsTodosOnPage (class) (14/10/2013)
  59. LSContentsW3C (class) (14/10/2013)
  60. LSContentsWeather (class) (14/10/2013)
  61. LSControl (class) (14/10/2013)
  62. LSCreativeWork (class) (18/02/2014)
  63. LSCursor (class) (09/03/2015)
  64. LSCustomer (class) (14/10/2013)
  65. LSDataEnvironment (class) (14/10/2013)
  66. Dates (functions) (01/04/2015)
  67. LSDate (class) (14/10/2013)
  68. LSDictionary (class) (14/10/2013)
  69. LSDom, LSDomNode and LSXPath (class) (30/04/2014)
  70. LSErrors and LSError (classes) (14/10/2013)
  71. LSException (class) (16/10/2013)
  72. LSExplorer (class) (14/10/2013)
  73. LSFieldset (class) (14/10/2013)
  74. LSFile (class) (14/10/2013)
  75. LSFileProperties (class) (14/10/2013)
  76. Files (functions) (01/04/2015)
  77. Finance (functions) (01/04/2015)
  78. LSFootnotes (class) (22/02/2014)
  79. LSForm (class) (09/06/2014)
  80. LSFunction (class) (14/10/2013)
  81. LSGeorama (class) (24/10/2013)
  82. LSGeoramaVar (class) (24/10/2013)
  83. LSGlossary (class) (09/03/2015)
  84. LSGroup (class) (14/10/2013)
  85. HTML (functions) (01/04/2015)
  86. LSHttp (class) (14/10/2013)
  87. HTTP (functions) (01/04/2015)
  88. LSImageGallery (class) (14/10/2013)
  89. Images (functions) (01/04/2015)
  90. LSInput (class) (26/04/2014)
  91. IP (functions) (01/04/2015)
  92. LSIslandAbstract (14/10/2013)
  93. LSIslandFormAbstract (class) (14/10/2013)
  94. LSLabel (class) (14/10/2013)
  95. LSLanguageSwitchers (class) (14/10/2013)
  96. LSLatin (class) (14/10/2013)
  97. LSLegalPerson (class) (14/10/2013)
  98. LSLinkedList (class) (14/10/2013)
  99. LSList (class) (14/10/2013)
  100. Mails (functions) (01/04/2015)
  101. LSMap (class) (14/10/2013)
  102. Math (functions) (01/04/2015)
  103. LSMicronews (class) (18/02/2014)
  104. Miscellaneous (functions) (01/04/2015)
  105. LSModuleAbstract (class) (14/10/2013)
  106. LSNaturalPerson (class) (14/10/2013)
  107. LSNewsArticle (class) (18/02/2014)
  108. LSNote (class) (14/10/2013)
  109. LSMotherNature (class) (16/10/2013)
  110. LSPage (class) (18/02/2014)
  111. LSParameter (class) (14/10/2013)
  112. LSPaymentOptions (class) (14/10/2013)
  113. LSPeopleAudience (class) (18/02/2014)
  114. LSPerson (class) (14/10/2013)
  115. LSPlace (class) (18/02/2014)
  116. LSProperty (class) (14/10/2013)
  117. LSPublication (class) (14/10/2013)
  118. LSRequirement (class) (14/10/2013)
  119. LSReturn (class) (24/10/2013)
  120. LSRisk (class) (14/10/2013)
  121. LSSentanaiAbstract (14/10/2013)
  122. LSServiceMessage (class) (14/10/2013)
  123. LSSession (class) (14/10/2013)
  124. LSSiteManager (class) (14/10/2013)
  125. LSSitemap (class) (14/10/2013)
  126. LSSockets (class) (14/10/2013)
  127. LSSoftwareApplication (class) (18/02/2014)
  128. LSSource (class) (14/10/2013)
  129. Strings (functions) (31/07/2016)
  130. LSSupplier (class) (14/10/2013)
  131. System (functions) (01/04/2015)
  132. LSTag (class) (21/04/2014)
  133. LSTagCloud (class) (14/10/2013)
  134. LSTechArticle (class) (18/02/2014)
  135. LSThing (class) (18/02/2014)
  136. LSTimeline (class) (14/10/2013)
  137. LSTimer (class) (16/10/2013)
  138. LSTracer (class) (09/03/2015)
  139. LSUnitTesting (class) (14/10/2013)
  140. URL (functions) (01/04/2015)
  141. LSUser (class) (09/03/2015)
  142. LSUserMgr (class) (14/10/2013)
  143. LSVaesoli (class) (09/06/2014)
  144. LSVersion (class) (14/10/2013)
  145. LSWebSite (class) (14/10/2013)
  146. LSWidget (class) (14/10/2013)
  147. LSWireTransferForm (class) (14/10/2013)
  148. LSXMLSitemap (class) (14/10/2013)
  149. XML (functions) (01/04/2015)

LSSitemap.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 13:08:46 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!

File Properties

C:\websites\vaesoli.org\www\httpdocs/vaesoli/include/LSSitemap.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSSitemap.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include69067 bytes03/08/2013 23:27:5326/09/2013 16:46:5615/09/2013 16:08:36

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

Early Warning

LSSitemap.class.php exceeds 51200 bytes. We suggest this file got broken down in smaller chunks!

LSSitemap.class.php contains 1273 lines of code, which exceeds the suggested limit of 1024 lines. We suggest this file got broken down in smaller chunks!

Manifest Constants

LSSitemap: Define "LS" Sitemap (Pat Was Here)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSV.functions.php: Framework global functions

LSContents.class.php: High Level Content class

Classes

LSSitemapGenerates an automatic sitemap for a part or whole site

Properties
NameVisibilityTypeDescription
$iCacheTTL public int Time-To-Live of cache in secs
$oGeorama public LSGeorama Georama object for the web site
$oPage public LSPage Page object
$szExclusion public string Set of pages to exclude from the sitemap
$szGroups public string Groups of pages (filter: the page will appear if its group matches $this->szGroups)
$szHeading public string Heading level
$szLayout public string Sitemap layout
$szText public string Text to be included
$szTitle public string Sitemap title
Methods
  1. __construct(): Class constructor
  2. GetPageGroup(): Get the group a page belongs to
  3. GetPageTitle(): Get the title of the page
  4. GroupMatch(): Determines if $szGroup matches the groups that we want to check in the sitemap ($this->szGroups)
  5. OrderByGroup(): Order an array of LSSitemapPage objects by group
  6. OrderByTitle(): Order an array of LSSitemapPage objects by title
  7. Render(): Renders the sitemap
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $oGeorama,$oPage,$szTitle,$szLayout,$szHeading,$szText,$szGroups,$szExclusion,$iCacheTTL )

Parameters
NameTypeDescription
$oGeorama LSGeorama The georama of the whole site
$oPage LSPage The page the sitemap must be inserted in
$szTitle string The title of the sitemap
$szLayout string Layout type (type of display)
$szHeading string The heading tag.

...

by default
$szText string Text that is displayed before the sitemap. null by default
$szGroups string Groups to be satisfied to get inserted in the sitemap. null by default
$szExclusion string Tokenized list of pages that must be specifically excluded from the sitemap. null by default
$iCacheTTL int Optional cache TTL (Time To Live) expressed in seconds. A negative value will deactivate the caching of the sitemap.
Parameters Warning

__construct() uses 9 parameters whereas the suggested limit is 3.

Return

(void)

Example(s)
$this->oSitemap = new LSSitemap( $this->oPage->oApp->oGeorama,
                                 $this->oPage                ,
                                 ''                          ,
                                 $this->szLayout             ,
                                 $this->szHeading            ,
                                 ''                          ,
                                 $this->szGroup              ,
                                 $this->szExclusion );

$this->oSitemap->iCacheTTL = $this->iCacheTTLive;
$this->oSitemap->Render();
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

GetPageGroup(): Get the group a page belongs to

[ back to method list ]

Syntax

GetPageGroup( $oXPath,$oNode )

Parameters
NameTypeDescription
$oXPath LSXPath The XPath object
$oNode DOMNode The georama node of the page
Return

(string) The group the page belongs to

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

GetPageTitle(): Get the title of the page

[ back to method list ]

Syntax

GetPageTitle( $oDom,$oNode,$szDomain,$szLang,$szTargetPage,$szGeoDir )

Parameters
NameTypeDescription
$oDom LSDom The Dom to consider $oXPath (LSXPath) The XPath to consider
$oNode DOMNode The georama node of the page
$szDomain string Current domain that must be served
$szLang string Current language
$szTargetPage string The page to consider (1st token of all IDs)
$szGeoDir string The path of the georama
Parameters Warning

GetPageTitle() uses 6 parameters whereas the suggested limit is 3.

Return

(string) The title of the page

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

GroupMatch(): Determines if $szGroup matches the groups that we want to check in the sitemap ($this->szGroups)

[ back to method list ]

Syntax

GroupMatch( $szGroup )

Parameters
NameTypeDescription
$szGroup string The group of the page
Return

(bool) true if $szGroup matches $this->szGroups

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

OrderByGroup(): Order an array of LSSitemapPage objects by group

[ back to method list ]

Syntax

OrderByGroup( $a,$b )

Parameters
NameTypeDescription
$a LSSitemapPage First object to compare to 2nd object
$b LSSitemapPage 2nd object to compare to 1st object
Return

(int) 0 if group of $a is identical to groupe of $b; -1 if group of $a is ordered before group of $b; 1 if group of $b is ordered before group of $a;

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

OrderByTitle(): Order an array of LSSitemapPage objects by title

[ back to method list ]

Syntax

OrderByTitle( $a,$b )

Parameters
NameTypeDescription
$a LSSitemapPage First object to compare to 2nd object
$b LSSitemapPage 2nd object to compare to 1st object
Return

(int) 0 if title of $a is identical to title of $b; -1 if title of $a is ordered before title of $b; 1 if title of $b is ordered before title of $a;

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Render(): Renders the sitemap

[ back to method list ]

Warning

Only the 'view' mode is supported so far

Syntax

Render( $zMode )

Parameters
NameTypeDescription
$zMode string e Mode in which the sitemap must be rendered. Optional. view by default.
Return

(void)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

LSSitemapPageHolds a page definition that is used by the LSSitemap

Properties
NameVisibilityTypeDescription
$szDesc public string Page description
$szGroup public string Group of pages this page belongs to
$szIDs public string All page IDs
$szTitle public string Page title (<head><title>...</title></head>)
$szURL public string Primary URL of a page (1st ID)
Methods
  1. __construct(): Class constructor
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $szURL,$szIDs,$szGroup,$szTitle,$szDesc )

Parameters
NameTypeDescription
$szURL string Primary URL of the page (1st of all aliases)
$szIDs string All IDs of the page (all aliases)
$szGroup string The group this page belongs to
$szTitle string The title of the page (... )
$szDesc string The description of the page
Parameters Warning

__construct() uses 5 parameters whereas the suggested limit is 3.

Return

(void)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Précédent Suivant