Niouzes

< Novembre 2021 >
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          

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.

2020-01-18 à 01:24:43

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) (18/01/2020)
  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)

LSXml.functions.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 01-04-2015 16:19:56 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!

The download page of Vae Soli! contains all sources of the framework.

Additional samples are available on the samples page of Vae Soli!.

File Properties

C:\websites\vaesoli.org\www\httpdocs/vaesoli/include/LSXml.functions.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSXml.functions.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include7869 bytes03/08/2013 23:27:5326/09/2013 16:46:5603/08/2013 23:27:53

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

0001 ... <?php
0002 ... /**************************************************************************/
0003 ... /** {{{*fheader
0004 ...     {*file                  LSXml.functions.php *}
0005 ...     {*purpose               XML oriented functions *}
0006 ...     {*author                 *}
0007 ...     {*company               Lato Sensu Management[br]
0008 ...                             Rue Bois des Mazuis, 47[br]
0009 ...                             5070 Vitrival[br]
0010 ...                             Belgium (BE)[br]
0011 ...                             http://www.latosensu.be[br]
0012 ...                             Vae Soli! : http://www.vaesoli.org *}
0013 ...     {*cdate                 25/08/2009 - 16:29 *}
0014 ...     {*mdate                 auto *}
0015 ...     {*license               [url]http://creativecommons.org/licenses/by-sa/2.0/be/[/url][br]
0016 ... 
0017 ...                             To obtain detailed information about the license
0018 ...                             terms, please head to the full license text
0019 ...                             available in the [file]LSCopyright.php[/file] file *}
0020 ... 
0021 ...     ------------------------------------------------------------------------
0022 ...     Changes History:
0023 ...     ------------------------------------------------------------------------
0024 ... 
0025 ...     {*chist
0026 ...         {*mdate 25/08/2008 *}
0027 ...         {*v 2.1.0002 *}
0028 ...         {*desc              All comments before this release have been
0029 ...                             eliminated (for tracking purposes, please
0030 ...                             head to the Vae Soli! archive : vaesoli-1.1.0501.zip *}
0031 ...     *}
0032 ... 
0033 ...     {*chist
0034 ...         {*mdate 22/01/2013 *}
0035 ...         {*v 5.0.0012 *}
0036 ...         {*desc              1)  Documenting according to guide.php
0037 ...         *}
0038 ...     *}
0039 ... 
0040 ...     *}}} */
0041 ... /**************************************************************************/
0042 ... if ( ! defined( 'VAESOLI_PATH' ) )                                  /* If the path is not defined yet */
0043 ... {
0044 ...     /* {*define (VAESOLI_PATH)  Define the path where Vae Soli! is installed *} */
0045 ...     define( 'VAESOLI_PATH',__DIR__ );
0046 ... }   /* if ( ! defined( 'VAESOLI_PATH' ) ) */
0047 ... 
0048 ... if ( ! defined( 'VAESOLI_PLUGINS' ) )                               /* If the path is not defined yet */
0049 ... {
0050 ...     /* {*define (VAESOLI_PLUGINS)  Define the path where plugins are located *} */
0051 ...     define( 'VAESOLI_PLUGINS',VAESOLI_PATH . '/../plugins' );
0052 ... }   /* if ( ! defined( 'VAESOLI_PLUGINS' ) ) */
0053 ... 
0054 ... /* ====================================================================== */
0055 ... /** {{*XML_GetTags( $oXPath,$oNode,$aTags,$aValues )=
0056 ... 
0057 ...     Get a collection of tags
0058 ... 
0059 ...     {*params
0060 ...         $oXPath     (DOMXPath)          XPath object
0061 ...         $oNode      (DOMNode)           DOMNode object
0062 ...         $aTags      (array)             Array of tags to be retrieved
0063 ...         $aValues    (array)             Resulting array of values (by ref: updated upon return).
0064 ...     *}
0065 ... 
0066 ...     {*cdate
0067 ...         25/08/2008
0068 ...     *}
0069 ... 
0070 ...     {*version
0071 ...         2.1.0002
0072 ...     *}
0073 ... 
0074 ...     {*return
0075 ...         (bool)  [c]true[/c] if successful; [c]false[/c] if not
0076 ...     *}
0077 ... 
0078 ...     {*example
0079 ...         UNDEFINED
0080 ...     *}
0081 ... 
0082 ...     {*seealso
0083 ...         XML_SetTags()
0084 ...     *}
0085 ... 
0086 ...     *}}
0087 ...  */
0088 ... /* ====================================================================== */
0089 ... function XML_GetTags( $oXPath,$oNode,$aTags,&$aValues )
0090 ... /*---------------------------------------------------*/
0091 ... {
0092 ...     $bRetVal = false;
0093 ... 
0094 ...     /* Make sure that we have a proper instance of an XPath and DOMNode */
0095 ...     if ( ( $oXPath instanceof DOMXPath ) && ( $oNode instanceof DOMNode ) )
0096 ...     {
0097 ...         if ( is_array( $aTags ) && is_array( $aValues ) )
0098 ...         {
0099 ...             foreach ( $aTags as $szTag )
0100 ...             {
0101 ...                 $oResult = $oXPath->query( $szTag,$oNode );
0102 ...                 if ( $oResult->length > 0 )
0103 ...                 {
0104 ...                     $aValues[] = $oResult->item(0)->nodeValue;
0105 ...                 }
0106 ...                 else
0107 ...                 {
0108 ...                     $aValues[] = null;
0109 ...                 }
0110 ...             }
0111 ... 
0112 ...             $bRetVal = true;
0113 ...         }
0114 ...     }
0115 ... 
0116 ...     return ( $bRetVal );
0117 ... }   /* End of function XML_GetTags() */
0118 ... /* ====================================================================== */
0119 ... 
0120 ... /* ====================================================================== */
0121 ... /** {{*XML_SetTags( $oXPath,$oNode,$aTags,$aValues )=
0122 ... 
0123 ...     Updates a collection of tags
0124 ... 
0125 ...     {*params
0126 ...         $oXPath     (DOMXPath)          XPath object
0127 ...         $oNode      (DOMNode)           DOMNode object
0128 ...         $aTags      (array)             Array of tags to be updated
0129 ...         $aValues    (array)             Array of values to be used to set $aTags
0130 ...                                         ($aValues must correspond to $aTags)
0131 ...     *}
0132 ... 
0133 ...     {*cdate
0134 ...         25/08/2008
0135 ...     *}
0136 ... 
0137 ...     {*version
0138 ...         2.1.0002
0139 ...     *}
0140 ... 
0141 ...     {*return
0142 ...         (bool)  [c]true[/c] if successful; [c]false[/c] if not
0143 ...     *}
0144 ... 
0145 ...     {*example
0146 ...         UNDEFINED
0147 ...     *}
0148 ... 
0149 ...     {*seealso
0150 ...         XML_GetTags()
0151 ...     *}
0152 ... 
0153 ...     *}}
0154 ...  */
0155 ... /* ====================================================================== */
0156 ... function XML_SetTags( $oXPath,$oNode,$aTags,&$aValues )
0157 ... /*---------------------------------------------------*/
0158 ... {
0159 ...     $bRetVal = false;
0160 ... 
0161 ...     /* Make sure that we have a proper instance of an XPath and DOMNode */
0162 ...     if ( ( $oXPath instanceof DOMXPath ) && ( $oNode instanceof DOMNode ) )
0163 ...     {
0164 ...         /* Make sure we have received two arrays and that they have the same number of cells */
0165 ...         if ( ( is_array( $aTags ) && is_array( $aValues ) ) && ( count( $aTags ) == count( $aValues ) ) )
0166 ...         {
0167 ...             $i = 0;
0168 ...             $oDom = $oNode->ownerDocument;                          /* The DOM document is needed in the case we need to add a CDATA section */
0169 ... 
0170 ...             foreach ( $aTags as $szTag )                            /* For each tag of the array */
0171 ...             {
0172 ...                 $oResult = $oXPath->query( $szTag,$oNode );         /* Find the tag ? */
0173 ... 
0174 ...                 if ( $oResult->length > 0 )                         /* If tag found in the XML */
0175 ...                 {
0176 ...                     /* If CDATA section found in the value to set */
0177 ...                     if ( preg_match( '/<!\[CDATA\[(.*?)]]>/si',$aValues[$i],$aMatches ) )
0178 ...                     {
0179 ...                         $szValue = $aMatches[1];                    /* Extract the inner value of the CDATA section */
0180 ...                         $oResult->item(0)->nodeValue = '';          /* Reset the node (maybe a CDATA was already present) */
0181 ...                         $oCData  = $oDom->createCDATASection( $szValue ); /* Add a new CDATA with the proper value */
0182 ...                         $oResult->item(0)->appendChild( $oCData );  /* Append the CDATA section to the node */
0183 ...                     }   /* if ( preg_match( '/<!\[CDATA\[(.*?)]]>/si',$aValues[$i],$aMatches ) ) */
0184 ...                     else   /* Else of ... if ( preg_match( '/<!\[CDATA\[(.*?)]]>/si',$aValues[$i],$aMatches ) ) */
0185 ...                     {
0186 ...                         $oResult->item(0)->nodeValue = $aValues[$i];
0187 ...                     }   /* End of ... Else of ... if ( preg_match( '/<!\[CDATA\[(.*?)]]>/si',$aValues[$i],$aMatches ) ) */
0188 ...                 }
0189 ...                 else
0190 ...                 {
0191 ...                     /* We don't do anything here ... but we may wonder why NOT
0192 ...                        ADDING the tag (but where?) */
0193 ...                 }
0194 ... 
0195 ...                 $i++;                                               /* Next value */
0196 ...             }   /* foreach ( $aTags as $szTag ) */                  /* For each tag */
0197 ... 
0198 ...             $bRetVal = true;
0199 ...         }   /* if ( ( is_array( $aTags ) && is_array( $aValues ) ) && ( count( $aTags ) == count( $aValues ) ) ) */
0200 ...     }   /* if ( ( $oXPath instanceof DOMXPath ) && ( $oNode instanceof DOMNode ) ) */
0201 ... 
0202 ...     return ( $bRetVal );
0203 ... }   /* End of function XML_SetTags() */
0204 ... /* ====================================================================== */
0205 ... ?>
0206 ... 

