## Apache Zeta Components Manual :: File Source for data_fetch.php

## Source for file data_fetch.php

Documentation is available at data_fetch.php

1. <?php
2. /**
3. * File containing the ezcAuthenticationDataFetch interface.
4. *
5. * Licensed to the Apache Software Foundation (ASF) under one
6. * or more contributor license agreements. See the NOTICE file
7. * distributed with this work for additional information
8. * regarding copyright ownership. The ASF licenses this file
9. * to you under the Apache License, Version 2.0 (the
10. * "License"); you may not use this file except in compliance
11. * with the License. You may obtain a copy of the License at
12. *
13. * http://www.apache.org/licenses/LICENSE-2.0
14. *
15. * Unless required by applicable law or agreed to in writing,
16. * software distributed under the License is distributed on an
17. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18. * KIND, either express or implied. See the License for the
19. * specific language governing permissions and limitations
20. * under the License.
21. *
22. * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
23. * @filesource
24. * @package Authentication
25. * @version //autogen//
26. */
28. /**
29. * Interface defining functionality for fetching extra data during the
30. * authentication process.
31. *
32. * Authentication filters which support fetching additional data during
33. * the authentication process can implement this interface.
34. *
35. * @package Authentication
36. * @version //autogen//
37. */
38. interface ezcAuthenticationDataFetch
39. {
40. /**
41. * Registers which extra data to fetch during the authentication process.
42. *
43. * The input $data should be an array of attributes to request, for example:
44. * <code>
45. * array( 'name', 'company', 'mobile' );
46. * </code>
47. *
48. * The extra data that is possible to return depends on the authentication
49. * filter. Please read the description of each filter to find out what extra
50. * data is possible to fetch.
51. *
52. * @param array(string) $data A list of attributes to fetch during authentication
53. */
54. public function registerFetchData ( array $data = array() );
56. /**
57. * Returns the extra data fetched during the authentication process.
58. *
59. * The return is something like this:
60. * <code>
61. * array( 'name' = > array( 'Dr. No' ),
62. * 'company' => array( 'SPECTRE' ),
63. * 'mobile' => array( '555-7732873' )
64. * );
65. * </code>
66. *
67. * The extra data that is possible to return depends on the authentication
68. * filter. Please read the description of each filter to find out what extra
69. * data is possible to fetch.
70. *
71. * @return array(string=>mixed)
72. */
73. public function fetchData ();
74. }
75. ?>

Documentation generated by phpDocumentor 1.4.3