12.16. The OpenCReport\Output class #

12.16.1. Set or get suppression of the output section
12.16.2. Add a (text) line
12.16.3. Add a horizontal line
12.16.4. Add an image
12.16.5. Add a barcode
12.16.6. Add an image end marker
12.16.7. Get the first output element

class OpenCReport\Output {
    public final set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_suppress():
                     ?OpenCReport\Expr;

    public final add_line():
                     ?OpenCReport\Line;

    public final add_hline():
                     ?OpenCReport\HorizontalLine;

    public final add_image():
                     ?OpenCReport\Image;

    public final add_image_end(): void;

    public final get_first_element():
                     ?OpenCReport\OutputElement;
}

12.16.1. Set or get suppression of the output section #

Set suppression of the output section. The expression must evaluate to a numeric value which will be treated as a boolean, i.e. 0 or non-0. The default is false, i.e. the section is not suppressed.

public final
OpenCReport\Output::set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Output::get_suppress():
                     ?OpenCReport\Expr;

12.16.2. Add a (text) line #

Add a (text) line to the output section. A line may have children elements, like OpenCReport\Text, OpenCReport\Image and OpenCReport\Barcode. (See Section 12.20, Section 12.19 and Section 12.21.) For class methods of OpenCReport\Line, see Section 12.17.

public final
OpenCReport\Output::add_line():
                     ?OpenCReport\Line;

12.16.3. Add a horizontal line #

Add a horizontal line (a visual separator) to the output section. For class methods of OpenCReport\HorizontalLine, see Section 12.17.

public final
OpenCReport\Output::add_hline():
                     ?OpenCReport\HorizontalLine;

12.16.4. Add an image #

Add an image to the output section. The image will indent every subsequent elements in the section, except other images and barcodes (see below). For class methods of OpenCReport\Image, see Section 12.17.

public final
OpenCReport\Output::add_image():
                     ?OpenCReport\Image;

12.16.5. Add a barcode #

Add a barcode to the output section. The barcode behaves just like an image, i.e. it will indent every subsequent elements in the section, except other images and barcodes. For class methods of OpenCReport\Barcode, see Section 12.17.

public final
OpenCReport\Output::add_barcode():
                     ?OpenCReport\Barcode;

12.16.6. Add an image end marker #

Add an image end marker to the output section. Subsequent elements in the section won't be indented and will be drawn vertically below the previous image.

public final
OpenCReport\Output::add_image_end(): void;

12.16.7. Get the first output element #

Get the first output layout element. It starts an iterator for the output, and return the first element via an OpenCReport\OutputElement object, or null if there is none. See also Section 12.22.

public final
OpenCReport\Output::get_first_element():
                     ?OpenCReport\OutputElement;