Autodoc
  • Namespace
  • Class
  • Tree

Namespaces

  • BlueTihi
    • Context
  • Brickrouge
    • Element
      • Nodes
    • Renderer
    • Widget
  • ICanBoogie
    • ActiveRecord
    • AutoConfig
    • CLDR
    • Composer
    • Core
    • Event
    • Exception
    • HTTP
      • Dispatcher
      • Request
    • I18n
      • Translator
    • Mailer
    • Modules
      • Taxonomy
        • Support
      • Thumbnailer
        • Versions
    • Object
    • Operation
      • Dispatcher
    • Prototype
    • Routes
    • Routing
      • Dispatcher
    • Session
  • Icybee
    • ActiveRecord
      • Model
    • ConfigOperation
    • Document
    • EditBlock
    • Element
      • ActionbarContextual
      • ActionbarSearch
      • ActionbarToolbar
    • FormBlock
    • Installer
    • ManageBlock
    • Modules
      • Articles
      • Cache
        • Collection
        • ManageBlock
      • Comments
        • ManageBlock
      • Contents
        • ManageBlock
      • Dashboard
      • Editor
        • Collection
      • Files
        • File
        • ManageBlock
      • Forms
        • Form
        • ManageBlock
      • I18n
      • Images
        • ManageBlock
      • Members
      • Modules
        • ManageBlock
      • Nodes
        • ManageBlock
        • Module
      • Pages
        • BreadcrumbElement
        • LanguagesElement
        • ManageBlock
        • NavigationBranchElement
        • NavigationElement
        • Page
        • PageController
      • Registry
      • Search
      • Seo
      • Sites
        • ManageBlock
      • Taxonomy
        • Terms
          • ManageBlock
        • Vocabulary
          • ManageBlock
      • Users
        • ManageBlock
        • NonceLogin
        • Roles
      • Views
        • ActiveRecordProvider
        • Collection
        • View
    • Operation
      • ActiveRecord
      • Constructor
      • Module
      • Widget
    • Rendering
  • None
  • Patron
  • PHP

Classes

  • Blueprint
  • BlueprintNode
  • BreadcrumbElement
  • Content
  • ContentModel
  • CopyOperation
  • DeleteOperation
  • EditBlock
  • ExportBlock
  • ExportOperation
  • Hooks
  • ImportOperation
  • LanguagesElement
  • ListView
  • ManageBlock
  • Model
  • Module
  • NavigationBranchElement
  • NavigationElement
  • NavigationExcludeOperation
  • NavigationIncludeOperation
  • Page
  • PageController
  • PopPage
  • PopTemplate
  • QueryOperationOperation
  • SaveOperation
  • TemplateEditorsOperation
  • UpdateTreeOperation

Class Model

Nodes model.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by ICanBoogie\ActiveRecord\Table
Extended by ICanBoogie\ActiveRecord\Model implements ArrayAccess
Extended by Icybee\ActiveRecord\Model\Constructor
Extended by Icybee\Modules\Nodes\Model
Extended by Icybee\Modules\Pages\Model
Namespace: Icybee\Modules\Pages
Located at vendor/icanboogie-modules/pages/lib/activerecords/page.model.php

Methods summary

public
# save( array $properties, mixed $key = null, array $options = array() )

Before saving the record, we make sure that it is not its own parent.

Before saving the record, we make sure that it is not its own parent.

Overrides

Icybee\Modules\Nodes\Model::save
public boolean
# delete( mixed $key )

Before deleting the record, we make sure that it is not used as a parent page or as a location target.

Before deleting the record, we make sure that it is not used as a parent page or as a location target.

Parameters

$key
mixed
$key Identifier of the record.

Returns

boolean

Throws

ICanBoogie\Exception
if the node to delete is the native target of another node.

Overrides

Icybee\Modules\Nodes\Model::delete
protected ICanBoogie\ActiveRecord\Query
# scope_ordered( ICanBoogie\ActiveRecord\Query $query, mixed $direction = 1 )

Changes the order of the query with "weight, create".

Changes the order of the query with "weight, create".

Parameters

$query
ICanBoogie\ActiveRecord\Query
$query
$direction

Returns

ICanBoogie\ActiveRecord\Query
public array[int]object
# blueprint( integer $site_id )

Returns the blueprint of the pages tree.

Returns the blueprint of the pages tree.

