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

  • AdjustImage
  • AdjustThumbnail
  • EditBlock
  • GalleryBlock
  • GalleryController
  • Hooks
  • Image
  • ImageUpload
  • ManageBlock
  • Model
  • Module
  • NodeRelation
  • PopImage
  • PopOrUploadImage
  • SaveOperation
  • Thumbnail
  • ThumbnailDecorator
  • ThumbnailOperation
  • UploadImage
  • UploadOperation

Class Image

Representation of a managed image.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by ICanBoogie\ActiveRecord
Extended by Icybee\Modules\Nodes\Node implements Brickrouge\CSSClassNames uses Brickrouge\CSSClassNamesProperty, ICanBoogie\ActiveRecord\CreatedAtProperty, ICanBoogie\ActiveRecord\UpdatedAtProperty
Extended by Icybee\Modules\Files\File
Extended by Icybee\Modules\Images\Image
Namespace: Icybee\Modules\Images
Located at vendor/icanboogie-modules/images/lib/activerecords/image.php

Methods summary

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

Defaults the model to "images".

Defaults the model to "images".

Parameters

$model
string
$model

Throws

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

Overrides

Icybee\Modules\Files\File::__construct
public string
# __toString( )

Returns an IMG element.

Returns an IMG element.

Returns

string
public integer
# save( )

If Icybee\Modules\Files\File::HTTP_FILE is defined, the ICanBoogie\HTTP\File instance is used to set the Icybee\Modules\Files\File::$mime and Icybee\Modules\Files\File::$size properties, as well as the Icybee\Modules\Nodes\Node::$title property if it is empty.

If Icybee\Modules\Files\File::HTTP_FILE is defined, the ICanBoogie\HTTP\File instance is used to set the Icybee\Modules\Files\File::$mime and Icybee\Modules\Files\File::$size properties, as well as the Icybee\Modules\Nodes\Node::$title property if it is empty.

After the record is saved, the Icybee\Modules\Files\File::HTTP_FILE property is removed. Also, the Icybee\Modules\Files\File::$path property is updated.

Returns

integer
Primary key value of the active record.

Overrides

Icybee\Modules\Files\File::save
protected integer
# get_surface( )

Returns the surface of the image, computed from the Icybee\Modules\Images\Image::$width and Icybee\Modules\Images\Image::$height properties.

Returns the surface of the image, computed from the Icybee\Modules\Images\Image::$width and Icybee\Modules\Images\Image::$height properties.

Returns

integer

Methods inherited from Icybee\Modules\Files\File

get_extension(), url()

Methods inherited from Icybee\Modules\Nodes\Node

__get(), alter_persistent_properties(), get_constructor(), get_css_class_names(), get_language(), get_site(), get_slug(), get_user(), lazy_get_native(), lazy_get_next(), lazy_get_previous(), lazy_get_translation(), lazy_get_translations(), lazy_get_translations_keys(), set_site(), set_user(), translation()

Methods inherited from ICanBoogie\ActiveRecord

__sleep(), 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 inherited from Brickrouge\CSSClassNames

css_class()

Methods used from Brickrouge\CSSClassNamesProperty

css_class(), get_css_class()

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(), __set(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

public ICanBoogie\Modules\Thumbnailer\Thumbnail
# thumbnail( )

Returns

ICanBoogie\Modules\Thumbnailer\Thumbnail

Constants summary

string WIDTH 'width'
#
string HEIGHT 'height'
#
string ALT 'alt'
#

Constants inherited from Icybee\Modules\Files\File

DESCRIPTION, HTTP_FILE, MIME, PATH, SIZE

Constants inherited from Icybee\Modules\Nodes\Node

CONSTRUCTOR, CREATED_AT, IS_ONLINE, LANGUAGE, NATIVEID, NID, SITEID, SLUG, TITLE, UID, UPDATED_AT, UUID

Properties summary

public integer $width
#

Width of the image in pixels.

Width of the image in pixels.

public integer $height
#

Height of the image in pixels.

Height of the image in pixels.

public string $alt
#

Alternative text, used when the image cannot be displayed.

Alternative text, used when the image cannot be displayed.

Properties inherited from Icybee\Modules\Files\File

$description, $mime, $path, $size

Properties inherited from Icybee\Modules\Nodes\Node

$constructor, $is_online, $language, $nativeid, $nid, $siteid, $slug, $title, $uid, $uuid

Properties inherited from ICanBoogie\ActiveRecord

$model_id

Magic properties

public read-only integer $surface
#

The surface of the image, computed from the Icybee\Modules\Images\Image::$width and Icybee\Modules\Images\Image::$height properties.

The surface of the image, computed from the Icybee\Modules\Images\Image::$width and Icybee\Modules\Images\Image::$height properties.

public read-only Icybee\Modules\Nodes\Node $consumer
#

The node to which the image is associated.

The node to which the image is associated.

Magic properties inherited from Icybee\Modules\Files\File

$extension

Magic properties inherited from Icybee\Modules\Nodes\Node

$created_at, $css_class, $native, $next, $previous, $site, $translation, $updated_at, $user

Magic properties inherited from ICanBoogie\ActiveRecord

$model, $model_id

Magic properties inherited from ICanBoogie\Object

$prototype

Magic properties used from Brickrouge\CSSClassNamesProperty

$css_class

Autodoc API documentation generated by ApiGen 2.8.0