Novius OS - API Documentation¶

Configuration¶

To change the contexts of your Novius OS instance, edit the local/config/contexts.config.php file.

<?php
return array(
        'sites' => array(
                'main' => array(
                        'title' => 'Main site',
                        'alias' => 'Main',
                ),
        ),

        'locales' => array(
                'fr_FR' => array(
                        'title' => 'Français',
                        'flag' => 'fr',
                ),
                'en_GB' => array(
                        'title' => 'English',
                        'flag' => 'gb',
                ),
                'ja_JP' => array(
                        'title' => '日本語',
                        'flag' => 'jp',
                ),
        ),

        'contexts' => array(
                'main::en_GB' => array(),
                'main::fr_FR' => array(),
                'main::ja_JP' => array(),
        ),
);

<?php
return array(
        'sites' => array(
                'main' => array(
                        'title' => 'Main site',
                        'alias' => 'main',
                ),
                'mobile' => array(
                        'title' => 'Mobile site',
                        'alias' => 'Mobile',
                ),
                'event' => array(
                        'title' => 'Event site',
                        'alias' => 'Event',
                ),
        ),

        'locales' => array(
                'en_GB' => array(
                        'title' => 'English',
                        'flag' => 'gb',
                ),
                'fr_FR' => array(
                        'title' => 'Français',
                        'flag' => 'fr',
                ),
                'es_ES' => array(
                        'title' => 'Español',
                        'flag' => 'es',
                ),
        ),

        'contexts' => array(
                'main::en_GB' => array(),
                'main::fr_FR' => array(),
                'main::es_ES' => array(),
                'mobile::fr_FR' => array(),
                'event::en_GB' => array(),
        ),
);

<?php
return array(
        'sites' => array(
                'main' => array(
                        'title' => 'Main site',
                        'alias' => 'main',
                ),
        ),

        'locales' => array(
                'en_GB' => array(
                        'title' => 'English',
                        'flag' => 'gb',
                ),
        ),

        'contexts' => array(
                'main::en_GB' => array(),
        ),
);

Domain Names¶

By default, the first context will answer to the root of your domain, the following contexts in a site_code/language_code/ subdirectory (e.g.: main/es_ES/).

But for each context, you can choose the URI (including a domain and optionally a directory) it will answer to, by specifying it the the associated configuration array.

    <?php

'contexts' => array(
    'main::en_GB' => array(), // Uses the default domain
    'main::fr_FR' => array(
        'http://www.mysite.com/fr/',
    ),
    'main::es_ES' => array(
        'http://www.mysite.com/es/',
    ),
    'mobile::fr_FR' => array(
        'http://www.mysite.com/mobile/',
    ),
    'event::en_GB' => array(
        'http://www.mysite.com/event/',
    ),
),

<?php

'contexts' => array(
    'main::en_GB' => array(
        'http://www.monsite.com/',
    ),
    'main::fr_FR' => array(
        'http://www.mysite.fr/',
    ),
    'main::es_ES' => array(
        'http://www.monsite.es/',
    ),
    'mobile::fr_FR' => array(
        'http://mobile.monsite.fr/',
    ),
    'event::en_GB' => array(
        'http://event.monsite.com/',
    ),
),

<?php
'contexts' => array(
        'main::en_GB' => array(
                'http://www.monsite.com/',
        ),
        'main::fr_FR' => array(
                'http://www.mysite.fr/',
        ),
        'main::es_ES' => array(
                'http://www.monsite.es/',
        ),
        'mobile::fr_FR' => array(
                'http://mobile.monsite.fr/',
                'http://www.monsite-mobile.fr/',
                'http://www.mysite.com/mobile/',
        ),
        'event::en_GB' => array(
                'http://event.monsite.en/',
        ),
),

Going live¶

You will probably need to define, for each of your contexts, different URLs between your local (development) and production instances. You can do that using environment-specific config files.

PHP nosActions¶

$container.nosAction() executes an action bound to a DOM element.

To define an action in PHP:

<?php
'action' => array(
        'action' => 'actionName', // nosTabs, nosDialog, confirmationDialog, nosAjax, window.open, document.location...
        // Other keys are array and depends on the actionName
),

// Example with nostabs
'action' => array(
        'action' => 'nosTabs',
        'tab' => array(
                'url' => 'admin/nos/page/page/insert_update/{{id}}',
                'label' => '{{title}}',
        ),
),

This syntax is used to define actions for:

• Launchers
• Data catchers
• buttons and menus in the Appdesk
• Crud Controller

PHP cellFormatters¶

Used to format the value displayed in a column of a grid in the Appdesk.

<?php
array(
        'type' => 'css',
        'css' => array(
                'text-align' => 'center',
        ),
),

<?php
array(
        'type' => 'icon',
        'column' => 'column_icon', // URL is retrieved from the 'column_icon' column
        'size' => 16
),

// Or
array(
        'type' => 'icon',
        'src' => 'static/path/icon.png',
),

// Or
array(
        'type' => 'icon',
        'mapping' => array(
                '1' => 'static/path/icon-1.png', // If column value is '1', use this URL
                '2' => 'static/path/icon-2.png',
        ),
),

