org.attribyte.wp.model

Class Site

java.lang.Object

org.attribyte.wp.model.Site

public class Site
extends java.lang.Object

An immutable site.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	baseURL The base (home) URL for the site.
Term	defaultCategory The default category.
java.lang.String	description The site description.
long	id The site id.
java.lang.String	permalinkStructure The permalink format string.
java.lang.String	title The site title.

Constructor Summary

Constructors

Constructor and Description
Site(long id, java.lang.String baseURL, java.lang.String title, java.lang.String description, java.lang.String permalinkStructure, Term defaultCategory) Creates a site.
Site(java.util.Properties props) Creates site metadata from properties.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildPermalink(Post post) Builds the permalink for a post from this site.
Site	overrideWith(Site other) Overrides values in this site with those in another, if set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public final long id

The site id.

baseURL

public final java.lang.String baseURL

The base (home) URL for the site.

title

public final java.lang.String title

The site title.

description

public final java.lang.String description

The site description.

permalinkStructure

public final java.lang.String permalinkStructure

The permalink format string.

defaultCategory

public final Term defaultCategory

The default category.

Constructor Detail

Site

public Site(java.util.Properties props)

Creates site metadata from properties.

Parameters:

props - The properties.

Site

public Site(long id,
            java.lang.String baseURL,
            java.lang.String title,
            java.lang.String description,
            java.lang.String permalinkStructure,
            Term defaultCategory)

Creates a site.

Parameters:

id - The site id.

baseURL - The base URL for site links.

title - The site title.

description - The site description.

permalinkStructure - The permalink format string.

defaultCategory - The default category for posts.

Method Detail

overrideWith

public Site overrideWith(Site other)

Overrides values in this site with those in another, if set.

Parameters:

other - The other site meta.

Returns:

The site meta with overrides applied.

buildPermalink

public java.lang.String buildPermalink(Post post)

Builds the permalink for a post from this site.

Parameters:

post - The post.

Returns:

The permalink string.

See Also:

https://codex.wordpress.org/Using_Permalinks