1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Stream\IStream;
38
39/**
40 * Interface \Hoa\Stream\IStream\Out.
41 *
42 * Interface for output.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47interface Out extends Stream
48{
49    /**
50     * Write n characters.
51     *
52     * @param   string  $string    String.
53     * @param   int     $length    Length.
54     * @return  mixed
55     */
56    public function write($string, $length);
57
58    /**
59     * Write a string.
60     *
61     * @param   string  $string    String.
62     * @return  mixed
63     */
64    public function writeString($string);
65
66    /**
67     * Write a character.
68     *
69     * @param   string  $character    Character.
70     * @return  mixed
71     */
72    public function writeCharacter($character);
73
74    /**
75     * Write a boolean.
76     *
77     * @param   bool    $boolean    Boolean.
78     * @return  mixed
79     */
80    public function writeBoolean($boolean);
81
82    /**
83     * Write an integer.
84     *
85     * @param   int     $integer    Integer.
86     * @return  mixed
87     */
88    public function writeInteger($integer);
89
90    /**
91     * Write a float.
92     *
93     * @param   float   $float    Float.
94     * @return  mixed
95     */
96    public function writeFloat($float);
97
98    /**
99     * Write an array.
100     *
101     * @param   array   $array    Array.
102     * @return  mixed
103     */
104    public function writeArray(array $array);
105
106    /**
107     * Write a line.
108     *
109     * @param   string  $line    Line.
110     * @return  mixed
111     */
112    public function writeLine($line);
113
114    /**
115     * Write all, i.e. as much as possible.
116     *
117     * @param   string  $string    String.
118     * @return  mixed
119     */
120    public function writeAll($string);
121
122    /**
123     * Truncate a stream to a given length.
124     *
125     * @param   int     $size    Size.
126     * @return  bool
127     */
128    public function truncate($size);
129}
130