1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Page

Page

class Page extends Message

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Generated from protobuf message google.api.Page

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

pages:
- name: Tutorial
  content: (== include tutorial.md ==)
  subpages:
  - name: Java
    content: (== include tutorial_java.md ==)

You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

$this
setName(string $var)

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

pages:
- name: Tutorial
  content: (== include tutorial.md ==)
  subpages:
  - name: Java
    content: (== include tutorial_java.md ==)

You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

string
getContent()

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.

$this
setContent(string $var)

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.

RepeatedField
getSubpages()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

$this
setSubpages(Page[]|RepeatedField $var)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Details

at line 82
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $name
      The name of the page. It will be used as an identity of the page to
      generate URI of the page, text of the link to this page in navigation,
      etc. The full page name (start from the root page name to this page
      concatenated with `.`) can be used as reference to the page in your
      documentation. For example:
      <pre><code>pages:
      - name: Tutorial
        content: &#40;== include tutorial.md ==&#41;
        subpages:
        - name: Java
          content: &#40;== include tutorial_java.md ==&#41;
      </code></pre>
      You can reference `Java` page using Markdown reference link syntax:
      `[Java][Tutorial.Java]`.
@type string $content
      The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
      to include content from a Markdown file.
@type \Google\Api\Page[]|\Google\Protobuf\Internal\RepeatedField $subpages
      Subpages of this page. The order of subpages specified here will be
      honored in the generated docset.

}

at line 106
string getName()

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

pages:
- name: Tutorial
  content: (== include tutorial.md ==)
  subpages:
  - name: Java
    content: (== include tutorial_java.md ==)

You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

Generated from protobuf field string name = 1;

Return Value

string

at line 131
$this setName(string $var)

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

pages:
- name: Tutorial
  content: (== include tutorial.md ==)
  subpages:
  - name: Java
    content: (== include tutorial_java.md ==)

You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 146
string getContent()

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.

Generated from protobuf field string content = 2;

Return Value

string

at line 159
$this setContent(string $var)

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.

Generated from protobuf field string content = 2;

Parameters

string $var

Return Value

$this

at line 174
RepeatedField getSubpages()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Generated from protobuf field repeated .google.api.Page subpages = 3;

Return Value

RepeatedField

at line 187
$this setSubpages(Page[]|RepeatedField $var)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Generated from protobuf field repeated .google.api.Page subpages = 3;

Parameters

Page[]|RepeatedField $var

Return Value

$this