class OpenCReport\Part {
public final get_next():
?OpenCReport\Part;
public final row_new():
OpenCReport\Row;
public final row_get_first():
?OpenCReport\Row;
public final add_iteration_cb(
string $callback): void;
public final equals(
OpenCReport\Part $part): bool;
public final set_iterations(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_iterations():
?OpenCReport\Expr;
public final set_font_name(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_font_name():
?OpenCReport\Expr;
public final set_font_size(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_font_size():
?OpenCReport\Expr;
public final set_paper(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_paper():
?OpenCReport\Expr;
public final set_orientation(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_orientation():
?OpenCReport\Expr;
public final set_top_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_top_margin():
?OpenCReport\Expr;
public final set_bottom_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_bottom_margin():
?OpenCReport\Expr;
public final set_left_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_left_margin():
?OpenCReport\Expr;
public final set_right_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_right_margin():
?OpenCReport\Expr;
public final set_suppress(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_suppress():
?OpenCReport\Expr;
public final set_suppress_pageheader_firstpage(
?string $expr_string = null):
?OpenCReport\Expr;
public final get_suppress_pageheader_firstpage():
?OpenCReport\Expr;
public final page_header():
?OpenCReport\Output;
public final page_header_set_report(
OpenCReport\Report $report):
void;
public final page_footer():
?OpenCReport\Output;
public final page_footer_set_report(
OpenCReport\Report $report):
void;
}
Get the next object in the chain of report parts.
This method may only be used on an object created
with OpenCReport::part_get_first(),
i.e. one that was internally marked as an iterator
object.
public final
OpenCReport\Part::get_next():
?OpenCReport\Part;
For class methods of OpenCReport\Row,
see Section 12.11
public final
OpenCReport\Part::row_new():
OpenCReport\Row;
Get the first part row from the part.
The object is marked internally as an iterator.
For class methods of OpenCReport\Row,
see Section 12.11
public final
OpenCReport\Part::row_get_first():
?OpenCReport\Row;
Add an "iteration done" event callback for the part object.
public final
OpenCReport\Part::add_iteration_cb(
string $callback): void;
Check whether two part objects refer to the same internal part structure of the report. Used by unit tests.
public final
OpenCReport\Part::equals(
OpenCReport\Part $part): bool;
Set the number of iterations for the part. The expression must evaluate to a numeric (integer) value. The part and all of its subsections will be calculated and rendered this many times. Default is 1.
public final
OpenCReport\Part::set_iterations(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_iterations():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_font_name(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_font_name():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_font_size(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_font_size():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_paper(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_paper():
?OpenCReport\Expr;
The expression must evaluate
to a string value. The possible
values are portrait
and landscape.
Default is portrait.
public final
OpenCReport\Part::set_orientation(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_orientation():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_top_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_top_margin():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_bottom_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_bottom_margin():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_left_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_left_margin():
?OpenCReport\Expr;
public final
OpenCReport\Part::set_right_margin(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_right_margin():
?OpenCReport\Expr;
Set whether the part is suppressed, i.e.
all its subsections are omitted from calculating
and rendering. Default is false.
public final
OpenCReport\Part::set_suppress(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::get_suppress():
?OpenCReport\Expr;
Set whether the page header of the part is
suppressed on the first page. The expression
must evaluate to a numeric value, which is
treated as a boolean (i.e. 0 or non-0).
Default is false.
public final
OpenCReport\Part::set_suppress_pageheader_firstpage(
?string $expr_string = null):
?OpenCReport\Expr;
public final
OpenCReport\Part::set_suppress_pageheader_firstpage():
?OpenCReport\Expr;
Get the part's page header <Output>
section. See Section 12.16 and
Output node.
public final
OpenCReport\Part::page_header():
?OpenCReport\Output;
Set the report object for the part's page header. This will add the internal association between the part's page header and the report, and expressions in the part page header may reference report query column identifiers and report user variables. Therefore it is only recommended for single-part, single-report reports.
public final
OpenCReport\Part::page_header_set_report(
OpenCReport\Report $report):
void;
Get the part's page footer <Output>
section. See Section 12.16 and
Output node.
public final
OpenCReport\Part::page_footer():
?OpenCReport\Output;
Set the report object for the part's page footer. This will add the internal association between the part's page footer and the report, and expressions in the part page footer may reference report query column identifiers and report user variables. Therefore it is only recommended for single-part, single-report reports.
public final
OpenCReport\Part::page_footer_set_report(
OpenCReport\Report $report):
void;