git.stricted.de - GitHub/WoltLab/WCF.git/blob

   1 <?php
   2 namespace wcf\system\message\embedded\object;
   3
   4 /**
   5  * Default interface of simple embedded object handler.
   6  *
   7  * @author      Alexander Ebert
   8  * @copyright   2001-2016 WoltLab GmbH
   9  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  10  * @package     WoltLabSuite\Core\System\Message\Embedded\Object
  11  */
  12 interface ISimpleMessageEmbeddedObjectHandler extends IMessageEmbeddedObjectHandler {
  13         /**
  14          * Validates the provided values for existence and returns the filtered list.
  15          *
  16          * @param       string          $objectType     object type identifier
  17          * @param       integer         $objectID       object id
  18          * @param       integer[]       $values         list of value ids
  19          * @return      integer[]       filtered list
  20          */
  21         public function validateValues($objectType, $objectID, array $values);
  22
  23         /**
  24          * Returns replacement string for simple placeholders. Must return `null`
  25          * if no replacement should be performed due to invalid or missing arguments.
  26          *
  27          * @param       string          $objectType     object type identifier
  28          * @param       integer         $objectID       object id
  29          * @param       integer         $value          value id
  30          * @param       array           $attributes     list of additional attributes
  31          * @return      string|null     replacement string or null if value id is unknown
  32          */
  33         public function replaceSimple($objectType, $objectID, $value, array $attributes);
  34 }