<?php
array(
        'type' => 'iconClasses',
        'column' => 'column_icon_classes', // CSS classes are fetch from the 'column_icon_classes' column
),

// Or
array(
        'type' => 'iconClasses',
        'classes' => 'icon icon-foo',
),

<?php
array(
        'type' => 'link',
        'action' => 'default', // Binds the default action (e.g.: 'edit the item' in the most of the cases)
),

// Or
array(
        'type' => 'link',
        'action' => 'Namespace\Model_Example.result', // Binds the 'result' action of the item, which is a Namespace\Model_Example instance.
),

// Or
array(
        'type' => 'link',
        'action' => array(
                'action' => 'nosTabs', // Open a new tab
                'tab' => array(
                        'url' => 'admin/nos/page/page/insert_update/{{_id}}', // {{_id}} will be replaced by the item's ID
                        'label' => '{{_title}}', // {{_title}} will be replaced by the item's title
                ),
        ),
),

<?php
'data_mapping' => array(
        'column_a' => array(
                'title' => 'Column a'
                'cellFormaters' => array(
                        'bold' => array(
                                'type' => 'bold',
                        ),
                        'center' => array(
                                'type' => 'css',
                                'css' => array(
                                        'text-align' => 'center',
                                ),
                        ),
                ),
        ),
        'column_b' => array(
                'title' => 'Column b'
                'cellFormaters' => array(
                        'icon' => array(
                                'type' => 'icon',
                                'column' => 'column_icon',
                                'size' => 16
                        ),
                ),
        ),
        'column_icon' => array(
                value => function($item) {
                        return $item->icon();
                },
        ),
),

Launchers¶

A launcher is an icon on the home tab.

A launcher is defined by an associative array. Key is launcher ID, launcher properties is an associative array :

<?php

return array(
    'launchers' => array(
        'noviusos_page' => array(
            'name' => 'Webpages',
            // 'icon' is not set, so the default icon will be used
            'action' => array(
                // open a tab
                'action' => 'nosTabs',
                'tab' => array(
                    'url' => 'admin/noviusos_page/appdesk/index',
                    // 'iconUrl' is not set, so the default icon will be used
                ),
            ),
        ),
    ),
);

Enhancers¶

Enhancers are used in WYSIWYG editors. They provide functionalities for the front-office.

For example, the ‘Forms’ application allows users to insert forms in their web pages (using an enhancer).

URL enhancers, a specific type of enhancers, handle their own URLs. For example, every blog post has an URL.

An enhancer is defined with:

<?php

return array(
    'noviusos_form' => array(
        'title' => 'Form',
        'desc'  => '',
        // Here it's just a regular enhancer
        'enhancer' => 'noviusos_form/front/main',
        //'urlEnhancer' => 'noviusos_form/front/main',
        'iconUrl' => 'static/apps/noviusos_form/img/icons/form-16.png',
        // We'll use our controller to generate the preview
        'previewUrl' => 'admin/noviusos_form/enhancer/preview',
        // And the user has to configure it
        'dialog' => array(
            'contentUrl' => 'admin/noviusos_form/enhancer/popup',
            'width' => 450,
            'height' => 400,
            'ajax' => true,
        ),
    ),
);

Templates¶

Templates are similar to other CMS’ templates or themes. They provide a layout for the front-office.

In Novius OS, a template contains one or more WYSIWYG editable area(s), which are is placed inside a grid.

The grid has a size of cols * rows, and each editable area is positioned using absolute coordinates (it’s similar to position: absolute in CSS).

Each WYSIWYG editable area has:

• a name: it’s the key in the layout array (see below) ;
• a position: absolute coordinates inside the grid (similar to left and top in CSS) ;
• a size: similar to width and height in CSS.

In the end, a template is defined with:

Here’s an example:

<?php

return array(
    'templates' => array(
        'top_menu' => array(
            'file' => 'noviusos_templates_basic::top_menu',
            'title' => 'Default template with a top menu',
            'cols' => 1,
            'rows' => 1,
            'layout' => array(
                // There is one WYSIWYG named 'content'
                // Position inside the grid: <left>,<top>,<width>,<height>
                'content' => '0,0,1,1',
            ),
        ),
    ),
);

Data catchers¶

Data mapping¶

Associative array where each key => value defines a column, all keys are optionals.

<?php
return array(
    'data_mapping' => array(
        'column_a' => array(
            'title' => 'Column A',
            'column' => 'col_a',
            'multiContextHide' => true,
            'cellFormatters' => array(
                'center' => array(
                    'type' => 'css',
                    'css' => array('text-align' => 'center'),
                ),
            ),
        ),
        'column_b' => array(
            'title' => 'B',
            'search_column' => 'col_b_search',
            'search_relation' => 'rel',
            'value' => function($item) {
                return 'test';
            },
        ),
        // ...
    ),
);

<?php
return array(
    'data_mapping' => array(
        'column_a',
    ),
);

<?php
return array(
    'data_mapping' => array(
        'column_b' => 'col_b',
    ),
);

<?php
return array(
    'data_mapping' => array(
        'column_a' => array(
            'title' => 'Column a'
        ),
        'context',
        'column_b' => array(
            'title' => 'Column b'
        ),
    ),
    // ...
);

I18n¶