Manifest Constants

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

UltraEdit Syntax files

  1. UltraEdit keywords of LSXml.functions.php
  2. UltraEdit Syntax of LSXml.functions.php

Function List (TOC)

  1. XML_GetTags(): Get a collection of tags No assertion found for XML_GetTags() (0 - 0)
  2. XML_SetTags(): Updates a collection of tags No assertion found for XML_SetTags() (0 - 0)

Functions of LSXml.functions.php

XML_GetTags(): Get a collection of tags

[ back to function list ]

Created: 25/08/2008

Since version 2.1.0002

Syntax

XML_GetTags( $oXPath,$oNode,$aTags,$aValues )

Parameters
NameTypeDescription
$oXPath DOMXPath XPath object
$oNode DOMNode DOMNode object
$aTags array Array of tags to be retrieved
$aValues array Resulting array of values (by ref: updated upon return).
Parameters Warning

XML_GetTags() uses 4 parameters whereas the suggested limit is 3.

Return

(bool) true if successful; false if not

Example(s)
UNDEFINED
Unit Testing

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

See Also

XML_SetTags()

XML_SetTags(): Updates a collection of tags

[ back to function list ]

Created: 25/08/2008

Since version 2.1.0002

Syntax

XML_SetTags( $oXPath,$oNode,$aTags,$aValues )

Parameters
NameTypeDescription
$oXPath DOMXPath XPath object
$oNode DOMNode DOMNode object
$aTags array Array of tags to be updated
$aValues array Array of values to be used to set $aTags ($aValues must correspond to $aTags)
Parameters Warning

XML_SetTags() uses 4 parameters whereas the suggested limit is 3.

Return

(bool) true if successful; false if not

Example(s)
UNDEFINED
Unit Testing

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

See Also

XML_GetTags()

Précédent