Package: Navigation
Customized subclass of Zend Framework’s Zend_Navigation class.
Creates a new navigation container
Parameters: |
|
---|
Saves the navigation in the global options table.
Parameters: |
|
---|
Loads the navigation from the global options table
Parameters: |
|
---|
Adds a page to the container. If a page does not have a valid id, it will give it one. If a direct child page already has another page with the same uid then it will not add the page. However, it will add the page as a child of this navigation if one of its descendants already has the page.
This method will inject the container as the given page’s parent bycalling {@link Zend_Navigation_Page::setParent()}.
Parameters: |
|
---|---|
Returns: | Zend_Navigation_Container fluent interface, returns self |
Returns an immediate child page that has a uid of $uid. If none exists, it returns null.
Parameters: |
|
---|---|
Returns: | Zend_Navigation_Page The page |
Adds a page to a container after normalizing it and its subpages
Parameters: |
|
---|---|
Returns: | Zend_Navigation_Container The container with the page added |
Creates an Omeka Navigation object by adding pages generated by Omeka plugins and other contributors via a filter (e.x. ‘public_navigation_main’). The filter should provide an array pages like they are added to Zend_Navigation_Container::addPages However, the page types should only be one of the following types: Omeka_Navigation_Page_Uri or Zend_Navigation_Page_Mvc. If the associated uri of any page is invalid, it will not add that page to the navigation. Also, it removes expired pages from formerly active plugins and other former handlers of the filter.
Parameters: |
|
---|
Add a normalized page to the navigation using parent::addPage() This needs to wrapped so that methods like createNavigationFromFilter() can add pages directly using the parent class method.
Parameters: |
|
---|---|
Returns: | Zend_Navigation_Container fluent interface, returns self |
Merges a page (and its subpages) into this navigation. If the page already exists in the navigation, then it attempts to add any new subpages of the page to it. If a subpages already exists in the navigation, then it it recursively attempts to add its new subpages to it, and so on.
Parameters: |
|
---|---|
Returns: | Zend_Navigation_Container $parentContainer the suggested parentContainer for the page. The parentContainer must already be in the navigation and remain so throughout the merge. |
Returns the page order of the last child page in the container. If no page exists in the container, it returns 0.
Parameters: |
|
---|---|
Returns: | int the last page order in the container |
Merges a navigation object into this navigation.
Parameters: |
|
---|
Adds pages generated by Omeka plugins and other contributors via a filter (e.x. ‘public_navigation_main’). The filter should provide an array pages like they are added to Zend_Navigation_Container::addPages However, the page types should only be one of the following types: Omeka_Navigation_Page_Uri or Omeka_Navigation_Page_Mvc. If the associated uri of any page is invalid, it will not add that page to the navigation. Also, it removes expired pages from formerly active plugins and other former handlers of the filter.
Parameters: |
|
---|
Returns an array of expired pages from this navigation, where all pages in the $excludeNav are considered non-expired.
Parameters: |
|
---|---|
Returns: | array The array of expired pages |
Prunes pages from this navigation. When a page is pruned its children pages are reattached to the first non-pruneable ancestor page.
Parameters: |
|
---|
Prune page from this navigation. When a page is pruned its children pages are reattached to the first non-pruneable ancestor page.
Parameters: |
|
---|
Returns an array of all pages from navigation that lack a uid in $excludePageUids
Parameters: |
|
---|---|
Returns: | array The array of other pages. |
Returns the navigation page associated with uid. It searches all descendant pages of this navigation If not page is associated, then it returns null.
Parameters: |
|
---|---|
Returns: | Omeka_Zend_Navigation_Page_Uri|Omeka_Navigation_Page_Mvc|null |
Returns the unique id for the page, which can be used to determine whether it can be added to the navigation
Parameters: |
|
---|---|
Returns: | String |
Recursively removes the given page from the parent container, including all subpages
Parameters: |
|
---|---|
Returns: | boolean Whether the page was removed |
Returns the option value associated with the default navigation during installation
Parameters: |
|
---|---|
Returns: | String The option value associated with the default navigation during installation. If no option is found for the option name, then it returns an empty string. |
Normalizes a page and its subpages so it can be added
Parameters: |
|
---|---|
Returns: | Omeka_Navigation_Page_Uri|Omeka_Navigation_Page_Mvc|null The normalized page |
Converts a Zend_Navigation_Page subclass object to a corresponding Omeka object
Parameters: |
|
---|---|
Returns: | Omeka_Navigation_Page_Uri|Omeka_Navigation_Page_Mvc The converted page |
Returns an nested associative array such that all array elements have replaced an key value to a new key value only if it is equal to a specific old key value.
Parameters: |
|
---|---|
Returns: | array The replaced associative array |
Full-text doc search.
Enter search terms or a module, class or function name.