This key contains all the common translations.

<?php
return array(
    'i18n' => array(
        // Crud
        'notification item added' => __('Done! The item has been added.'),
        'notification item saved' => __('OK, all changes are saved.'),
        'notification item deleted' => __('The item has been deleted.'),

        // General errors
        'notification item does not exist anymore' => __('This item doesn’t exist any more. It has been deleted.'),
        'notification item not found' => __('We cannot find this item.'),

        // ... see the 'framework/config/i18n_common.config.php' file to include the appropriate keys depending on your item
    ),
);

Actions¶

This key contains all the common actions related to the model. 5 actions which are automatically added:

The action key can be filled in two different ways.

The most common way is to use an associative array:

<?php
return array(
    // ...
    'actions' => array(
        'action_1' => array(/* configuration */),
        'action_2' => array(/* configuration */),
        // ...
    ),
);

If you want to change the order in which the actions are displayed, two keys are to be defined:

<?php
return array(
    // ...
    'actions' => array(
        'list' => array(
            'action_1' => array(/* configuration */),
            'action_2' => array(/* configuration */),
            // ...
        ),
        'order' => array(
            'action_2',
            'action_1'
        ),
    ),
);

Each action is an associative array. Key is the action ID, and value is an array defining the action configuration:

<?php
return array(
    'actions '=> array(
        'action_id' => array(
            'action' => array(
                'action' => 'confirmationDialog',
                'dialog' => array(
                    'contentUrl' => '{{controller_base_url}}delete/{{_id}}',
                    'title' => 'Delete',
                ),
            ),
            'label' => __('Delete'),
            'primary' => true,
            'icon' => 'trash',
            'red' => true,
            'targets' => array(
                'grid' => true,
                'toolbar-edit' => true,
            ),
            'disabled' => function($item) {
                return false;
            },
            'visible' => function($params) {
                return !isset($params['item']) || !$params['item']->is_new();
            },
        ),
    ),
);

<?php
return array(
    // ...
    'actions '=> array(
        'add' => false,
    ),
);

Icons¶

This key contains all common icons related to the model. Structure is similar to the icons key of the Metadata configuration file :

<?php
return array(
    'icons' => array(
        64 => 'static/apps/noviusos_page/img/64/page.png',
        32 => 'static/apps/noviusos_page/img/32/page.png',
        16 => 'static/apps/noviusos_page/img/16/page.png',
    ),
);

query¶

Associative array. All keys are optional. Most keys are similar than the find function second parameters.

data_mapping¶

Associative or simple array. Defines which data_mapping items from Common configuration we display (mostly filtering).

Is is also possible to define new custom data_mapping items which will be only used on the appdesk.

If only value is defined, appdesk will display the data_mapping item from common configuration.

If it is a key => value association (value must then be an array), then the data_mapping item from common configuration is extended by the value.

<?php
return array(
    // ...
    'data_mapping '=> array(
        'col1', // will display the col1 data_mapping item from common configuration.
        'col2' => array( // if col2 exists on common configuration data_mapping key then it is extended ; otherwise, the item is added to appdesk.
            // ...
        ),
    ),
);

inspectors¶

Associative or simple array. Defines which inspectors are used on appdesk.

If is also possible to define new custom inspectors which will be only used on the appdesk.

If only value is defined: * appdesk will display the inspector located at inspector/inspector_name if the value is inspector_name. * it also supports inspector class names (MyAppController_Admin_Inspector_Name).

If it is a key => value association (value must then be an array), then the inspector configuration is extended by the value.

<?php
return array(
    // ...
    'inspectors '=> array(
        'inspector1', // will display the inspector located at inspector/inspector1.
        '\My\App\Controller_Admin_Inspector_Name', // will display the inspector which class is \My\App\Controller_Admin_Inspector_Name
        'inspector2' => array( // if inspector/inspector2 exists, then it is extended ; otherwise it creates a new inspector
            // ...
        ),
    ),
);

views¶

Associative array defining different way of displaying the appdesk. The key is the view identifier. Value is view configuration:

inputs¶

How to process additional parameters sent to the appdesk. Associative array, to define a callback for each parameter.

<?php
return array(
    // ...
    'inputs' => array(
        'monk_species_id' => function($value, $query) {
            // ...
            return $query;
        },
    ),
);

thumbnails¶

Can the appdesk display items as thumbnails ?

If defined to true, data_mapping has to define two keys:

tree¶

Defines how the model tree is constructed on the appdesk. It is automatically filled when model has the Tree behaviour. Associative array:

appdesk¶

Associative array describing how appdesk interacts and is displayed. All items are automatically generated, but can be overloaded.

input¶

Associative array:

appdesk¶

Associative array. All keys are optional:

Model inspector¶

Associative array:

Model tree inspector¶

Associative array:

Date inspector¶

Associative array:

Plain data inspector¶

Displays static data. Associative array:

environment_relation¶

The environment_relation must contain a relation name of type Orm\\BelongsTo.

It allows to use the GET['environment_id'] in an action of this model.

It will be used to populate the column associated with the relation. Examples include:

• Add a page at a specific location inside the tree (with a pre-selected parent) ;
• Add a media in a specific folder ;
• Add a monkey inside a species ;
• Add an blog post inside a category.

