| <?php |
| /** |
| * File containing the ezcMailComposerOptions class |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @package Mail |
| * @version //autogen// |
| * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved. |
| * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| */ |
| |
| /** |
| * Class containing the options for the mail composer. |
| * |
| * Example of how to use the composer options: |
| * <code> |
| * $options = new ezcMailComposerOptions(); |
| * $options->automaticImageInclude = false; // default value is true |
| * |
| * $mail = new ezcMailComposer( $options ); |
| * </code> |
| * |
| * Alternatively, you can set the options direcly: |
| * <code> |
| * $mail = new ezcMailComposer(); |
| * $mail->options->automaticImageInclude = false; |
| * </code> |
| * |
| * @property bool $automaticImageInclude |
| * Specifies whether to include in the generated mail the content of |
| * the files specified with "file://" in image tags. Default value |
| * is true (the contents are included). |
| * |
| * @package Mail |
| * @version //autogen// |
| */ |
| class ezcMailComposerOptions extends ezcMailOptions |
| { |
| /** |
| * Constructs an object with the specified values. |
| * |
| * @throws ezcBasePropertyNotFoundException |
| * if $options contains a property not defined |
| * @throws ezcBaseValueException |
| * if $options contains a property with a value not allowed |
| * @param array(string=>mixed) $options |
| */ |
| public function __construct( array $options = array() ) |
| { |
| $this->automaticImageInclude = true; // default is to include the contents of "file://" from image tags |
| |
| parent::__construct( $options ); |
| } |
| |
| /** |
| * Sets the option $propertyName to $propertyValue. |
| * |
| * @throws ezcBasePropertyNotFoundException |
| * if the property $propertyName is not defined |
| * @throws ezcBaseValueException |
| * if $propertyValue is not correct for the property $propertyName |
| * @param string $propertyName |
| * @param mixed $propertyValue |
| * @ignore |
| */ |
| public function __set( $propertyName, $propertyValue ) |
| { |
| switch ( $propertyName ) |
| { |
| case 'automaticImageInclude': |
| if ( !is_bool( $propertyValue ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'bool' ); |
| } |
| |
| $this->properties[$propertyName] = $propertyValue; |
| break; |
| |
| default: |
| parent::__set( $propertyName, $propertyValue ); |
| } |
| } |
| } |
| ?> |