Urlenhancer

class Nos\Orm_Behaviour_Urlenhancer
Used for Nos\Orm\Model displayed in the front-office by an URL Enhancer.

Configuration

property Nos\Orm_Behaviour_Urlenhancer::$enhancers

Required. Array of enhancers ID which can generate an URL for the item.

Listed enhancers must define a get_url_model($item, $params) method.

Methods

Nos\Orm_Behaviour_Urlenhancer::urls($params = array())
Parameters:
  • $params (array) –
    enhancer:Specify enhancer ID. Restricts the search to the specified enhancer.
Returns:

Associative array of all possibles URLs for this item

  • key : page_id::item_slug. item slug is the URL part generate by enhancer.
  • value : Absolute URL.

Nos\Orm_Behaviour_Urlenhancer::url($params = array())
Parameters:
  • $params (array) –

    See Orm_Behaviour_Urlenhancer::urls.

    canonical:If true, return canonical URL of item.
    preview:If true, return even unpublished URL of item.
Returns:

Absolute URL of item or null if item can’t be displayed in front.

Nos\Orm_Behaviour_Urlenhancer::url_canonical($params = array())
Parameters:
Returns:

Absolute canonical URL of item or null if item can’t be displayed in front.

Alias for ->url(array('canonical' => true)).

If the item is sharable, returns the URL set in the shared data (content nugget).

Nos\Orm_Behaviour_Urlenhancer::preview_url()
Returns:Absolute canonical URL of item, even if it’s not published, or null if item can’t be displayed in the front-office.

Alias for ->url_canonical(array('preview' => true)).

Example

<?php
class Model_Monkey extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Urlenhancer' => array(
                        'enhancers' => array('noviusos_monkey'),
                ),
        );
}
Read the Docs v: 0.2
Versions
latest
chiba.2
chiba.1
0.2
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.