Some examples:

<?php
// Add a sub-page action
'action' => array(
    'action' => 'nosTabs',
    'tab' => array(
        // The 'page_parent_id' will be populated with $_GET['environment_id'] from the action
        'url' => '{{controller_base_url}}insert_update?environment_id={{_id}}&context={{_context}}',
    ),
),


// Add a media in this folder action
'action' => array(
    'action' => 'nosTabs',
    'tab' => array(
        // The 'media_folder_id' will be populated with $_GET['environment_id'] from the action
        'url' => '{{controller_base_url}}insert_update?environment_id={{id}}',
    ),
),

tab¶

The tab configuration array has a special labels key, to handle several label depending on the case.

• insert and update must contain plain string value ;
• update can either contain a plain string value, or a callable taking one argument: the $item ;
• The default value for labels.update is the item’s title.

<?php
return array(
        'tab' => array(
                'iconUrl' => 'static/apps/noviusos_monkey/img/16/monkey.png',
                // Add form will user 'insert'
                // Edit form will use item's title
                // Translate form (multilingual) will use 'blankSlate'
                'labels' => array(
                        'insert' => __('Add a monkey'),
                        'blankSlate' => __('Translate a monkey'),
                ),
        ),
);

views¶

layout¶

The layout is a data passed to the parameters of the view. It list all the views needed to render the form.

There are two syntaxes:

• the full syntax ;
• a simplified syntax, which is used 90% of the time.

The full syntax for using a layout is the following:

<?php
'layout' => array(
    'first_view' => array(
        'view' => 'nos::form/layout_standard',
        'params' => array(
            // View data (depends on the view).
            'title' => '',
            'content' => '',
        ),
    ),
    'second_view' => array(
        'view' => 'noviusos_page::admin/page_form',
        // No 'params'
    ),
    // More views can be used here.
),

In addition to view-specific params / data, Novius OS always include the following vars:

• $item : the instance of the model currently edited (or added / translated).
• $fieldset : the form instance which holds all fields definition.

Because 90% of the time, we want to use nos::form/layout_standard as the view for the layout, a simplified syntax was created: only write the view params of the standard layout.

It’s much more limitating because you can only use one view to render the layout, and it has to be nos::form/layout_standard. But that’s what should be used 90% of the time.

<?php
'layout' => array(
    // View data
    'title' => '',
    'content' => '',
),

We only need to define the view data for the standard layout, and it will be wrapped like so:

<?php
$layout = array(
    array(
        'view' => 'nos::form/layout_standard',
        'params' =>  $layout,
    ),
);

<?php
// The following...
return array(
        'layout' => array(
                'view_1' => array(
                        'view' => 'nos::form/layout_standard',
                        'params' => array(
            // View data (depends on the view).
                        ),
                ),
        ),
);

// ... is the same as this:
return array(
        'layout' => array(
                // View params for ``nos::form/layout_standard``.
        ),
);

fields¶

Contains the fields definition, including:

• a label ;
• how the field is displayed: a native HTML <input> or a custom renderer (like date picker or wysiwyg) ;
• validation rules.

The fields syntax is based on an existing FuelPHP feature, which is used to configure form attributes for each column of a Model.

In addition to standard form fields, Novius OS has renderers, which are a bit more advanced. For instance, they allow to select a media, a page, a date...

Configuration example:

<?php
return array(
        'name' => array(
                'label' => 'Text shown next to the field',
                'form' => array(
                        'type' => 'text',
                        'value' => 'Default value',
                ),
                'validation' => array(),
);

<?php
return array(
        'gender' => array(
                'label' => 'Gender',
                'form' => array(
                        'type' => 'select',
                        'options' => array(
                                'm' => 'Male',
                                'f' => 'Female',
                        )
                ),
                'validation' => array('required'),
        ),
);

<?php
return array(
        'save' => array(
                'form' => array(
                        'type' => 'submit',
                        'tag' => 'button',
                        'value' => 'Save',
                ),
        ),
);

Configuration¶

property Nos\Orm\Model::$title_property¶

Defines the title property of a model. Can be a column name or a closure (which take current $iitem as parameter).

If not defined, automatically set to first column which has title, label or name in its name, or (as last resort) the first varchar.

property Nos\Orm\Model::$behaviours¶

Defines the behaviours of model. Same syntax as observers.

property Nos\Orm\Model::$attachment¶

Defines the attachments of a model. Attachment is a special type of relations created for Novius OS. See Nos\Attachment.

<?php
class Model_Example extends \Nos\Orm\Model
{
        // In this example, attachments use defaults properties
        protected static $_attachment = array(
                'avatar' => array(),
                'cv' => array(),
        );

        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Contextable' => array(
                        'events' => array('before_insert'),
                        'context_property' => 'ex_context',
                ),
        );

        // In this example, use a column name for defined title_property
        protected static $_title_property = 'ex_reference';

