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

  • DeleteBlock
  • DeleteOperation
  • EditBlock
  • Hooks
  • ManageBlock
  • Model
  • Module
  • SaveOperation
  • ServerName
  • Site
  • StatusOperation

Class Site

Representation of a website.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by ICanBoogie\ActiveRecord
Extended by Icybee\Modules\Sites\Site uses ICanBoogie\ActiveRecord\CreatedAtProperty, ICanBoogie\ActiveRecord\UpdatedAtProperty
Namespace: Icybee\Modules\Sites
Located at vendor/icanboogie-modules/sites/lib/activerecord/site.php

Methods summary

public
# __construct( string $model = 'sites' )

Default $model to "sites".

Default $model to "sites".

Parameters

$model
string
$model

Throws

InvalidArgumentException
if $model is neither a model identifier nor a Icybee\Modules\Sites\Model instance.

Overrides

ICanBoogie\ActiveRecord::__construct
public integer
# save( )

Clears the sites cache.

Clears the sites cache.

Returns

integer
Primary key value of the active record.

Overrides

ICanBoogie\ActiveRecord::save
protected string
# get_url( )

Returns the URL of the website.

Returns the URL of the website.

Returns

string
protected
# lazy_get_templates( )

Returns the available templates for the site

Returns the available templates for the site

protected
# lazy_get_partial_templates( )
public
# resolve_path( string $relative )

Resolve the location of a relative path according site inheritence.

Resolve the location of a relative path according site inheritence.

Parameters

$relative
string
$relative The path to the file to locate.
protected
# lazy_get_native( )
protected array
# lazy_get_translations( )

Returns the translations for this site.

Returns the translations for this site.

Returns

array
protected
# get_server_name( )
protected
# set_server_name( mixed $server_name )

Methods inherited from ICanBoogie\ActiveRecord

__sleep(), alter_persistent_properties(), delete(), get_model(), get_model_id()

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\ActiveRecord\CreatedAtProperty

get_created_at(), set_created_at()

Methods used from ICanBoogie\ActiveRecord\UpdatedAtProperty

get_updated_at(), set_updated_at()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

public Icybee\Modules\Pages\Page|null
# resolve_view_target( )

Return the page on which the view is displayed, or null if the view is not displayed. This method is injected by the "pages" module.

Return the page on which the view is displayed, or null if the view is not displayed. This method is injected by the "pages" module.

Returns

Icybee\Modules\Pages\Page|null
public string
# resolve_view_url( )

Return the URL of the view. This method is injected by the "pages" module.

Return the URL of the view. This method is injected by the "pages" module.

Returns

string

Constants summary

string SITEID 'siteid'
#
string SUBDOMAIN 'subdomain'
#
string DOMAIN 'domain'
#
string PATH 'path'
#
string TLD 'tld'
#
string TITLE 'title'
#
string ADMIN_TITLE 'admin_title'
#
string LANGUAGE 'language'
#
string TIMEZONE 'tmezone'
#
string NATIVEID 'nativeid'
#
string STATUS 'status'
#
string CREATED_AT 'created_at'
#
string UPDATED_AT 'updated_at'
#
string BASE '/protected/'
#
integer STATUS_OK 200
#
integer STATUS_UNAUTHORIZED 401
#
integer STATUS_NOT_FOUND 404
#
integer STATUS_UNAVAILABLE 503
#

Properties summary

public mixed $siteid
#
public string $path
#
public string $tld
#
public string $domain
#
public string $subdomain
#
public mixed $title
#
public string $admin_title
#
public integer $weight
#
public string $language
#
public integer $nativeid
#
public string $timezone
#
public string $email
#
public integer $status
#

Properties inherited from ICanBoogie\ActiveRecord

$model_id

Magic properties

public array $translations
#

Translations for the site.

Translations for the site.

public ICanBoogie\DateTime $created_at
#

Date and time at which the site was created.

Date and time at which the site was created.

public ICanBoogie\DateTime $updated_at
#

Date and time at which the site was updated.

Date and time at which the site was updated.

Magic properties inherited from ICanBoogie\ActiveRecord

$model, $model_id

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0