ObjectValidatorInterface.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
*  All rights reserved
*
*  This class is a backport of the corresponding class of FLOW3.
*  All credits go to the v5 team.
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * Contract for an object validator
 *
 * @package Extbase
 * @subpackage Validation\Validator
 * @version $Id: ObjectValidatorInterface.php 1052 2009-08-05 21:51:32Z sebastian $
 */
interface Tx_Extbase_Validation_Validator_ObjectValidatorInterface extends Tx_Extbase_Validation_Validator_ValidatorInterface {

    /**
     * Checks the given object can be validated by the validator implementation
     *
     * @param object $object The object to be checked
     * @return boolean TRUE if this validator can validate instances of the given object or FALSE if it can't
     */
    public function canValidate($object);

    /**
     * Checks if the specified property of the given object is valid.
     *
     * If at least one error occurred, the result is FALSE.
     *
     * @param object $object The object containing the property to validate
     * @param string $propertyName Name of the property to validate
     * @return boolean TRUE if the property value is valid, FALSE if an error occured
     */
    public function isPropertyValid($object, $propertyName);
}

?>