<?php
return array(
        'attachment' => array(
                'avatar' => array(
                        'dir' => 'namespace/model_name/avatar/',
                        'image' => true,
                        'alias' => 'avatar',
                ),
                'curriculum_vitae' => array(
                        'dir' => 'namespace/model_name/curriculum_vitae/',
                        'alias' => 'cv',
                        'extensions' => array('doc', 'odt', 'pdf'),
                        'check' => array('ClassName', 'methodName'),
                ),
        ),

        'behaviours' => array(
                'Nos\Orm_Behaviour_Contextable' => array(
                        'events' => array('before_insert'),
                        'context_property' => 'ex_context',
                ),
        ),

        // In this example, use a closure for defined title_property
        'title_property' => function($item) {
                return $item->ex_reference;
        },
);

Relations¶

property Nos\Orm\Model::$linked_wysiwygs¶

• Relation type: has_many.
• Model: Nos\Model_Wysiwyg

property Nos\Orm\Model::$linked_medias¶

• Relation type: has_many.
• Model: Nos\Media\Model_Link

Accessors¶

property Nos\Orm\Model::$medias¶

Accessor for Nos\Media\Model_Link linked to model.

<?php
$item->medias->avatar; // Get a Model_Link named 'avatar'
$item->medias->avatar->media; // Get Model_Media named 'avatar'

$item->medias->cv->media = $Model_Media; // Set a Model_Media named 'cv'

property Nos\Orm\Model::$wysiwygs¶

Accessor for Nos\Model_Wysiwyg linked to model.

<?php
$item->wysiwygs->content; // Get a Model_Wysiwyg named 'content'
$item->wysiwygs->content->wysiwyg_text; // Get content of Model_Wysiwyg named 'content'

$item->wysiwygs->summary = 'foo'; // Set a Model_Wysiwyg named 'content', width content 'foo'.

Methods¶

static Nos\Orm\Model::title_property¶

Returns:	Title property of model. See Model::$title_property.

static Nos\Orm\Model::behaviours($specific = null, $default = null)¶

Nos\Orm\Model::get_possible_context()¶

Returns:	Array of possible contexts ID for current item. See Multi-Contexts.

static Nos\Orm\Model::add_properties($properties)¶

Parameters:	$properties (array) – Additional properties (merged).

static Nos\Orm\Model::prefix¶

Returns:	Prefix of column name. Computed from the primary key name (everything before the first _ character).

Nos\Orm\Model::title_item()¶

Returns:	Returns the item’s title, calculated from Model::$title_property.

Nos\Orm\Model::pick($column[, $column[, $column[, ...]]])¶

Parameters:	$column (array) – A column name.
Returns:	Returns the first non empty column. Will add column prefix (see Model::prefix) when needed.

Constants¶

Relations¶

property Nos\Page\Model_Page::$children¶

• Relation type: has_many.
• Model: Model_Page

property Nos\Page\Model_Page::$parent¶

• Relation type: belongs_to.
• Model: Model_Page

Behaviours¶

• Twinnable
• Tree
• Virtual path
• Sortable
• Publishable

Methods¶

static Nos\Page\Model_Page::link¶

Returns:	string The href and target attributes for an HTML link, such as href="..." target="...".

static Nos\Page\Model_Page::url($params = array())¶

Parameters:	$params (array) – preview: If set, returns a preview URL
Returns:	The absolute URL of the page

Columns¶

Constants¶

constant Nos\Model_Content_Nuggets::DEFAULT_CATCHER¶

Default value for the content_catcher column.

Columns¶

Configuration¶

property Nos\Orm_Behaviour_Contextable::$context_property¶

Required. Column used to store the item’s context. Its data type must be varchar(25).

property Nos\Orm_Behaviour_Contextable::$default_context¶

Default context to use if not set when creating an item.

Methods¶

Nos\Orm_Behaviour_Contextable::get_context()¶

Returns:	The item’s context.

Other¶

This behaviour extends Model->find().

Add option to where array passed to method: you can use the context key as an alias to search in the column Orm_Behaviour_Contextable::$context_property.

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Contextable' => array(
                        'events' => array('before_insert'),
                        'context_property' => 'form_context',
                ),
        );
}

Configuration¶

property Nos\Orm_Behaviour_Publishable::$publication_bool_property¶

Required. Column used to store the publication state. Its data type must be boolean.

Methods¶

Nos\Orm_Behaviour_Publishable::published()¶

Returns:	true or false depending on whether the item is published or not.

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Publishable' => array(
                        'publication_bool_property' => 'page_published',
                ),
        );
}

$page = Model_Page::find(1);

if ($page->published()) {
        // Do something
}

Configuration¶

property Nos\Orm_Behaviour_Sharable::$data¶

Associative array of different types of data forming a content nuggets.

• Keys can be one of DataCatcher constants.

• Values are associative array.

  value:	A column name or a closure. See Examples.
  useTitle:	Help label indicate which property of item is use as default value.
  options:	Associative array of different options. Only for DataCatcher::TYPE_URL.
  possibles:	Associative array of possibles values. Only for DataCatcher::TYPE_IMAGE.

Methods¶

Nos\Orm_Behaviour_Sharable::get_default_nuggets()¶

Returns:	Array containing the default content nuggets of an item.

Nos\Orm_Behaviour_Sharable::get_catcher_nuggets($catcher = Model_Content_Nuggets::DEFAULT_CATCHER)¶

Parameters:	$catcher (string) – Data catchers ID.
Returns:	The Model_Content_Nuggets of this item for the specified data catcher.

