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
                ),
        ),
),

define(function(require, exports) {
        exports.format = function(formatter, args) {
                args.$container.css({
                        'font-size': 20
                });
        }
});

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

Extends¶

An application can extend multiple others applications.

An application that extends an other application will be loaded when the extended application is loaded.

Configuration and language files of an extended application can be extended by an application that extends. Views can be replaced.

To proceed, put extended files in subdirectory apps/application_extended.

• local/applications/app_a/

  • config/apps/app_b/common.config.php
  • lang/apps/app_b/common.lang.php
  • views/apps/app_b/common.view.php

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,
        ),
        // The callback function which check availability of the enhancer
        'valid_container' => 'validContainer',
    ),
);

// In this example, the enhancer won't be available in WYSIWYGs of monkeys.
function validContainer($enhencer, $container)
{
    $container_class = get_class($container);
    return $container_class !== 'Nos\Monkey\Model_Monkey';
}

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',
            ),
        ),
    ),
);

Templates are not used directly in Novius OS. Template variations by context is used.

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 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',
    ),
);

notify¶

Allows you to notify the user when displaying the appdesk.

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 array.

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...

The field name is determined using the key. Then, for each field:

To choose how the field is displayed, you only need to specify either form (a native HTML <input>) or a renderer (like a date picker or a wysiwyg), you don’t need both. If both keys are filled, the renderer will be used to display the field (and the form key will be ignored).

Configuration example:

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

Advanced configuration example:

<?php
$options = array(
    $value => $label
    ...
);
return array(
    'name' => array(
        'label' => 'Text shown next to the field',
        'form' => array(
            'type' => 'select',
            'options' => $options,
        ),
        'populate' => function($item) {
            //example: returns the id of a related model
            return $item->relation->rel_id;
        },
        'before_save' => function($item, $data) {
            //example: set relation properly
            unset($item->relation);
            if (!empty($data['name']) {
                $item->relation = Model::find($data['name']);
            }
        }
);

<?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.

property Nos\Orm\Model::$providers¶

Defines the behaviours of model.

Relation:	Required. Wherein the relation is based on the provider. Must be a multiple relation and have cascade_save activate.
Value_property:	Optional. Set to value if empty. The fields containing the provider value.
Key_property:	Optional. Set to key if empty. The fields containing the provider key.
Value_relation:	Optional. If set, must contains a single relation name and then the provider value become the model.

In Novius OS, you can configure model by a file configuration. For sample: if in your application you define a Model_Monkey class, you can create a file config/model/monkey.config.php to extend configuration. All this attributes can be defined in configuration file : properties, table_name, title_property, observers, behaviours, providers and all relations types (has_many, belongs_to, has_one, many_many, twinnable_has_many, twinnable_belongs_to, twinnable_has_one, twinnable_many_many and 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

Native Providers¶

property Nos\Orm\Model::$medias¶

Provider 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 = $Model_Media; // Attach a Model_Media named 'cv'

$item->medias->cv = null; // Detach a media from an item
// or
unset($item->medias->cv);

property Nos\Orm\Model::$wysiwygs¶

Provider 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', with content 'foo'.

$item->wysiwygs->summary = null; // Remove a wysiwyg from an item
// or
unset($item->wysiwygs->summary);

Methods¶

static Nos\Orm\Model::title_property¶

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

static Nos\Orm\Model::table¶

Returns:	The DB table name of model.

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

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

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

static Nos\Orm\Model::addRelation($type, $name, array $options = array())¶

Add a relation to model

Parameters:	$type (string) – A valid relation type. $name (string) – The relation name to add. $options (array) – The relation options
Throws:	\FuelException if $type is not a valid one.

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

Get the class’s providers and what they provide

Parameters:	$specific (string) – Provider to retrieve info of, allows direct param access by using dot notation $default (mixed) – Return value when specific key wasn’t found
Throws:	Nos\Orm\UnknownProviderException
Returns:	The specific provider if it exist and is requested or the defaut value. Else, array of all providers.

static Nos\Orm\Model::addProvider($name, array $properties)¶

Add a provider to model

Parameters:	$name (string) – The provider name $properties (array) – The provider properties
Throws:	Nos\Orm\InvalidProviderException

static Nos\Orm\Model::configModel¶

Returns:	Array configurations of the model.

static Nos\Orm\Model::getApplication¶

Returns:	Application name of the model.

Nos\Orm\Model::event($method, $args = array())¶

Trigger an event (caught by behaviours) on the item.

Parameters:	$method (string) – Name of the event, also name of the method Behaviours. $args (array) – Arguments of the event.

static Nos\Orm\Model::eventStatic($method, $args = array())¶

Trigger an event (caught by behaviours) on the model class.

Parameters:	$method (string) – Name of the event, also name of the method Behaviours. $args (array) – Arguments of the event.

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¶

Nos\Page\Model_Page::htmlAnchor($attributes = array())¶

Parameters:	$attributes (array) – Array of attributes to be applied to the anchor tag. If key ‘href’ is set in $attributes parameter: if is a string, used for href attribute if is an array, used as argument of ->url() method If key ‘text’ is set in $attributes parameter, its value replace page title
Returns:	Returns an HTML anchor tag with, by default, page URL in href and page title in text.

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

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

Relations¶

property Nos\Template\Variation\Model_Template_Variation::$pages¶

• Relation type: has_many.
• Model: Nos\Page\Model_Page

Providers¶

property Nos\Template\Variation\Model_Template_Variation::$menus¶

• Model: Nos\Menu\Model_Menu

Behaviours¶

• Contextable
• Author

Methods¶

Nos\Template\Variation\Model_Template_Variation::configCompiled($reload = false)¶

Parameters:	$reload (bool) – If true, reload the variation config
Returns:	Returns the configuration array of the template variation.

Nos\Template\Variation\Model_Template_Variation::templateConfig()¶

Returns:	Returns the configuration array of the template use by the variation.

static Nos\Template\Variation\Model_Template_Variation::getTemplateVariationDefault($context)¶

Parameters:	$context (string) – The context ID
Returns:	The default Model_Template_Variation for this context

Columns¶

One of wysiwyg_foreign_id and wysiwyg_foreign_context_common_id columns is NULL for each row.

Constants¶

constant Nos\Model_Content_Nuggets::DEFAULT_CATCHER¶

Default value for the content_catcher column.

Columns¶

Configuration¶

property Nos\Orm_Behaviour_Author::$created_by_property¶

Column used to store the user ID when the item is created. Its data type must be unsigned int.

property Nos\Orm_Behaviour_Author::$updated_by_property¶

Column used to store the user ID when the item is updated (also used upon creation). Its data type must be unsigned int.

Example¶

<?php

class Model_Page extends \Nos\Orm\Model
{
    protected static $_properties = array(
        // ...
        'page_created_by_id' => array(
            'default' => null,
            'data_type' => 'int unsigned',
            'null' => true,
            'convert_empty_to_null' => true,
        ),
        'page_updated_by_id' => array(
            'default' => null,
            'data_type' => 'int unsigned',
            'null' => true,
            'convert_empty_to_null' => true,
        ),
    );

    protected static $_behaviours = array(
        'Nos\Orm_Behaviour_Author' => array(
            'created_by_property' => 'page_created_by_id',
            'updated_by_property' => 'page_updated_by_id',
        ),
    );
}

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_state_property¶

Always required, both for the yes/no and the date range modes.

Column used to store the publication state. Its data type must be int:

• 0 means not published;
• 1 means always published;
• 2 means publication depends on a date range (when combining the 2 modes).

property Nos\Orm_Behaviour_Publishable::$publication_start_property¶

Required for date range mode. Column used to store the publication start date. Its data type must be datetime.

property Nos\Orm_Behaviour_Publishable::$publication_end_property¶

Required for date range mode. Column used to store the publication end date. Its data type must be datetime.

property Nos\Orm_Behaviour_Publishable::$options¶

Methods¶

Nos\Orm_Behaviour_Publishable::published()¶

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

Nos\Orm_Behaviour_Publishable::planificationStatus()¶

Returns:	0 (not published), 1 (published) or 2 (scheduled).

Nos\Orm_Behaviour_Publishable::publicationStart()¶

Returns:	the publication start date, MySQL format.

Nos\Orm_Behaviour_Publishable::publicationEnd()¶

Returns:	the publication end date, MySQL format.

Other¶

This behaviour extends Model->find().

You can use the published key in the where array. Appropriate conditions will be added, according to the configuration of the behaviour. Especially useful with the date range mode (and start / end dates).

Example¶

<?php

// Yes/No state
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Publishable' => array(
                        'publication_state_property' => 'page_published',
                ),
        );
}

$page = Model_Page::find(1);

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

<?php

// Date range mode (combined with Yes/No state)
class Model_Page extends \Nos\Orm\Model
{
        protected static $_behaviours = array(
                'Nos\Orm_Behaviour_Publishable' => array(
                        'publication_state_property' => 'page_published',
                        'publication_start_property' => 'page_publication_start',
                        'publication_end_property'   => 'page_publication_end',
                ),
        );
}