HumHub Documentation (unofficial)

ViewMeta extends BaseObject
in package

Metadata Service for the View class.

Supports:

  • standard meta tags
  • OpenGraph tags
  • Twitter Card tags

Example usage in controller:

$this->view->setPageTitle(Yii::t('PostModule.base', 'Post'), true);
$this->view->meta->setContent($post);
$this->view->meta->setDescription(RichTextToPlainTextConverter::process($post->message));
$this->view->meta->setImages($post->fileManager->findAll());
Tags
since
1.13

Table of Contents

Properties

$view  : View
$content  : ContentActiveRecord
$contentType  : string
The type metadata to preview the content with Open Graph protocol
$description  : string
$images  : array<string|int, string>
The Preview Image Urls
$title  : string
$url  : string
The URL metadata to preview the content with Open Graph protocol

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
getDescription()  : string
getImages()  : array<string|int, string>
getTitle()  : string
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
registerMetaTags()  : mixed
Called by View to register Tags before rendering
setContent()  : mixed
setDescription()  : void
setImages()  : void
Sets an array of File or Image URLs
setTitle()  : void
addMetaTags()  : mixed
Add metadata to view to preview the content with Open Graph protocol
registerOpenGraphMetaTags()  : void
Register metadata to preview the content on Facebook and other compatible websites
registerTwitterMetaTags()  : void
Register metadata to preview the content on Twitter
setDefaults()  : mixed
Automatically sets default values

Properties

$contentType

The type metadata to preview the content with Open Graph protocol

private string $contentType

$description

private string $description

$images

The Preview Image Urls

private array<string|int, string> $images = []

$url

The URL metadata to preview the content with Open Graph protocol

private string $url

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

getDescription()

public getDescription() : string
Return values
string

getImages()

public getImages() : array<string|int, string>
Return values
array<string|int, string>

getTitle()

public getTitle() : string
Return values
string

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

registerMetaTags()

Called by View to register Tags before rendering

public registerMetaTags() : mixed

setDescription()

public setDescription(string $description) : void
Parameters
$description : string

setImages()

Sets an array of File or Image URLs

public setImages(array<string|int, File>|string $images) : void
Parameters
$images : array<string|int, File>|string

setTitle()

public setTitle(string $title) : void
Parameters
$title : string

addMetaTags()

Add metadata to view to preview the content with Open Graph protocol

private addMetaTags() : mixed

registerOpenGraphMetaTags()

Register metadata to preview the content on Facebook and other compatible websites

private registerOpenGraphMetaTags() : void

registerTwitterMetaTags()

Register metadata to preview the content on Twitter

private registerTwitterMetaTags() : void

setDefaults()

Automatically sets default values

private setDefaults() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results