Nos\Orm_Behaviour_Sharable::get_sharable_property($property = null, $default = null)¶

Parameters:	$property (string) – A property name. $default (string) – A default value if data property is null.
Returns:	Orm_Behaviour_Sharable::$data if $property is null. Otherwise, property value with default fallback.

Nos\Orm_Behaviour_Sharable::data_catchers()¶

Retrieves all the data catchers that can use the content nugget of this item (checks the required_data of a data catcher and ).

returns:	All the valid data catchers for this item (keys are the data catcher names).

Nos\Orm_Behaviour_Sharable::possible_medias()¶

Retrieves all possible medias that can be associated with the item. Search for linked medias and images inserted in the WYSIWYGs.

returns:	Associative array of all Model_Media, Model_Media ID in keys, of item.

Nos\Orm_Behaviour_Sharable::get_nugget_content($catcher)¶

Retrieves the personalised content nugget of a data catcher, merged with the default content nugget of the item.

param string $catcher:
	Data catchers ID.
returns:	Array A content nugget.

Examples¶

<?php
array(
        \Nos\DataCatcher::TYPE_TITLE => array(
                'value' => 'monk_name',
        ),
);

<?php
array(
        \Nos\DataCatcher::TYPE_TITLE => array(
                'value' => function($monkey) {
                        return $monkey->monk_name;
                },
        ),
);

<?php

class Model_Monkey extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Sharable' => array(
                        'data' => array(
                                \Nos\DataCatcher::TYPE_TITLE => array(
                                        'value' => 'monk_name',
                                        'useTitle' => __('Use monkey name'),
                                ),
                                \Nos\DataCatcher::TYPE_URL => array(
                                        'value' => function($monkey) {
                                                $urls = $monkey->urls();
                                                if (empty($urls)) {
                                                        return null;
                                                }
                                                reset($urls);

                                                return key($urls);
                                        },
                                        'options' => function($monkey) {
                                                return $monkey->urls();
                                        },
                                ),
                                \Nos\DataCatcher::TYPE_TEXT => array(
                                        'value' => function($monkey) {
                                                return $monkey->monk_summary;
                                        },
                                        'useTitle' => __('Use monkey summary'),
                                ),
                                \Nos\DataCatcher::TYPE_IMAGE => array(
                                        'value' => function($monkey) {
                                                $possible = $monkey->possible_medias();

                                                return Arr::get(array_keys($possible), 0, null);
                                        },
                                        'possibles' => function($monkey) {
                                                return $monkey->possible_medias();
                                        },
                                ),
                        ),
                ),
        );
}

Configuration¶

property Nos\Orm_Behaviour_Sortable::$sort_property¶

Required. Column name use for save sort index. Column must have type double.

property Nos\Orm_Behaviour_Sortable::$sort_order¶

ASC (default) ou DESC

Methods¶

Nos\Orm_Behaviour_Sortable::move_before($item)¶

Parameters:	$item (Model) – Moves the current item before this one.

Nos\Orm_Behaviour_Sortable::move_after($item)¶

Parameters:	$item (Model) – Moves the current item after this one.

Nos\Orm_Behaviour_Sortable::move_to_last_position()¶

Moves the current item to the last position (of its siblings).

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Sortable' => array(
                        'events' => array('after_sort', 'before_insert'),
                        'sort_property' => 'page_sort',
                ),
        );
}

$page_1 = Model_Page::find(1);
$page_2 = Model_Page::find(2);

$page_2->move_after($page_1);

Configuration¶

property Nos\Orm_Behaviour_Tree::$parent_relation¶

Required. Name of the parent relation.

property Nos\Orm_Behaviour_Tree::$children_relation¶

Required. Name of the children relation.

property Nos\Orm_Behaviour_Tree::$level_property¶

Column used to store the item’s depth inside the tree. Data type must be int.

Method¶

Nos\Orm_Behaviour_Tree::get_parent()¶

Returns:	Model parent item, if it exists, null otherwise.

Nos\Orm_Behaviour_Tree::set_parent($new_parent)¶

Set a new parent for the item.

If the item is twinnable and if it exists in several contexts, all contexts will be moved synchronously.

Parameters:	$new_parent (Model) – New parent Model of the item (use null to remove the parent).
Throws:	Exception when: the item is moved in its own tree ; the item is twinnable and its parent does not exist in one of the contexts of the current item.

Nos\Orm_Behaviour_Tree::find_children($where = array(), $order_by = array(), $options = array())¶

Returns:	All direct children of item.

Children can be filter and / or sort by parameters.

This method use native method Model->find().

$options parameter are passed to ->find() like that:

<?php
$options = \Arr::merge($options, array(
        'where'    => $where,
        'order_by' => $order_by,
));

Nos\Orm_Behaviour_Tree::find_children_recursive($include_self = true)¶

Parameters:	$include_self (boolean) – If true, include current item in return.
Returns:	All children of item and their descendants.

Nos\Orm_Behaviour_Tree::find_root()¶

Returns:	First ascendant of item in tree or null if item has no parent.

Other¶

This behaviour extends Model->find().

