PageRenderTime 46ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/phpdocs/vendor/B4T/classes/Book4Time.Resource.html

https://bitbucket.org/jcjordan/jcjordan.bitbucket.org
HTML | 291 lines | 291 code | 0 blank | 0 comment | 0 complexity | 5a786336d0320916eae44e7502db370f MD5 | raw file
    

  1. <!DOCTYPE html><html lang="en">
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    4. 

  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
    5. 

  5. <meta charset="utf-8">
    6. 

  6. <title>phpDocumentor » \Book4Time\Resource</title>
    7. 

  7. <meta name="author" content="Mike van Riel">
    8. 

  8. <meta name="description" content="">
    9. 

  9. <link href="../css/template.css" rel="stylesheet" media="all">
    10. 

  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
    11. 

  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
    12. 

  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
    13. 

  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
    14. 

  14. </head>
    15. 

  15. <body>
    16. 

  16. <div class="navbar navbar-fixed-top">
    17. 

  17. <div class="navbar-inner"><div class="container">
    18. 

  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
    19. 

  19. <li class="dropdown">
    20. 

  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
    21. 

  21.                                     API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
    22. 

  22. <li><a>Namespaces</a></li>
    23. 

  23. <li><a href="../namespaces/Book4Time.html"><i class="icon-th"></i> Book4Time</a></li>
    24. 

  24. </ul>
    25. 

  25. </li>
    26. 

  26. <li class="dropdown" id="charts-menu">
    27. 

  27. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
    28. 

  28.                                     Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
    29. 

  29. </li>
    30. 

  30. <li class="dropdown" id="reports-menu">
    31. 

  31. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
    32. 

  32.                                     Reports <b class="caret"></b></a><ul class="dropdown-menu">
    33. 

  33. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
    34. 

  34.                 <span class="label label-info">83</span></a></li>
    35. 

  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
    36. 

  36.                 <ul></ul></a></li>
    37. 

  37. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
    38. 

  38.                 <span class="label label-info">0</span></a></li>
    39. 

  39. </ul>
    40. 

  40. </li>
    41. 

  41. </ul></div>
    42. 

  42. </div></div>
    43. 

  43. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
    44. 

  44. </div>
    45. 

  45. <div id="___" class="container">
    46. 

  46. <noscript><div class="alert alert-warning">
    47. 

  47.                             Javascript is disabled; several features are only available
    48. 

  48.                             if Javascript is enabled.
    49. 

  49.                         </div></noscript>
    50. 

  50. <div class="row">
    51. 

  51. <div class="span4">
    52. 

  52. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
    53. 

  53. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
    54. 

  54. </div>
    55. 

  55. <ul class="side-nav nav nav-list">
    56. 

  56. <li class="nav-header">
    57. 

  57. <i class="icon-custom icon-method"></i> Methods
    58. 

  58.                     <ul>
    59. 

  59. <li class="method public inherited"><a href="#method___construct" title="__construct :: __construct function."><span class="description">__construct function.</span><pre>__construct()</pre></a></li>
    60. 

  60. <li class="method public inherited"><a href="#method_flag" title="flag :: "><span class="description">flag()
    61. 

  61.         </span><pre>flag()</pre></a></li>
    62. 

  62. <li class="method public "><a href="#method_getTechnicians" title="getTechnicians :: get_technicians function."><span class="description">get_technicians function.</span><pre>getTechnicians()</pre></a></li>
    63. 

  63. <li class="method public "><a href="#method_ping" title="ping :: "><span class="description">ping()
    64. 

  64.         </span><pre>ping()</pre></a></li>
    65. 

  65. </ul>
    66. 

  66. </li>
    67. 

  67. <li class="nav-header">
    68. 

  68. <i class="icon-custom icon-property"></i> Properties
    69. 

  69.                     <ul></ul>
    70. 

  70. </li>
    71. 

  71. <li class="nav-header protected">» Protected
    72. 

  72.                     <ul>
    73. 

  73. <li class="property protected inherited"><a href="#property_accountNumber" title="$accountNumber :: accountNumber"><span class="description"></span><pre>$accountNumber</pre></a></li>
    74. 

  74. <li class="property protected "><a href="#property_classmap" title="$classmap :: "><span class="description"></span><pre>$classmap</pre></a></li>
    75. 

  75. </ul>
    76. 

  76. </li>
    77. 

  77. <li class="nav-header">
    78. 

  78. <i class="icon-custom icon-constant"></i> Constants
    79. 

  79.                     <ul>
    80. 

  80. <li class="constant  inherited"><a href="#constant_B4T_ACCOUNT_NUMBER_PROD" title="B4T_ACCOUNT_NUMBER_PROD :: "><span class="description">B4T_ACCOUNT_NUMBER_PROD</span><pre>B4T_ACCOUNT_NUMBER_PROD</pre></a></li>
    81. 

  81. <li class="constant  inherited"><a href="#constant_B4T_ACCOUNT_NUMBER_TEST" title="B4T_ACCOUNT_NUMBER_TEST :: "><span class="description">B4T_ACCOUNT_NUMBER_TEST</span><pre>B4T_ACCOUNT_NUMBER_TEST</pre></a></li>
    82. 

  82. <li class="constant  "><a href="#constant_ENDPOINT_PROD" title="ENDPOINT_PROD :: "><span class="description">ENDPOINT_PROD</span><pre>ENDPOINT_PROD</pre></a></li>
    83. 

  83. <li class="constant  "><a href="#constant_ENDPOINT_TEST" title="ENDPOINT_TEST :: "><span class="description">ENDPOINT_TEST</span><pre>ENDPOINT_TEST</pre></a></li>
    84. 

  84. <li class="constant  inherited"><a href="#constant_FLAG_FALSE" title="FLAG_FALSE :: "><span class="description">FLAG_FALSE</span><pre>FLAG_FALSE</pre></a></li>
    85. 

  85. <li class="constant  inherited"><a href="#constant_FLAG_IGNORE" title="FLAG_IGNORE :: "><span class="description">FLAG_IGNORE</span><pre>FLAG_IGNORE</pre></a></li>
    86. 

  86. <li class="constant  inherited"><a href="#constant_FLAG_TRUE" title="FLAG_TRUE :: "><span class="description">FLAG_TRUE</span><pre>FLAG_TRUE</pre></a></li>
    87. 

  87. </ul>
    88. 

  88. </li>
    89. 

  89. </ul>
    90. 

  90. </div>
    91. 

  91. <div class="span8">
    92. 

  92. <a id="\Book4Time\Resource"></a><ul class="breadcrumb">
    93. 

  93. <li>
    94. 

  94. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
    95. 

  95. </li>
    96. 

  96. <li><a href="../namespaces/Book4Time.html">Book4Time</a></li>
    97. 

  97. <li class="active">
    98. 

  98. <span class="divider">\</span><a href="../classes/Book4Time.Resource.html">Resource</a>
    99. 

  99. </li>
    100. 

  100. </ul>
    101. 

  101. <div class="element class">
    102. 

  102. <p class="short_description">Resource class.</p>
    103. 

  103. <div class="details">
    104. 

  104. <div class="long_description"><p>The Book4Time Resource API. Retrieves technician information records from Book4Time.</p></div>
    105. 

  105. <table class="table table-bordered"><tr>
    106. 

  106. <th>extends</th>
    107. 

  107. <td>\Book4Time\API</td>
    108. 

  108. </tr></table>
    109. 

  109. <h3>
    110. 

  110. <i class="icon-custom icon-method"></i> Methods</h3>
    111. 

  111. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
    112. 

  112. <h2>__construct function.</h2>
    113. 

  113. <pre>__construct($env, $autoconnect, $cache_wsdl) : void</pre>
    114. 

  114. <div class="labels"><span class="label">Inherited</span></div>
    115. 

  115. <div class="row collapse"><div class="detail-description">
    116. 

  116. <div class="long_description"></div>
    117. 

  117. <table class="table table-bordered">
    118. 

  118. <tr>
    119. 

  119. <th>access</th>
    120. 

  120. <td>public</td>
    121. 

  121. </tr>
    122. 

  122. <tr>
    123. 

  123. <th>inherited_from</th>
    124. 

  124. <td>\Book4Time\API::__construct()</td>
    125. 

  125. </tr>
    126. 

  126. </table>
    127. 

  127. <h3>Parameters</h3>
    128. 

  128. <div class="subelement argument"><h4>$env</h4></div>
    129. 

  129. <div class="subelement argument"><h4>$autoconnect</h4></div>
    130. 

  130. <div class="subelement argument"><h4>$cache_wsdl</h4></div>
    131. 

  131. </div></div>
    132. 

  132. </div>
    133. 

  133. <a id="method_flag"></a><div class="element clickable method public method_flag" data-toggle="collapse" data-target=".method_flag .collapse">
    134. 

  134. <h2>flag()
    135. 

  135.         </h2>
    136. 

  136. <pre>flag($val) </pre>
    137. 

  137. <div class="labels">
    138. 

  138. <span class="label">Inherited</span><span class="label">Static</span>
    139. 

  139. </div>
    140. 

  140. <div class="row collapse"><div class="detail-description">
    141. 

  141. <div class="long_description"></div>
    142. 

  142. <table class="table table-bordered"><tr>
    143. 

  143. <th>inherited_from</th>
    144. 

  144. <td>\Book4Time\API::flag()</td>
    145. 

  145. </tr></table>
    146. 

  146. <h3>Parameters</h3>
    147. 

  147. <div class="subelement argument"><h4>$val</h4></div>
    148. 

  148. </div></div>
    149. 

  149. </div>
    150. 

  150. <a id="method_getTechnicians"></a><div class="element clickable method public method_getTechnicians" data-toggle="collapse" data-target=".method_getTechnicians .collapse">
    151. 

  151. <h2>get_technicians function.</h2>
    152. 

  152. <pre>getTechnicians(string $location, string $sku) : array</pre>
    153. 

  153. <div class="labels"></div>
    154. 

  154. <div class="row collapse"><div class="detail-description">
    155. 

  155. <div class="long_description"></div>
    156. 

  156. <table class="table table-bordered"><tr>
    157. 

  157. <th>access</th>
    158. 

  158. <td>public</td>
    159. 

  159. </tr></table>
    160. 

  160. <h3>Parameters</h3>
    161. 

  161. <div class="subelement argument">
    162. 

  162. <h4>$location</h4>
    163. 

  163. <code>string</code><p>(default: '')</p>
    164. 

  164. </div>
    165. 

  165. <div class="subelement argument">
    166. 

  166. <h4>$sku</h4>
    167. 

  167. <code>string</code><p>sku (default: '')</p>
    168. 

  168. </div>
    169. 

  169. <h3>Returns</h3>
    170. 

  170. <div class="subelement response">
    171. 

  171. <code>array</code>\MTS\Book4Time\Resource\Technician</div>
    172. 

  172. </div></div>
    173. 

  173. </div>
    174. 

  174. <a id="method_ping"></a><div class="element clickable method public method_ping" data-toggle="collapse" data-target=".method_ping .collapse">
    175. 

  175. <h2>ping()
    176. 

  176.         </h2>
    177. 

  177. <pre>ping() </pre>
    178. 

  178. <div class="labels"></div>
    179. 

  179. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
    180. 

  180. </div>
    181. 

  181. <h3>
    182. 

  182. <i class="icon-custom icon-property"></i> Properties</h3>
    183. 

  183. <a id="property_accountNumber"> </a><div class="element clickable property protected property_accountNumber" data-toggle="collapse" data-target=".property_accountNumber .collapse">
    184. 

  184. <h2></h2>
    185. 

  185. <pre>$accountNumber : mixed</pre>
    186. 

  186. <div class="labels"><span class="label">Inherited</span></div>
    187. 

  187. <div class="row collapse"><div class="detail-description">
    188. 

  188. <div class="long_description"></div>
    189. 

  189. <table class="table table-bordered">
    190. 

  190. <tr>
    191. 

  191. <th>access</th>
    192. 

  192. <td>protected</td>
    193. 

  193. </tr>
    194. 

  194. <tr>
    195. 

  195. <th>inherited_from</th>
    196. 

  196. <td>\Book4Time\API::$$accountNumber</td>
    197. 

  197. </tr>
    198. 

  198. </table>
    199. 

  199. </div></div>
    200. 

  200. </div>
    201. 

  201. <a id="property_classmap"> </a><div class="element clickable property protected property_classmap" data-toggle="collapse" data-target=".property_classmap .collapse">
    202. 

  202. <h2></h2>
    203. 

  203. <pre>$classmap </pre>
    204. 

  204. <div class="labels"></div>
    205. 

  205. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
    206. 

  206. </div>
    207. 

  207. <h3>
    208. 

  208. <i class="icon-custom icon-constant"></i> Constants</h3>
    209. 

  209. <a id="constant_B4T_ACCOUNT_NUMBER_PROD"> </a><div class="element clickable constant  constant_B4T_ACCOUNT_NUMBER_PROD" data-toggle="collapse" data-target=".constant_B4T_ACCOUNT_NUMBER_PROD .collapse">
    210. 

  210. <h2>B4T_ACCOUNT_NUMBER_PROD</h2>
    211. 

  211. <pre>B4T_ACCOUNT_NUMBER_PROD </pre>
    212. 

  212. <div class="labels"><span class="label">Inherited</span></div>
    213. 

  213. <div class="row collapse"><div class="detail-description">
    214. 

  214. <div class="long_description"></div>
    215. 

  215. <table class="table table-bordered"><tr>
    216. 

  216. <th>inherited_from</th>
    217. 

  217. <td>\Book4Time\API::B4T_ACCOUNT_NUMBER_PROD</td>
    218. 

  218. </tr></table>
    219. 

  219. </div></div>
    220. 

  220. </div>
    221. 

  221. <a id="constant_B4T_ACCOUNT_NUMBER_TEST"> </a><div class="element clickable constant  constant_B4T_ACCOUNT_NUMBER_TEST" data-toggle="collapse" data-target=".constant_B4T_ACCOUNT_NUMBER_TEST .collapse">
    222. 

  222. <h2>B4T_ACCOUNT_NUMBER_TEST</h2>
    223. 

  223. <pre>B4T_ACCOUNT_NUMBER_TEST </pre>
    224. 

  224. <div class="labels"><span class="label">Inherited</span></div>
    225. 

  225. <div class="row collapse"><div class="detail-description">
    226. 

  226. <div class="long_description"></div>
    227. 

  227. <table class="table table-bordered"><tr>
    228. 

  228. <th>inherited_from</th>
    229. 

  229. <td>\Book4Time\API::B4T_ACCOUNT_NUMBER_TEST</td>
    230. 

  230. </tr></table>
    231. 

  231. </div></div>
    232. 

  232. </div>
    233. 

  233. <a id="constant_ENDPOINT_PROD"> </a><div class="element clickable constant  constant_ENDPOINT_PROD" data-toggle="collapse" data-target=".constant_ENDPOINT_PROD .collapse">
    234. 

  234. <h2>ENDPOINT_PROD</h2>
    235. 

  235. <pre>ENDPOINT_PROD </pre>
    236. 

  236. <div class="labels"></div>
    237. 

  237. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
    238. 

  238. </div>
    239. 

  239. <a id="constant_ENDPOINT_TEST"> </a><div class="element clickable constant  constant_ENDPOINT_TEST" data-toggle="collapse" data-target=".constant_ENDPOINT_TEST .collapse">
    240. 

  240. <h2>ENDPOINT_TEST</h2>
    241. 

  241. <pre>ENDPOINT_TEST </pre>
    242. 

  242. <div class="labels"></div>
    243. 

  243. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
    244. 

  244. </div>
    245. 

  245. <a id="constant_FLAG_FALSE"> </a><div class="element clickable constant  constant_FLAG_FALSE" data-toggle="collapse" data-target=".constant_FLAG_FALSE .collapse">
    246. 

  246. <h2>FLAG_FALSE</h2>
    247. 

  247. <pre>FLAG_FALSE </pre>
    248. 

  248. <div class="labels"><span class="label">Inherited</span></div>
    249. 

  249. <div class="row collapse"><div class="detail-description">
    250. 

  250. <div class="long_description"></div>
    251. 

  251. <table class="table table-bordered"><tr>
    252. 

  252. <th>inherited_from</th>
    253. 

  253. <td>\Book4Time\API::FLAG_FALSE</td>
    254. 

  254. </tr></table>
    255. 

  255. </div></div>
    256. 

  256. </div>
    257. 

  257. <a id="constant_FLAG_IGNORE"> </a><div class="element clickable constant  constant_FLAG_IGNORE" data-toggle="collapse" data-target=".constant_FLAG_IGNORE .collapse">
    258. 

  258. <h2>FLAG_IGNORE</h2>
    259. 

  259. <pre>FLAG_IGNORE </pre>
    260. 

  260. <div class="labels"><span class="label">Inherited</span></div>
    261. 

  261. <div class="row collapse"><div class="detail-description">
    262. 

  262. <div class="long_description"></div>
    263. 

  263. <table class="table table-bordered"><tr>
    264. 

  264. <th>inherited_from</th>
    265. 

  265. <td>\Book4Time\API::FLAG_IGNORE</td>
    266. 

  266. </tr></table>
    267. 

  267. </div></div>
    268. 

  268. </div>
    269. 

  269. <a id="constant_FLAG_TRUE"> </a><div class="element clickable constant  constant_FLAG_TRUE" data-toggle="collapse" data-target=".constant_FLAG_TRUE .collapse">
    270. 

  270. <h2>FLAG_TRUE</h2>
    271. 

  271. <pre>FLAG_TRUE </pre>
    272. 

  272. <div class="labels"><span class="label">Inherited</span></div>
    273. 

  273. <div class="row collapse"><div class="detail-description">
    274. 

  274. <div class="long_description"></div>
    275. 

  275. <table class="table table-bordered"><tr>
    276. 

  276. <th>inherited_from</th>
    277. 

  277. <td>\Book4Time\API::FLAG_TRUE</td>
    278. 

  278. </tr></table>
    279. 

  279. </div></div>
    280. 

  280. </div>
    281. 

  281. </div>
    282. 

  282. </div>
    283. 

  283. </div>
    284. 

  284. </div>
    285. 

  285. <div class="row"><footer class="span12">
    286. 

  286.             Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
    287. 

  287.             Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
    288. 

  288.             generated on 2013-02-20T11:27:38-06:00.<br></footer></div>
    289. 

  289. </div>
    290. 

  290. </body>
    291. 

  291. </html>
    292. 

  292.