Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Commit

Permalink
Merge ce772d0 into bcf7852
Browse files Browse the repository at this point in the history
  • Loading branch information
@michalbundyra
michalbundyra committed Sep 20, 2017
2 parents bcf7852 + ce772d0 commit 497e707
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 72 deletions.
20 changes: 10 additions & 10 deletions doc/book/helpers/breadcrumbs.md
View file
Expand Up @@ -24,16 +24,16 @@ at level 2 even if the deepest active page is on level 3).

Methods in the breadcrumbs helper:

Method signature | Description
------------------------------------------ | -----------
`getSeparator() : string` | Retrieves the separator string to use between breadcrumbs; default is ` > `.
`setSeparator(string $separator) : self` | Set the separator string to use between breadcrumbs.
`getLinkLast() : bool` | Retrieve the flag indicating whether the last breadcrumb should be rendered as an anchor; defaults to `false`.
`setLinkLast(bool $flag) : self` | Set the flag indicating whether the last breadcrumb should be rendered as an anchor.
`getPartial() : string|array` | Retrieve a partial view script that should be used for rendering breadcrumbs. If a partial view script is set, the helper's `render()` method will use the `renderPartial()` method. The helper expects the partial to be a `string` or an `array` with two elements. If the partial is a `string`, it denotes the name of the partial script to use. If it is an `array`, the first element will be used as the name of the partial view script, and the second element is the module where the script is found.
`setPartial(string|array $partial) : self` | Set the partial view script to use when rendering breadcrumbs; see `getPartial()` for acceptable values.
`renderStraight()` | The default render method used when no partial view script is present.
`renderPartial()` | Used for rendering using a partial view script.
Method signature | Description
------------------------------------------- | -----------
`getSeparator() : string` | Retrieves the separator string to use between breadcrumbs; default is ` > `.
`setSeparator(string $separator) : self` | Set the separator string to use between breadcrumbs.
`getLinkLast() : bool` | Retrieve the flag indicating whether the last breadcrumb should be rendered as an anchor; defaults to `false`.
`setLinkLast(bool $flag) : self` | Set the flag indicating whether the last breadcrumb should be rendered as an anchor.
`getPartial() : string\|array` | Retrieve a partial view script that should be used for rendering breadcrumbs. If a partial view script is set, the helper's `render()` method will use the `renderPartial()` method. The helper expects the partial to be a `string` or an `array` with two elements. If the partial is a `string`, it denotes the name of the partial script to use. If it is an `array`, the first element will be used as the name of the partial view script, and the second element is the module where the script is found.
`setPartial(string\|array $partial) : self` | Set the partial view script to use when rendering breadcrumbs; see `getPartial()` for acceptable values.
`renderStraight()` | The default render method used when no partial view script is present.
`renderPartial()` | Used for rendering using a partial view script.

## Basic usage

Expand Down
46 changes: 23 additions & 23 deletions doc/book/helpers/intro.md
View file
Expand Up @@ -22,38 +22,38 @@ adds integration with
implements the interface `Zend\View\Helper\Navigation\HelperInterface`, which
defines the following methods:

Method signature | Description
--------------------------------------------------------------------- | -----------
`getContainer() : null|AbstractContainer` | Retrieve the current navigation container, if any.
`hasContainer() : bool` | Is any navigation container currently registered?
`setContainer(AbstractContainer $container) : self` | Set a navigation container.
`getTranslator() : null|Zend\I18n\Translator\TranslatorInterface` | Retrieve the current translator instance, if any.
`setTranslator(Zend\I18n\Translator\TranslatorInterface`) : self` | Set a translator instance to use with labels.
`hasTranslator() | bool` | Is a translator instance present?
`isTranslatorEnabled() : bool` | Should translation occur? To be `true`, both the flag enabling translation must be set, and a translator instance present.
`setTranslatorEnabled(bool $flag) : self` | Set the flag indicating whether or not translation should occur.
`getAcl() : null|Zend\Permissions\Acl\AclInterface` | Retrieve the current ACL instance, if any.
`setAcl(Zend\Permissions\Acl\AclInterface $acl) : self` | Set an ACL instance.
`hasAcl() : bool` | Whether or not an ACL instance is present.
`getRole() : null|string|Zend\Permissions\Acl\Role\RoleInterface` | Retrieve the current ACL role instance, if any.
`setRole(string|Zend\Permissions\Acl\Role\RoleInterface $acl) : self` | Set an ACL role instance.
`hasRole() : bool` | Whether or not an ACL role instance is present.
`getUseAcl() : bool` | Whether or not to use ACLs; both the flag must be enabled and an ACL instance present.
`setUseAcl(bool $flag) : self` | Set the flag indicating whether or not to use ACLs.
`__toString()` | Cast the helper to a string value; relies on `render()`.
`render()` | Render the helper to a string.
Method signature | Description
---------------------------------------------------------------------- | -----------
`getContainer() : null\|AbstractContainer` | Retrieve the current navigation container, if any.
`hasContainer() : bool` | Is any navigation container currently registered?
`setContainer(AbstractContainer $container) : self` | Set a navigation container.
`getTranslator() : null\|Zend\I18n\Translator\TranslatorInterface` | Retrieve the current translator instance, if any.
`setTranslator(Zend\I18n\Translator\TranslatorInterface`) : self` | Set a translator instance to use with labels.
`hasTranslator() : bool` | Is a translator instance present?
`isTranslatorEnabled() : bool` | Should translation occur? To be `true`, both the flag enabling translation must be set, and a translator instance present.
`setTranslatorEnabled(bool $flag) : self` | Set the flag indicating whether or not translation should occur.
`getAcl() : null\|Zend\Permissions\Acl\AclInterface` | Retrieve the current ACL instance, if any.
`setAcl(Zend\Permissions\Acl\AclInterface $acl) : self` | Set an ACL instance.
`hasAcl() : bool` | Whether or not an ACL instance is present.
`getRole() : null\|string|\Zend\Permissions\Acl\Role\RoleInterface` | Retrieve the current ACL role instance, if any.
`setRole(string\|Zend\Permissions\Acl\Role\RoleInterface $acl) : self` | Set an ACL role instance.
`hasRole() : bool` | Whether or not an ACL role instance is present.
`getUseAcl() : bool` | Whether or not to use ACLs; both the flag must be enabled and an ACL instance present.
`setUseAcl(bool $flag) : self` | Set the flag indicating whether or not to use ACLs.
`__toString()` | Cast the helper to a string value; relies on `render()`.
`render()` | Render the helper to a string.

In addition to the method stubs from the interface, the abstract class also
implements the following methods:

Method signature | Description
---------------------------------------------------------------------------- | -----------
`getIndent() : string` | Retrieve the indentation string to use; default is 4 spaces.
`setIndent(string|int $indent) : self` | Set the indentation to use. In the case of an integer, this indicates the number of spaces. Indentation can be specified for all but the `Sitemap` helper.
`setIndent(string\|int $indent) : self` | Set the indentation to use. In the case of an integer, this indicates the number of spaces. Indentation can be specified for all but the `Sitemap` helper.
`getMinDepth() : int` | Retrieve the minimum depth a page must have to be included in output
`setMinDepth(null|int $depth) : self` | Set the minimum depth a page must have to be included in output; `null` means no minimum.
`setMinDepth(null\|int $depth) : self` | Set the minimum depth a page must have to be included in output; `null` means no minimum.
`getMaxDepth() : int` | Retrieve the maximum depth a page must have to be included in output
`setMaxDepth(null|int $depth) : self` | Set the maximum depth a page must have to be included in output; `null` means no maximum.
`setMaxDepth(null\|int $depth) : self` | Set the maximum depth a page must have to be included in output; `null` means no maximum.
`getRenderInvisible() : bool` | Retrieve the flag indicating whether or not to render items marked as invisible; defaults to `false`.
`setRenderInvisible(bool $flag) : self` | Set the flag indicating whether or not to render items marked as invisible.
`__call() : mixed` | Proxy method calls to the registered container; this allows you to use the helper as if it were a navigation container. See [the example below](#proxying-calls-to-the-navigation-container).
Expand Down
18 changes: 9 additions & 9 deletions doc/book/helpers/links.md
View file
Expand Up @@ -98,15 +98,15 @@ link types. `RENDER_CUSTOM` denotes non-standard relations specified in pages.

Methods in the links helper:

Method signature | Description
--------------------------------------------------------------------------------------- | -----------
`getRenderFlag() : int` | Retrieves the render flag; default is `RENDER_ALL`.
`setRenderFlag(int $flag) : self` | Set the render flag; see examples below.
`findAllRelations(AbstractPage $page, int $flag = null) : array` | Finds all relations of all types for a given page.
`findRelation(AbstractPage $page, string $rel, string $type) : AbstractPage|array|null` | Finds all relations of a given type from a given page.
`searchRel*(AbstractPage $page) : AbstractPage|null` | Traverses a container to find forward relations to the `Start` page, the `Next` page, the `Prev`ious page, `Chapter`s, `Section`s, and `Subsection`s.
`searchRev*(AbstractPage $page) : AbstractPage:null` | Traverses a container to find reverse relations to `Section`s or `Subsection`s.
`renderLink(AbstractPage $page, string $attrib, string $relation) : string` | Renders a single `link` element.
Method signature | Description
----------------------------------------------------------------------------------------- | -----------
`getRenderFlag() : int` | Retrieves the render flag; default is `RENDER_ALL`.
`setRenderFlag(int $flag) : self` | Set the render flag; see examples below.
`findAllRelations(AbstractPage $page, int $flag = null) : array` | Finds all relations of all types for a given page.
`findRelation(AbstractPage $page, string $rel, string $type) : AbstractPage\|array\|null` | Finds all relations of a given type from a given page.
`searchRel*(AbstractPage $page) : AbstractPage\|null` | Traverses a container to find forward relations to the `Start` page, the `Next` page, the `Prev`ious page, `Chapter`s, `Section`s, and `Subsection`s.
`searchRev*(AbstractPage $page) : AbstractPage\|null` | Traverses a container to find reverse relations to `Section`s or `Subsection`s.
`renderLink(AbstractPage $page, string $attrib, string $relation) : string` | Renders a single `link` element.

## Basic usage

Expand Down

0 comments on commit 497e707

Please sign in to comment.