PHP Класс Pressbooks\Metadata

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$currentVersion integer The value for option: pressbooks_metadata_version
$upgradeCheckboxes array We need to upgrade these for compatibility with custom_metdata().

Открытые методы

Метод Описание
__construct ( )
changeDefaultBookCover ( ) Change default book cover from PNG to JPG
fixDoubleSlashBug ( ) Fix a double slash bug by reactivating theme with new settings.
getDeprecatedComparisonTable ( string $table, boolean $new_as_keys = false ) : array
getLicenseXml ( string $type, string $copyright_holder, string $src_url, string $title, $lang = '' ) : string Takes a known string from metadata, builds a url to hit an api which returns an xml response
getMetaPost ( ) : WP_Post | boolean Returns the latest "metadata" post. There should be only one per book.
getMetaPostMetadata ( ) : array Return metadata attached to the latest "metadata" post.
getMicrodataElements ( ) : string Returns an html blob of microdata elements based on what is set in 'Book Information'
getMidByKey ( integer $post_id, string $meta_key ) : integer | boolean Return a database ID for a given meta key.
getSeoMetaElements ( ) : string Returns an html blob of meta elements based on what is set in 'Book Information'
getWebLicenseHtml ( SimpleXMLElement $response ) : string Returns an HTML blob if given an XML object
makeThumbnailsForBookCover ( ) Generate thumbnails for a user uploaded cover
resetLandingPage ( ) Fix broken landing page
upgrade ( integer $version ) Upgrade metadata.
upgradeBook ( ) Upgrade book metadata.
upgradeBookInformation ( ) Upgrade book information.
upgradeCustomCss ( ) Upgrade Custom CSS types.
upgradeEcommerce ( ) Upgrade Ecommerce metadata

Описание методов

__construct() публичный Метод

public __construct ( )

changeDefaultBookCover() публичный Метод

Change default book cover from PNG to JPG
public changeDefaultBookCover ( )

fixDoubleSlashBug() публичный Метод

Fix a double slash bug by reactivating theme with new settings.
См. также: Pressbooks\Pressbooks::registerThemeDirectories
public fixDoubleSlashBug ( )

getDeprecatedComparisonTable() публичный Метод

Устаревший:
public getDeprecatedComparisonTable ( string $table, boolean $new_as_keys = false ) : array
$table string
$new_as_keys boolean
Результат array

getLicenseXml() статический публичный Метод

Takes a known string from metadata, builds a url to hit an api which returns an xml response
См. также: https://api.creativecommons.org/docs/readme_15.html
static public getLicenseXml ( string $type, string $copyright_holder, string $src_url, string $title, $lang = '' ) : string
$type string license type
$copyright_holder string of the page
$src_url string of the page
$title string of the page
Результат string $xml response

getMetaPost() публичный Метод

Returns the latest "metadata" post. There should be only one per book.
public getMetaPost ( ) : WP_Post | boolean
Результат WP_Post | boolean

getMetaPostMetadata() публичный Метод

Return metadata attached to the latest "metadata" post.
public getMetaPostMetadata ( ) : array
Результат array

getMicrodataElements() статический публичный Метод

Returns an html blob of microdata elements based on what is set in 'Book Information'
static public getMicrodataElements ( ) : string
Результат string

getMidByKey() публичный Метод

Return a database ID for a given meta key.
public getMidByKey ( integer $post_id, string $meta_key ) : integer | boolean
$post_id integer
$meta_key string
Результат integer | boolean

getSeoMetaElements() статический публичный Метод

Returns an html blob of meta elements based on what is set in 'Book Information'
static public getSeoMetaElements ( ) : string
Результат string

getWebLicenseHtml() статический публичный Метод

Returns an HTML blob if given an XML object
static public getWebLicenseHtml ( SimpleXMLElement $response ) : string
$response SimpleXMLElement
Результат string $html blob of copyright information

makeThumbnailsForBookCover() публичный Метод

Generate thumbnails for a user uploaded cover
public makeThumbnailsForBookCover ( )

resetLandingPage() публичный Метод

Fix broken landing page
public resetLandingPage ( )

upgrade() публичный Метод

Upgrade metadata.
public upgrade ( integer $version )
$version integer

upgradeBook() публичный Метод

Upgrade book metadata.
public upgradeBook ( )

upgradeBookInformation() публичный Метод

Upgrade book information.
public upgradeBookInformation ( )

upgradeCustomCss() публичный Метод

Upgrade Custom CSS types.
См. также: Pressbooks\Activation::wpmuActivate
public upgradeCustomCss ( )

upgradeEcommerce() публичный Метод

Upgrade Ecommerce metadata
public upgradeEcommerce ( )

Описание свойств

$currentVersion статическое публичное свойство

The value for option: pressbooks_metadata_version
См. также: upgrade()
static public int $currentVersion
Результат integer

$upgradeCheckboxes публичное свойство

We need to upgrade these for compatibility with custom_metdata().
public array $upgradeCheckboxes
Результат array