Add option to where array passed to method : you can use parent key as alias for search in Orm_Behaviour_Tree::$parent_relation relation.

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Tree' => array(
                        'events' => array('before_query', 'after_delete'),
                        'parent_relation' => 'parent',
                        'children_relation' => 'children',
                        'level_property' => 'page_level',
                ),
        );

        protected static $_has_many = array(
                'children' => array(
                        'key_from'       => 'page_id',
                        'model_to'       => 'Nos\Model_Page',
                        'key_to'         => 'page_parent_id',
                        'cascade_save'   => false,
                        'cascade_delete' => false,
                ),
        );

        protected static $_belongs_to = array(
                'parent' => array(
                        'key_from'       => 'page_parent_id',
                        'model_to'       => 'Nos\Model_Page',
                        'key_to'         => 'page_id',
                        'cascade_save'   => false,
                        'cascade_delete' => false,
                ),
        );

}

Configuration¶

property Nos\Orm_Behaviour_Twinnable::$common_id_property¶

Required. Column used to store the common ID between twinned items. Data type must be int.

property Nos\Orm_Behaviour_Twinnable::$is_main_property¶

Required. Column used to store if the item is the main item among twin items. Data type must be boolean.

Methods¶

Nos\Orm_Behaviour_Twinnable::delete_all_context()¶

Removes all items twinned to the current item, including the current item itself.

Nos\Orm_Behaviour_Twinnable::is_main_context()¶

Returns:	True if item is the main among twin items.

Nos\Orm_Behaviour_Twinnable::find_context($context)¶

Parameters:	$context (mixed) – Can be Array of contexts ID. all, to receive all contexts. Context ID. main, to receive main twin item.
Returns:	A twinned item, or an array of twinned items, null or array() if none.

Nos\Orm_Behaviour_Twinnable::find_main_context()¶

Returns:	The main item among the twins.

Alias for ->find_context('main').

Nos\Orm_Behaviour_Twinnable::find_other_context($filter = array())¶

Parameters:	$filter (array) – Array of contexts ID. If set, return only twin items which the context belongs to array $filter.
Returns:	Array of twin items, current item exclude.

Nos\Orm_Behaviour_Twinnable::get_all_context()¶

Returns:	Array of all twinned contexts, including the one of the current item.

Nos\Orm_Behaviour_Twinnable::get_other_context($filter = array())¶

Parameters:	$filter (array) – Array of contexts ID. If set, return only twinned contexts which belongs to array $filter.
Returns:	Array of all twinned contexts ID, excluding the one of the current item.

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Twinnable' => array(
                        'events' => array('before_insert', 'after_insert', 'before_save', 'after_delete', 'change_parent'),
                        'context_property'      => 'page_context',
                        'common_id_property' => 'page_context_common_id',
                        'is_main_property' => 'page_context_is_main',
                        'invariant_fields'   => array(),
                ),
        );
}

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:	$params (array) – See Orm_Behaviour_Urlenhancer::url.
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'),
                ),
        );
}

Configuration¶

property Nos\Orm_Behaviour_Virtualname::$virtual_name_property¶

Required. Column used to store the slug.

property Nos\Orm_Behaviour_Virtualname::$unique¶

true, false or 'context' if uniqueness must be checked by context.

Methods¶

Nos\Orm_Behaviour_Virtualname::virtual_name()¶

Returns:	Item slug.

Nos\Orm_Behaviour_Virtualname::friendly_slug($slug)¶

Parameters:	$slug (string) – A slug to clean.
Returns:	A clean slug, lowercase, without forbidden characters.

Example¶

<?php
class Model_Monkey extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Virtualname' => array(
                        'events' => array('before_save', 'after_save'),
                        'virtual_name_property' => 'monk_virtual_name',
                ),
        );
}

Configuration¶

property Nos\Orm_Behaviour_Virtualpath::$virtual_path_property¶

Required. Column name use for save virtual path.

property Nos\Orm_Behaviour_Virtualpath::$extension_property¶

Required. If it’s a string, it will be appended to the virtual path. If it’s an array:

before:	String to add to extension start.
after:	String to add to extension end.
property:	Column name used to store the extension.

property Nos\Orm_Behaviour_Virtualpath::$extension_property

Required. Name of the parent relation use to generate the first part of the virtual path.

Methods¶

Nos\Orm_Behaviour_Virtualpath::virtual_path($dir = false)¶

Parameters:	$dir (boolean) – If true, extension is replaced by a final /.
Returns:	Virtual path of the item.

Nos\Orm_Behaviour_Virtualpath::extension()¶

Returns:	Return extension part of the virtual path.

Example¶

<?php
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Virtualpath' => array(
                        'events' => array('before_save', 'after_save', 'change_parent'),
                        'virtual_name_property' => 'page_virtual_name',
                        'virtual_path_property' => 'page_virtual_url',
                        'extension_property' => '.html',
                        'parent_relation' => 'parent',
                ),
        );
}

Entry points¶

property Nos\Nos::$entry_point¶

The Novius OS entry point. Equal to one of the following constants.

constant Nos\Nos::ENTRY_POINT_ADMIN¶

constant Nos\Nos::ENTRY_POINT_FRONT¶

constant Nos\Nos::ENTRY_POINT_404¶

constant Nos\Nos::ENTRY_POINT_INSTALL¶

