PHPFUI/InstaDoc

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

Generated from protobuf message google.api.Page

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param 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 ```(== include {path}
      ==)``` to include content from a Markdown file. The content can be used
      to produce the documentation page such as HTML format page.
@type array<\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.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getContent()

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Generated from protobuf field string content = 2;

return string

public 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:

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

Generated from protobuf field string name = 1;

return string

public 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 \Google\Protobuf\Internal\RepeatedField

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setContent( $var)

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Generated from protobuf field string content = 2;

param string $var
return $this

public setName( $var)

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

Generated from protobuf field string name = 1;

param string $var
return $this

public setSubpages( $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;

param \Google\Api\Page[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

Properties

protected $content = ''

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Generated from protobuf field string content = 2;

protected $name = ''

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

Generated from protobuf field string name = 1;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $subpages = NULL

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;