PageRenderTime 28ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/latex/class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader.tex

https://github.com/niieani/napkin
LaTeX | 173 lines | 142 code | 31 blank | 0 comment | 0 complexity | 83bacf8b89d7f89c6e50a0080d0b3ab0 MD5 | raw file
  1. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader}{
  2. \section{\-Universal\-Class\-Loader \-Class \-Reference}
  3. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader}\index{\-Universal\-Class\-Loader@{\-Universal\-Class\-Loader}}
  4. }
  5. \subsection*{\-Public \-Member \-Functions}
  6. \begin{DoxyCompactItemize}
  7. \item
  8. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_ae4c74dabb3e9ba4103ffd4e8febcac21}{
  9. {\bfseries get\-Namespaces} ()}
  10. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_ae4c74dabb3e9ba4103ffd4e8febcac21}
  11. \item
  12. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a102069675f7a94f8917f44acc2390687}{
  13. {\bfseries get\-Prefixes} ()}
  14. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a102069675f7a94f8917f44acc2390687}
  15. \item
  16. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afd147d473364c7df6b9b327bae802b82}{register\-Namespaces} (array \$namespaces)
  17. \item
  18. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afdd997b01513fe834e92dd511ed52c0e}{register\-Namespace} (\$namespace, \$path)
  19. \item
  20. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_aac41bbf07ccda9fe0a47842e5f40cbaa}{register\-Prefixes} (array \$classes)
  21. \item
  22. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a0aa6735ce44d92ea33f6906ce3b14425}{register\-Prefix} (\$prefix, \$path)
  23. \item
  24. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_acc294a6cc8e69743746820e3d15e3f78}{register} ()
  25. \item
  26. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a8326a997d0cfe76d80196f60d240d144}{load\-Class} (\$class)
  27. \end{DoxyCompactItemize}
  28. \subsection*{\-Protected \-Attributes}
  29. \begin{DoxyCompactItemize}
  30. \item
  31. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a5a7d9500de9f7c938443d65cef9a074e}{
  32. {\bfseries \$namespaces} = array()}
  33. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a5a7d9500de9f7c938443d65cef9a074e}
  34. \item
  35. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a8dd2685d77e3731afd50eaa21c4f2055}{
  36. {\bfseries \$prefixes} = array()}
  37. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a8dd2685d77e3731afd50eaa21c4f2055}
  38. \end{DoxyCompactItemize}
  39. \subsection{\-Detailed \-Description}
  40. \hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader}{\-Universal\-Class\-Loader} implements a \char`\"{}universal\char`\"{} autoloader for \-P\-H\-P 5.\-3.
  41. \-It is able to load classes that use either\-:
  42. $\ast$ \-The technical interoperability standards for \-P\-H\-P 5.\-3 namespaces and class names (\href{http://groups.google.com/group/php-standards/web/psr-0-final-proposal}{\tt http\-://groups.\-google.\-com/group/php-\/standards/web/psr-\/0-\/final-\/proposal});
  43. $\ast$ \-The \hyperlink{namespace_p_e_a_r}{\-P\-E\-A\-R} naming convention for classes (\href{http://pear.php.net/}{\tt http\-://pear.\-php.\-net/}).
  44. \-Classes from a sub-\/namespace or a sub-\/hierarchy of \hyperlink{namespace_p_e_a_r}{\-P\-E\-A\-R} classes can be looked for in a list of locations to ease the vendoring of a sub-\/set of classes for large projects.
  45. \-Example usage\-:
  46. \$loader = new \-Universal\-Class\-Loader();
  47. // register classes with namespaces \$loader-\/$>$register\-Namespaces(array( '\-Symfony' =$>$ \-\_\-\-\_\-\-D\-I\-R\-\_\-\-\_\-.'/component', '\-Symfony' =$>$ \-\_\-\-\_\-\-D\-I\-R\-\_\-\-\_\-.'/framework', ));
  48. // register a library using the \hyperlink{namespace_p_e_a_r}{\-P\-E\-A\-R} naming convention \$loader-\/$>$register\-Prefixes(array( '\-Swift\-\_\-' =$>$ \-\_\-\-\_\-\-D\-I\-R\-\_\-\-\_\-.'/\-Swift', ));
  49. // activate the autoloader \$loader-\/$>$\hyperlink{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_acc294a6cc8e69743746820e3d15e3f78}{register()};
  50. \-In this example, if you try to use a class in the \-Symfony namespace or one of its children (\-Symfony for instance), the autoloader will first look for the class under the component/ directory, and it will then fallback to the framework/ directory if not found before giving up.
  51. \begin{DoxyAuthor}{\-Author}
  52. \-Fabien \-Potencier $<$\href{mailto:fabien.potencier@symfony-project.org}{\tt fabien.\-potencier@symfony-\/project.\-org}$>$
  53. \end{DoxyAuthor}
  54. \subsection{\-Member \-Function \-Documentation}
  55. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a8326a997d0cfe76d80196f60d240d144}{
  56. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!load\-Class@{load\-Class}}
  57. \index{load\-Class@{load\-Class}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  58. \subsubsection[{load\-Class}]{\setlength{\rightskip}{0pt plus 5cm}load\-Class (
  59. \begin{DoxyParamCaption}
  60. \item[{\$}]{class}
  61. \end{DoxyParamCaption}
  62. )}}
  63. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a8326a997d0cfe76d80196f60d240d144}
  64. \-Loads the given class or interface.
  65. \begin{DoxyParams}[1]{\-Parameters}
  66. string & {\em \$class} & \-The name of the class \\
  67. \hline
  68. \end{DoxyParams}
  69. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_acc294a6cc8e69743746820e3d15e3f78}{
  70. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!register@{register}}
  71. \index{register@{register}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  72. \subsubsection[{register}]{\setlength{\rightskip}{0pt plus 5cm}register (
  73. \begin{DoxyParamCaption}
  74. {}
  75. \end{DoxyParamCaption}
  76. )}}
  77. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_acc294a6cc8e69743746820e3d15e3f78}
  78. \-Registers this instance as an autoloader. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afdd997b01513fe834e92dd511ed52c0e}{
  79. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!register\-Namespace@{register\-Namespace}}
  80. \index{register\-Namespace@{register\-Namespace}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  81. \subsubsection[{register\-Namespace}]{\setlength{\rightskip}{0pt plus 5cm}register\-Namespace (
  82. \begin{DoxyParamCaption}
  83. \item[{\$}]{namespace, }
  84. \item[{\$}]{path}
  85. \end{DoxyParamCaption}
  86. )}}
  87. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afdd997b01513fe834e92dd511ed52c0e}
  88. \-Registers a namespace.
  89. \begin{DoxyParams}[1]{\-Parameters}
  90. string & {\em \$namespace} & \-The namespace \\
  91. \hline
  92. string & {\em \$path} & \-The location of the namespace \\
  93. \hline
  94. \end{DoxyParams}
  95. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afd147d473364c7df6b9b327bae802b82}{
  96. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!register\-Namespaces@{register\-Namespaces}}
  97. \index{register\-Namespaces@{register\-Namespaces}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  98. \subsubsection[{register\-Namespaces}]{\setlength{\rightskip}{0pt plus 5cm}register\-Namespaces (
  99. \begin{DoxyParamCaption}
  100. \item[{array \$}]{namespaces}
  101. \end{DoxyParamCaption}
  102. )}}
  103. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_afd147d473364c7df6b9b327bae802b82}
  104. \-Registers an array of namespaces
  105. \begin{DoxyParams}[1]{\-Parameters}
  106. array & {\em \$namespaces} & \-An array of namespaces (namespaces as keys and locations as values) \\
  107. \hline
  108. \end{DoxyParams}
  109. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a0aa6735ce44d92ea33f6906ce3b14425}{
  110. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!register\-Prefix@{register\-Prefix}}
  111. \index{register\-Prefix@{register\-Prefix}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  112. \subsubsection[{register\-Prefix}]{\setlength{\rightskip}{0pt plus 5cm}register\-Prefix (
  113. \begin{DoxyParamCaption}
  114. \item[{\$}]{prefix, }
  115. \item[{\$}]{path}
  116. \end{DoxyParamCaption}
  117. )}}
  118. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_a0aa6735ce44d92ea33f6906ce3b14425}
  119. \-Registers a set of classes using the \hyperlink{namespace_p_e_a_r}{\-P\-E\-A\-R} naming convention.
  120. \begin{DoxyParams}[1]{\-Parameters}
  121. string & {\em \$prefix} & \-The classes prefix \\
  122. \hline
  123. string & {\em \$path} & \-The location of the classes \\
  124. \hline
  125. \end{DoxyParams}
  126. \hypertarget{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_aac41bbf07ccda9fe0a47842e5f40cbaa}{
  127. \index{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}!register\-Prefixes@{register\-Prefixes}}
  128. \index{register\-Prefixes@{register\-Prefixes}!Symfony::Component::HttpFoundation::UniversalClassLoader@{\-Symfony\-::\-Component\-::\-Http\-Foundation\-::\-Universal\-Class\-Loader}}
  129. \subsubsection[{register\-Prefixes}]{\setlength{\rightskip}{0pt plus 5cm}register\-Prefixes (
  130. \begin{DoxyParamCaption}
  131. \item[{array \$}]{classes}
  132. \end{DoxyParamCaption}
  133. )}}
  134. \label{class_symfony_1_1_component_1_1_http_foundation_1_1_universal_class_loader_aac41bbf07ccda9fe0a47842e5f40cbaa}
  135. \-Registers an array of classes using the \hyperlink{namespace_p_e_a_r}{\-P\-E\-A\-R} naming convention.
  136. \begin{DoxyParams}[1]{\-Parameters}
  137. array & {\em \$classes} & \-An array of classes (prefixes as keys and locations as values) \\
  138. \hline
  139. \end{DoxyParams}
  140. \-The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
  141. \item
  142. vendor/symfony/lib/\-Symfony/\-Component/\-Http\-Foundation/\-Universal\-Class\-Loader.\-php\end{DoxyCompactItemize}