::main_controller()¶

static Nos\Nos::main_controller¶

Returns:	Instance of the main controller.

::hmvc()¶

static Nos\Nos::hmvc($where, $args = null)¶

Parameters:	$where (mixed) – Route for the request. $args (array) – The method parameters.

Executes an HMVC request.

::parse_wysiwyg()¶

static Nos\Nos::parse_wysiwyg($content)¶

Parameters:	$content (string) – A Nos\Model_Wysiwyg content.
Returns:	Prepare wysiwyg content for display.

Replace enhancers by their content.

Replace Model_Page and Model_Media IDs by theirs URLs

Add URL prefix on anchors (to work with <base href="">).

Methods¶

static Nos\Controller_Front::getContextUrl¶

Returns:	Absolute URL of the current context.

static Nos\Controller_Front::getPage¶

Returns:	Current Model_Page displayed.

static Nos\Controller_Front::getWysiwygName¶

Returns:	Current wysiwyg ID processed.

static Nos\Controller_Front::getUrl¶

Returns:	Current absolute URL.

static Nos\Controller_Front::getPageUrl¶

Returns:	Relative (to Controller_Front::getContextUrl) URL of the current page.

static Nos\Controller_Front::getEnhancedUrlPath¶

Returns:	Relative (to Controller_Front::getContextUrl) URL of the current URL enhancer. False if no current URL enhancer.

Same that Controller_Front::getPageUrl ending with / instead of .html.

static Nos\Controller_Front::getEnhancerUrl¶

Returns:	Part of the URL processed by the URL enhancer. False if no current URL enhancer.

static Nos\Controller_Front::setBaseHref($base_href)¶

Parameters:	$base_href (string) – Sets a new <base href=""> for the current HTML output.

static Nos\Controller_Front::setTitle($title, $template = null)¶

Parameters:	$title (string) – Set a new title for the current HTML. $template (string) – If set, use it to calculate the title. Placeholder :title will be replaced by $title.

static Nos\Controller_Front::setMetaDescription($meta_description)¶

Parameters:	$meta_description (string) – Set a meta description for the current HTML output.

static Nos\Controller_Front::setMetaKeywords($meta_keywords)¶

Parameters:	$meta_keywords (string) – Set a meta keywords for the current HTML output.

static Nos\Controller_Front::setMetaRobots($meta_robots)¶

Parameters:	$meta_robots (string) – Set a meta robots for the current HTML output.

static Nos\Controller_Front::addMeta($meta)¶

Parameters:	$meta (string) – A HTML meta tag to add in the current HTML output.

static Nos\Controller_Front::addJavascript($url, $footer = true)¶

Parameters:	$url (string) – URL of a JavaScript library to add in the current HTML output. $footer (boolea) – If true, add script at the end of HTML output. If false, add in the <head>.

static Nos\Controller_Front::addJavascriptInline($js, $footer = true)¶

Parameters:	$url (string) – Javascript code to add in the current HTML output. $footer (boolea) – If true, add script at the end of HTML output. If false, add in the <head>.

static Nos\Controller_Front::addCss($url)¶

Parameters:	$url (string) – URL of a CSS file to add in the current HTML output.

static Nos\Controller_Front::addCssInline($css)¶

Parameters:	$css (string) – CSS code to add in the current HTML output.

static Nos\Controller_Front::isPreview¶

Returns:	Boolean, true if current page is requested in the preview mode.

Configuration¶

property Nos\Attachment::$attached¶

Required. The attached ID.

property Nos\Attachment::$dir¶

Required. Directory path, where the attachment is stored. Relative to local/data/files.

property Nos\Attachment::$alias¶

An URL alias to access the directory path.

property Nos\Attachment::$extensions¶

Array of valid files extensions.

property Nos\Attachment::$image¶

If true, accepts only files with an image extension. Same that extensions set to array('jpg', 'gif', 'png', 'jpeg').

property Nos\Attachment::$check¶

Used it to make the attachment private. A callback function to check permissions against. It takes a single parameter: Attachement instance.

Methods¶

static Nos\Attachment::forge($attached, $config)¶

Parameters:	$attached (string) – The attached ID. $config (mixed) – If is a string, use it to load configuration array. Array otherwise: dir: Attachment::$dir alias: Attachment::$alias extensions: Attachment::$extensions image: Attachment::$image check: Attachment::$check
Returns:	A new Nos\Attachment.

Nos\Attachment::newFile()¶

Returns:	Get the new attachment file path if one, false if no file exists.

Nos\Attachment::path()¶

Returns:	Get the attachment file path or false if no file exists.

Nos\Attachment::filename()¶

Returns:	Get the attachment filename or false if no file exists.

Nos\Attachment::extension()¶

Returns:	Get the attachment extension or false if no file exists.

Nos\Attachment::isImage()¶

Returns:	True if the Attachment is an image, false otherwise.

Nos\Attachment::url()¶

Returns:	Get the attachment url or false if no file exists.

Nos\Attachment::urlResized($max_width = 0, $max_height = 0)¶

Parameters:	$max_width (array) – Max width of the image. $max_height (array) – Max height of the image.
Returns:	Get the resized url for the Attachment or false if no file exists or it’s not an image.