Parameters

$site_id
integer
$site_id Identifier of the website.

Returns

array[int]object
public Icybee\Modules\Pages\Page
# find_home( integer $siteid )

Returns the home page of the specified site.

Returns the home page of the specified site.

The record cache is used to retrieve or store the home page. Additionnaly the home page found is stored for each site.

Parameters

$siteid
integer
$siteid Identifier of the site.

Returns

Icybee\Modules\Pages\Page
public Icybee\Modules\Pages\Page
# find_by_path( string $path )

Finds a page using its path.

Finds a page using its path.

Parameters

$path
string
$path

Returns

Icybee\Modules\Pages\Page
public static
# nestNodes( array $entries, array & $entries_by_ids = null )

Nest an array of nodes, using their parentid property.

Nest an array of nodes, using their parentid property.

Children are stored in the children property of their parents.

Parent is stored in the parent property of its children.

Parameters

$entries
array
$entries The array of nodes.
$entries_by_ids
array
$parents The array of nodes, where the key is the entry's nid.
public static
# setNodesDepth( mixed $nodes, mixed $max_depth = false, mixed $depth = 0 )

Walk the nodes and sets their depth level.

Walk the nodes and sets their depth level.

Parameters

$nodes
mixed
$nodes The nodes to walk through.
$max_depth
mixed
$max_depth The maximum depth level of the nodes. Nodes beyond the max_depth are removed. Default to false (no maximum depth level).
$depth
mixed
$depth The depth level to start from. Default to 0.
public static
# levelNodesById( mixed $nodes )

Creates an array from all the nested nodes, where keys are node's Id.

Creates an array from all the nested nodes, where keys are node's Id.

Parameters

$nodes
mixed
$nodes

Methods inherited from Icybee\Modules\Nodes\Model

including_user(), obtain_uuid(), scope_offline(), scope_online(), scope_similar_language(), scope_similar_site(), scope_visible()

Methods inherited from Icybee\ActiveRecord\Model\Constructor

__construct(), find(), find_using_constructor(), scope_own()

Methods inherited from ICanBoogie\ActiveRecord\Model

__call(), __get(), belongs_to(), eliminate(), get_activerecord_class(), get_all(), get_count(), get_exists(), get_id(), get_one(), has_scope(), new_record(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), retrieve(), scope(), store()

Methods inherited from ICanBoogie\ActiveRecord\Table

__invoke(), drop(), execute(), filter_values(), get_alias(), get_connection(), get_name(), get_name_unprefixed(), get_parent(), get_primary(), get_schema(), insert(), install(), is_installed(), lazy_get_extended_schema(), prepare(), query(), quote(), resolve_statement(), save_callback(), truncate(), uninstall(), update()

Methods inherited from ICanBoogie\Object

from(), resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Magic methods inherited from ICanBoogie\ActiveRecord\Model

all(), average(), count(), exists(), group(), joins(), limit(), maximum(), minimum(), offset(), one(), order(), select(), sum(), where()

Constants summary

Constants inherited from Icybee\ActiveRecord\Model\Constructor

T_CONSTRUCTOR

Constants inherited from ICanBoogie\ActiveRecord\Model

ACTIVERECORD_CLASS, BELONGS_TO, CLASSNAME, ID, T_ACTIVERECORD_CLASS, T_CLASS, T_ID

Constants inherited from ICanBoogie\ActiveRecord\Table

ALIAS, CONNECTION, EXTENDING, IMPLEMENTING, NAME, SCHEMA, T_ALIAS, T_CONNECTION, T_EXTENDS, T_IMPLEMENTS, T_NAME, T_SCHEMA

Properties summary

Properties inherited from Icybee\ActiveRecord\Model\Constructor

$constructor

Properties inherited from ICanBoogie\ActiveRecord\Model

$activerecord_class, $attributes

Properties inherited from ICanBoogie\ActiveRecord\Table

$alias, $connection, $implements, $name, $name_unprefixed, $parent, $primary, $schema, $select_join, $update_join

Magic properties inherited from ICanBoogie\ActiveRecord\Model

$activerecord_cache, $activerecord_class, $all, $count, $exists, $id

Magic properties inherited from ICanBoogie\ActiveRecord\Table

$alias, $connection, $extended_schema, $name_unprefixed, $parent, $primary, $schema

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0