[BUGFIX] Cleanup: PhpDoc, not initialized variables in modfuncreport
[Packages/TYPO3.CMS.git] / typo3 / sysext / linkvalidator / classes / linktype / class.tx_linkvalidator_linktype_interface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010 - 2011 Michael Miousse (michael.miousse@infoglobe.ca)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24
25 /**
26 * This class provides interface implementation.
27 *
28 * @author Michael Miousse <michael.miousse@infoglobe.ca>
29 * @package TYPO3
30 * @subpackage linkvalidator
31 */
32 interface tx_linkvalidator_linktype_Interface {
33
34 /**
35 * Checks a given link for validity
36 *
37 * @param string $url Url to check
38 * @param array $softRefEntry The soft reference entry which builds the context of that url
39 * @param tx_linkvalidator_Processor $reference Parent instance of tx_linkvalidator_Processor
40 * @return string Validation error message or success code
41 */
42 public function checkLink($url, $softRefEntry, $reference);
43
44 /**
45 * Base type fetching method, based on the type that softRefParserObj returns.
46 *
47 * @param array $value Reference properties
48 * @param string $type Current type
49 * @param string $key Validator hook name
50 * @return string Fetched type
51 */
52 public function fetchType($value, $type, $key);
53
54 /**
55 * Get the value of the private property errorParams.
56 *
57 * @return array All parameters needed for the rendering of the error message
58 */
59 public function getErrorParams();
60
61 /**
62 * Construct a valid Url for browser output
63 *
64 * @param array $row Broken link record
65 * @return string Parsed broken url
66 */
67 public function getBrokenUrl($row);
68
69 /**
70 * Generate the localized error message from the error params saved from the parsing
71 *
72 * @param array $errorParams All parameters needed for the rendering of the error message
73 * @return string Validation error message
74 */
75 public function getErrorMessage($errorParams);
76
77 }
78
79 ?>